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 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を含めることはできません。
- queue
- StorageQueue
作成するキューのプロパティとメタデータ
- options
- QueueCreateOptionalParams
options パラメーター。
戻り値
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 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を含めることはできません。
- options
- QueueDeleteOptionalParams
options パラメーター。
戻り値
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 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を含めることはできません。
- options
- QueueGetOptionalParams
options パラメーター。
戻り値
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
options パラメーター。
戻り値
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 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を含めることはできません。
- queue
- StorageQueue
作成するキューのプロパティとメタデータ
- options
- QueueUpdateOptionalParams
options パラメーター。
戻り値
Promise<StorageQueue>