QueueURL class

套件:: @azure/storage-queue

QueueURL 代表 Azure 記憶體佇列的 URL。

Extends: StorageURL

建構函式

建立 QueueURL 的實例。

屬性

pipeline	要求原則管線。
url	URL 字串值。

方法

create(Aborter, IQueueCreateOptions)	在指定的帳戶下建立新的佇列。
delete(Aborter)	永久刪除指定的佇列。
fromServiceURL(ServiceURL, string)	從 ServiceURL 建立 QueueURL 物件
getAccessPolicy(Aborter)	取得佇列上指定之任何可搭配共用存取簽章使用之預存存取原則的詳細數據。警告：剖析開始和到期字串時，JavaScript 日期可能會遺失有效位數。例如，新的 Date（“2018-12-31T03：44：23.8827891Z”）將會取得 “2018-12-31T03：44：23.882Z”。
getProperties(Aborter)	取得指定佇列的所有使用者定義元數據和系統屬性。元數據會與佇列建立關聯，做為名稱/值組。
newPipeline(Credential, INewPipelineOptions)	靜態方法，用來建立具有所提供認證的新 Pipeline 物件。
setAccessPolicy(Aborter, ISignedIdentifier[])	設定可用於共用存取簽章之佇列的預存存取原則。
setMetadata(Aborter, IMetadata)	設定指定佇列的一或多個使用者定義名稱/值組。如果未提供任何選項，或選項參數中未定義任何元數據，則會移除佇列元數據。
withPipeline(Pipeline)	建立與來源相同的新 QueueURL 物件，但使用指定的要求原則管線。

建構函式詳細資料

QueueURL(string, Pipeline)

建立 QueueURL 的實例。

new QueueURL(url: string, pipeline: Pipeline)

參數

url: string

指向 Azure 記憶體佇列的 URL 字串，例如 “https://myaccount.queue.core.windows.net/myqueue"。如果使用 AnonymousCredential，則可以附加 SAS，例如 “https://myaccount.queue.core.windows.net/myqueue?sasString"。

pipeline: Pipeline

呼叫 StorageURL.newPipeline（）以建立預設管線，或提供自定義管線。

屬性詳細資料

pipeline

要求原則管線。

pipeline: Pipeline

屬性值

Pipeline

url

URL 字串值。

url: string

屬性值

string

方法詳細資料

create(Aborter, IQueueCreateOptions)

在指定的帳戶下建立新的佇列。

function create(aborter: Aborter, options?: IQueueCreateOptions)

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

options: IQueueCreateOptions

傳回

Promise<Models.QueueCreateResponse>

delete(Aborter)

永久刪除指定的佇列。

function delete(aborter: Aborter)

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

傳回

Promise<Models.QueueDeleteResponse>

fromServiceURL(ServiceURL, string)

從 ServiceURL 建立 QueueURL 物件

static function fromServiceURL(serviceURL: ServiceURL, queueName: string)

參數

serviceURL: ServiceURL

queueName: string

傳回

QueueURL

getAccessPolicy(Aborter)

取得佇列上指定之任何可搭配共用存取簽章使用之預存存取原則的詳細數據。警告：剖析開始和到期字串時，JavaScript 日期可能會遺失有效位數。例如，新的 Date（“2018-12-31T03：44：23.8827891Z”）將會取得 “2018-12-31T03：44：23.882Z”。

function getAccessPolicy(aborter: Aborter)

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

傳回

Promise<QueueGetAccessPolicyResponse>

getProperties(Aborter)

取得指定佇列的所有使用者定義元數據和系統屬性。元數據會與佇列建立關聯，做為名稱/值組。

function getProperties(aborter: Aborter)

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

傳回

Promise<Models.QueueGetPropertiesResponse>

newPipeline(Credential, INewPipelineOptions)

靜態方法，用來建立具有所提供認證的新 Pipeline 物件。

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

參數

credential: Credential

例如 AnonymousCredential、SharedKeyCredential 或 TokenCredential。

pipelineOptions: INewPipelineOptions

傳回

Pipeline

新的 Pipeline 物件。

setAccessPolicy(Aborter, ISignedIdentifier[])

設定可用於共用存取簽章之佇列的預存存取原則。

function setAccessPolicy(aborter: Aborter, queueAcl?: ISignedIdentifier[])

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

queueAcl: ISignedIdentifier[]

傳回

Promise<Models.QueueSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

設定指定佇列的一或多個使用者定義名稱/值組。如果未提供任何選項，或選項參數中未定義任何元數據，則會移除佇列元數據。

function setMetadata(aborter: Aborter, metadata?: IMetadata)

參數

aborter: Aborter

使用 Aborter.none 或 Aborter.timeout（）建立新的 Aborter 實例，以取得更多關於要求取消的範例，請參閱 Aborter 的檔

metadata: IMetadata

傳回

Promise<Models.QueueSetMetadataResponse>

withPipeline(Pipeline)

建立與來源相同的新 QueueURL 物件，但使用指定的要求原則管線。

function withPipeline(pipeline: Pipeline)

參數

pipeline: Pipeline

傳回

QueueURL

意見反應

此頁面對您有幫助嗎？