Share via


TagsOperations クラス

警告

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

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

ResourceManagementClient's

<xref:tags> 属性を使用する。

継承
builtins.object
TagsOperations

コンストラクター

TagsOperations(*args, **kwargs)

メソッド

begin_create_or_update_at_scope

リソースまたはサブスクリプションのタグのセット全体を作成または更新します。

この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。

begin_delete_at_scope

リソースまたはサブスクリプションのタグのセット全体を削除します。

リソースまたはサブスクリプションのタグのセット全体を削除します。

begin_update_at_scope

リソースまたはサブスクリプションのタグのセットを選択的に更新します。

この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、既存の名前でタグの値を更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。

create_or_update

定義済みのタグ名を作成します。

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧に名前を追加できます。 タグ名は最大 512 文字で、大文字と小文字は区別されません。 タグ名には、Azure で使用するために予約されているプレフィックス 'microsoft'、'azure'、'windows' を含めることはできません。

create_or_update_value

定義済みのタグ名の定義済みの値を作成します。

この操作により、既存の定義済みタグ名の定義済み値の一覧に値を追加できます。 タグ値の最大文字数は 256 文字です。

delete

定義済みのタグ名を削除します。

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧から名前を削除できます。 削除される名前は、リソースのタグ名として使用することはできません。 指定された名前のすべての定義済み値は既に削除されている必要があります。

delete_value

定義済みのタグ名の定義済みタグ値を削除します。

この操作により、既存の定義済みタグ名の定義済み値の一覧から値を削除できます。 削除される値は、任意のリソースの指定されたタグ名のタグ値として使用することはできません。

get_at_scope

リソースまたはサブスクリプションのタグのセット全体を取得します。

リソースまたはサブスクリプションのタグのセット全体を取得します。

list

サブスクリプションでのタグの使用状況の概要を取得します。

この操作は、定義済みのタグ、リソース タグ、リソース グループ タグ、サブスクリプション タグの和集合を実行し、指定されたサブスクリプションの各タグ名と値の使用状況の概要を返します。 タグの数が多い場合、この操作は以前にキャッシュされた結果を返す可能性があります。

begin_create_or_update_at_scope

リソースまたはサブスクリプションのタグのセット全体を作成または更新します。

この操作により、指定したリソースまたはサブスクリプションのタグのセット全体を追加または置換できます。 指定したエンティティは、最大 50 個のタグを持つことができます。

begin_create_or_update_at_scope(scope: str, parameters: _models.TagsResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TagsResource]

パラメーター

scope
str
必須

リソース スコープ。 必須。

parameters
TagsResource または IO
必須

TagsResource 型または IO 型です。 必須。

content_type
str

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

cls
callable

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

continuation_token
str

保存された状態からポーリングを再開するための継続トークン。

polling
bool または PollingMethod

既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval
int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

TagsResource または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

begin_delete_at_scope

リソースまたはサブスクリプションのタグのセット全体を削除します。

リソースまたはサブスクリプションのタグのセット全体を削除します。

begin_delete_at_scope(scope: str, **kwargs: Any) -> LROPoller[None]

パラメーター

scope
str
必須

リソース スコープ。 必須。

cls
callable

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

continuation_token
str

保存された状態からポーリングを再開するための継続トークン。

polling
bool または PollingMethod

既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval
int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

None または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

begin_update_at_scope

リソースまたはサブスクリプションのタグのセットを選択的に更新します。

この操作により、指定したリソースまたはサブスクリプションのタグを置換、マージ、または選択的に削除できます。 指定したエンティティは、操作の最後に最大 50 個のタグを持つことができます。 'replace' オプションは、既存のタグのセット全体を新しいセットに置き換えます。 'merge' オプションを使用すると、新しい名前を持つタグを追加したり、既存の名前でタグの値を更新したりできます。 'delete' オプションを使用すると、指定された名前または名前と値のペアに基づいてタグを選択的に削除できます。

begin_update_at_scope(scope: str, parameters: _models.TagsPatchResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.TagsResource]

パラメーター

scope
str
必須

リソース スコープ。 必須。

parameters
TagsPatchResource または IO
必須

TagsPatchResource 型または IO 型です。 必須。

content_type
str

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

cls
callable

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

continuation_token
str

保存された状態からポーリングを再開するための継続トークン。

polling
bool または PollingMethod

既定では、ポーリング メソッドは ARMPolling になります。 この操作でポーリングしない場合は False を渡すか、個人のポーリング戦略に対して独自に初期化されたポーリング オブジェクトを渡します。

polling_interval
int

Retry-After ヘッダーが存在しない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。

戻り値

TagsResource または cls(response) の結果を返す LROPoller のインスタンス

の戻り値の型 :

例外

create_or_update

定義済みのタグ名を作成します。

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧に名前を追加できます。 タグ名は最大 512 文字で、大文字と小文字は区別されません。 タグ名には、Azure で使用するために予約されているプレフィックス 'microsoft'、'azure'、'windows' を含めることはできません。

create_or_update(tag_name: str, **kwargs: Any) -> TagDetails

パラメーター

tag_name
str
必須

作成するタグの名前。 必須。

cls
callable

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

戻り値

TagDetails または cls(response) の結果

の戻り値の型 :

例外

create_or_update_value

定義済みのタグ名の定義済みの値を作成します。

この操作により、既存の定義済みタグ名の定義済み値の一覧に値を追加できます。 タグ値の最大文字数は 256 文字です。

create_or_update_value(tag_name: str, tag_value: str, **kwargs: Any) -> TagValue

パラメーター

tag_name
str
必須

タグの名前。 必須。

tag_value
str
必須

作成するタグの値。 必須。

cls
callable

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

戻り値

TagValue または cls(response) の結果

の戻り値の型 :

例外

delete

定義済みのタグ名を削除します。

この操作により、指定されたサブスクリプションの定義済みのタグ名の一覧から名前を削除できます。 削除される名前は、リソースのタグ名として使用することはできません。 指定された名前のすべての定義済み値は既に削除されている必要があります。

delete(tag_name: str, **kwargs: Any) -> None

パラメーター

tag_name
str
必須

タグの名前。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

delete_value

定義済みのタグ名の定義済みタグ値を削除します。

この操作により、既存の定義済みタグ名の定義済み値の一覧から値を削除できます。 削除される値は、任意のリソースの指定されたタグ名のタグ値として使用することはできません。

delete_value(tag_name: str, tag_value: str, **kwargs: Any) -> None

パラメーター

tag_name
str
必須

タグの名前。 必須。

tag_value
str
必須

削除するタグの値。 必須。

cls
callable

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

戻り値

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

の戻り値の型 :

例外

get_at_scope

リソースまたはサブスクリプションのタグのセット全体を取得します。

リソースまたはサブスクリプションのタグのセット全体を取得します。

get_at_scope(scope: str, **kwargs: Any) -> TagsResource

パラメーター

scope
str
必須

リソース スコープ。 必須。

cls
callable

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

戻り値

TagsResource または cls(response) の結果

の戻り値の型 :

例外

list

サブスクリプションでのタグの使用状況の概要を取得します。

この操作は、定義済みのタグ、リソース タグ、リソース グループ タグ、サブスクリプション タグの和集合を実行し、指定されたサブスクリプションの各タグ名と値の使用状況の概要を返します。 タグの数が多い場合、この操作は以前にキャッシュされた結果を返す可能性があります。

list(**kwargs: Any) -> Iterable[TagDetails]

パラメーター

cls
callable

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

戻り値

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

の戻り値の型 :

例外

属性

models

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