QueueOperations クラス

警告

このクラスを直接インスタンス化しないでください。

代わりに、次の操作にアクセスする必要があります。

StorageManagementClient's

queue 属性を使用する。

継承

builtins.object

QueueOperations

コンストラクター

QueueOperations(*args, **kwargs)

メソッド

create	指定したアカウントの下に、指定したキュー名を持つ新しいキューを作成します。
delete	指定したキュー名を持つキューが存在する場合は、指定したアカウントの下で削除します。
get	指定したアカウントの下に存在する場合は、指定したキュー名を持つキューを取得します。
list	指定したストレージ アカウントのすべてのキューの一覧を取得します。
update	指定したアカウントの下に、指定したキュー名を持つ新しいキューを作成します。

create

指定したアカウントの下に、指定したキュー名を持つ新しいキューを作成します。

create(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

queue_name

str

必須

キュー名はストレージ アカウント内で一意である必要があり、3 ~ 63 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を使用することはできません。 必須です。

queue

StorageQueue または IO

必須

作成するキューのプロパティとメタデータ。 StorageQueue 型または IO 型のいずれかです。 必須です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

StorageQueue または cls(response) の結果

の戻り値の型 :

StorageQueue

例外

HttpResponseError

delete

指定したキュー名を持つキューが存在する場合は、指定したアカウントの下で削除します。

delete(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> None

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

queue_name

str

必須

キュー名はストレージ アカウント内で一意である必要があり、3 ~ 63 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を使用することはできません。 必須です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

なし、または cls(response) の結果

の戻り値の型 :

None

例外

HttpResponseError

get

指定したアカウントの下に存在する場合は、指定したキュー名を持つキューを取得します。

get(resource_group_name: str, account_name: str, queue_name: str, **kwargs: Any) -> StorageQueue

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

queue_name

str

必須

キュー名はストレージ アカウント内で一意である必要があり、3 ~ 63 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を使用することはできません。 必須です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

StorageQueue または cls(response) の結果

の戻り値の型 :

StorageQueue

例外

HttpResponseError

list

指定したストレージ アカウントのすべてのキューの一覧を取得します。

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, **kwargs: Any) -> Iterable[ListQueue]

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

maxpagesize

str

必須

オプション。リスト キュー応答に含める必要があるキューの最大数。 既定値は [なし] です。

filter

str

必須

省略可能。指定すると、指定されたフィルターで始まる名前のキューのみが一覧表示されます。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

ListQueue のインスタンスや cls(response) の結果のような反復子

の戻り値の型 :

ItemPaged[ListQueue]

例外

HttpResponseError

update

指定したアカウントの下に、指定したキュー名を持つ新しいキューを作成します。

update(resource_group_name: str, account_name: str, queue_name: str, queue: _models.StorageQueue, *, content_type: str = 'application/json', **kwargs: Any) -> _models.StorageQueue

パラメーター

resource_group_name

str

必須

ユーザーのサブスクリプション内のリソース グループの名前。 名前の大文字と小文字は区別されます。 必須です。

account_name

str

必須

指定したリソース グループ内のストレージ アカウントの名前。 ストレージ アカウント名の長さは 3 ～ 24 文字で、数字と小文字のみを使用する必要があります。 必須です。

queue_name

str

必須

キュー名はストレージ アカウント内で一意である必要があり、3 ~ 63 文字である必要があります。名前は小文字の英数字とダッシュ (-) 文字のみで構成する必要があります。先頭と末尾は英数字で、2 つの連続するダッシュ (-) 文字を使用することはできません。 必須です。

queue

StorageQueue または IO

必須

作成するキューのプロパティとメタデータ。 StorageQueue 型または IO 型のいずれかです。 必須です。

content_type

str

Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。

cls

callable

直接応答に渡されるカスタム型または関数

戻り値

StorageQueue または cls(response) の結果

の戻り値の型 :

StorageQueue

例外

HttpResponseError

属性

models

models = <module 'azure.mgmt.storage.v2021_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_04_01\\models\\__init__.py'>