Queue interface
表示佇列的介面。
方法
create(string, string, string, Storage |
在指定的帳號下,建立具有指定佇列名稱的新佇列。 |
delete(string, string, string, Queue |
如果佇列存在,則會刪除具有指定佇列名稱的佇列。 |
get(string, string, string, Queue |
取得具有指定佇列名稱的佇列,如果指定帳戶存在,則為 。 |
list(string, string, Queue |
取得指定儲存體帳戶下所有佇列的清單 |
update(string, string, string, Storage |
在指定的帳號下,建立具有指定佇列名稱的新佇列。 |
方法詳細資料
create(string, string, string, StorageQueue, QueueCreateOptionalParams)
在指定的帳號下,建立具有指定佇列名稱的新佇列。
function create(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueCreateOptionalParams): Promise<StorageQueue>
參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度,而且只能使用數字和小寫字母。
- queueName
-
string
佇列名稱在儲存體帳戶內必須是唯一的,且必須介於 3 到 63 個字元之間。名稱必須包含小寫英數位元和虛線 () 字元,它應該以英數位元開頭和結尾,而且不能有兩個連續的虛線 () 字元。
- queue
- StorageQueue
要建立的佇列屬性和中繼資料
- options
- QueueCreateOptionalParams
選項參數。
傳回
Promise<StorageQueue>
delete(string, string, string, QueueDeleteOptionalParams)
如果佇列存在,則會刪除具有指定佇列名稱的佇列。
function delete(resourceGroupName: string, accountName: string, queueName: string, options?: QueueDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度,而且只能使用數字和小寫字母。
- queueName
-
string
佇列名稱在儲存體帳戶內必須是唯一的,且必須介於 3 到 63 個字元之間。名稱必須包含小寫英數位元和虛線 () 字元,它應該以英數位元開頭和結尾,而且不能有兩個連續的虛線 () 字元。
- options
- QueueDeleteOptionalParams
選項參數。
傳回
Promise<void>
get(string, string, string, QueueGetOptionalParams)
取得具有指定佇列名稱的佇列,如果指定帳戶存在,則為 。
function get(resourceGroupName: string, accountName: string, queueName: string, options?: QueueGetOptionalParams): Promise<StorageQueue>
參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度,而且只能使用數字和小寫字母。
- queueName
-
string
佇列名稱在儲存體帳戶內必須是唯一的,且必須介於 3 到 63 個字元之間。名稱必須包含小寫英數位元和虛線 () 字元,它應該以英數位元開頭和結尾,而且不能有兩個連續的虛線 () 字元。
- options
- QueueGetOptionalParams
選項參數。
傳回
Promise<StorageQueue>
list(string, string, QueueListOptionalParams)
取得指定儲存體帳戶下所有佇列的清單
function list(resourceGroupName: string, accountName: string, options?: QueueListOptionalParams): PagedAsyncIterableIterator<ListQueue, ListQueue[], PageSettings>
參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度,而且只能使用數字和小寫字母。
- options
- QueueListOptionalParams
選項參數。
傳回
update(string, string, string, StorageQueue, QueueUpdateOptionalParams)
在指定的帳號下,建立具有指定佇列名稱的新佇列。
function update(resourceGroupName: string, accountName: string, queueName: string, queue: StorageQueue, options?: QueueUpdateOptionalParams): Promise<StorageQueue>
參數
- resourceGroupName
-
string
使用者訂用帳戶內的資源組名。 名稱不區分大小寫。
- accountName
-
string
指定資源群組內的儲存體帳戶名稱。 儲存體帳戶名稱必須介於 3 到 24 個字元的長度,而且只能使用數字和小寫字母。
- queueName
-
string
佇列名稱在儲存體帳戶內必須是唯一的,且必須介於 3 到 63 個字元之間。名稱必須包含小寫英數位元和虛線 () 字元,它應該以英數位元開頭和結尾,而且不能有兩個連續的虛線 () 字元。
- queue
- StorageQueue
要建立的佇列屬性和中繼資料
- options
- QueueUpdateOptionalParams
選項參數。
傳回
Promise<StorageQueue>