ResourceGroupsOperations クラス
警告
このクラスを直接インスタンス化しないでください。
代わりに、次の操作にアクセスする必要があります。
<xref:resource_groups> 属性を使用する。
- 継承
-
builtins.objectResourceGroupsOperations
コンストラクター
ResourceGroupsOperations(*args, **kwargs)
メソッド
begin_delete |
リソース グループを削除します。 リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、すべてのテンプレート デプロイと現在格納されている操作が削除されます。 |
check_existence |
リソース グループが存在するかどうかを確認します。 |
create_or_update |
リソース グループを作成または更新します。 |
export_template |
指定したリソース グループをテンプレートとしてキャプチャします。 |
get |
リソース グループを取得します。 |
list |
サブスクリプションのすべてのリソース グループを取得します。 |
update |
リソース グループを更新します。 リソース グループは、グループのアドレスに対する単純な PATCH 操作で更新できます。 要求の形式は、リソース グループを作成する場合と同じです。 フィールドが指定されていない場合、現在の値は保持されます。 |
begin_delete
リソース グループを削除します。
リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、すべてのテンプレート デプロイと現在格納されている操作が削除されます。
begin_delete(resource_group_name: str, **kwargs: Any) -> LROPoller[None]
パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
- continuation_token
- str
保存された状態からポーリングを再開するための継続トークン。
- polling
- bool または PollingMethod
既定では、ポーリング メソッドは ARMPolling になります。 この操作に対して False を渡してポーリングを行わないか、個人のポーリング戦略のために独自に初期化されたポーリング オブジェクトを渡します。
- polling_interval
- int
Retry-After ヘッダーがない場合、LRO 操作の 2 つのポーリング間の既定の待機時間。
戻り値
None または cls(response) の結果を返す LROPoller のインスタンス
の戻り値の型 :
例外
check_existence
リソース グループが存在するかどうかを確認します。
check_existence(resource_group_name: str, **kwargs: Any) -> bool
パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
bool または cls(response) の結果
の戻り値の型 :
例外
create_or_update
リソース グループを作成または更新します。
create_or_update(resource_group_name: str, parameters: _models.ResourceGroup, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
パラメーター
- resource_group_name
- str
作成または更新するリソース グループの名前。 英数字、アンダースコア、かっこ、ハイフン、ピリオド (末尾を除く)、および使用できる文字に一致する Unicode 文字を含めることができます。 必須。
- parameters
- ResourceGroup または IO
リソース グループの作成または更新に指定されたパラメーター。 ResourceGroup 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ResourceGroup または cls(response) の結果
の戻り値の型 :
例外
export_template
指定したリソース グループをテンプレートとしてキャプチャします。
export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroupExportResult
パラメーター
- parameters
- ExportTemplateRequest または IO
テンプレートをエクスポートするためのパラメーター。 ExportTemplateRequest 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ResourceGroupExportResult または cls(response) の結果
の戻り値の型 :
例外
get
リソース グループを取得します。
get(resource_group_name: str, **kwargs: Any) -> ResourceGroup
パラメーター
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ResourceGroup または cls(response) の結果
の戻り値の型 :
例外
list
サブスクリプションのすべてのリソース グループを取得します。
list(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[ResourceGroup]
パラメーター
- filter
- str
操作に適用するフィルター。:code:
:code:>><<<br>
タグの名前と値でフィルター処理できます。 たとえば、タグ名と値をフィルター処理するには、$filter=tagName eq 'tag1' と tagValue eq 'Value1' を使用します。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ResourceGroup のインスタンスや cls(response) の結果のような反復子
の戻り値の型 :
例外
update
リソース グループを更新します。
リソース グループは、グループのアドレスに対する単純な PATCH 操作で更新できます。 要求の形式は、リソース グループを作成する場合と同じです。 フィールドが指定されていない場合、現在の値は保持されます。
update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup
パラメーター
- parameters
- ResourceGroupPatchable または IO
リソース グループを更新するために指定されたパラメーター。 ResourceGroupPatchable 型または IO 型のいずれかです。 必須。
- content_type
- str
Body Parameter content-type。 既知の値は、'application/json' です。 既定値は [なし] です。
- cls
- callable
直接応答が渡されるカスタム型または関数
戻り値
ResourceGroup または cls(response) の結果
の戻り値の型 :
例外
属性
models
models = <module 'azure.mgmt.resource.resources.v2019_07_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2019_07_01\\models\\__init__.py'>
Azure SDK for Python