ResourceGroupsOperations クラス

警告

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

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

ResourceManagementClient's

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

継承

builtins.object

ResourceGroupsOperations

コンストラクター

ResourceGroupsOperations(*args, **kwargs)

メソッド

begin_delete	リソース グループを削除します。 リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、すべてのテンプレート デプロイと現在格納されている操作が削除されます。
begin_export_template	指定したリソース グループをテンプレートとしてキャプチャします。
check_existence	リソース グループが存在するかどうかを確認します。
create_or_update	リソース グループを作成または更新します。
get	リソース グループを取得します。
list	サブスクリプションのすべてのリソース グループを取得します。
update	リソース グループを更新します。 リソース グループは、グループのアドレスに対する単純な PATCH 操作で更新できます。 要求の形式は、リソース グループを作成する場合と同じです。 フィールドが指定されていない場合、現在の値は保持されます。

begin_delete

リソース グループを削除します。

リソース グループを削除すると、そのすべてのリソースも削除されます。 リソース グループを削除すると、すべてのテンプレート デプロイと現在格納されている操作が削除されます。

begin_delete(resource_group_name: str, force_deletion_types: str | None = None, **kwargs: Any) -> LROPoller[None]

パラメーター

resource_group_name

str

必須

削除するリソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

force_deletion_types

str

必須

強制的に削除するリソースの種類。 現在サポートされているのは、forceDeletionTypes=Microsoft.Compute/virtualMachines、Microsoft.Compute/virtualMachineScaleSets のみです。 既定値は [なし] です。

cls

callable

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

continuation_token

str

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

polling

bool または PollingMethod

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

polling_interval

int

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

戻り値

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

の戻り値の型 :

LROPoller[None]

例外

HttpResponseError

begin_export_template

指定したリソース グループをテンプレートとしてキャプチャします。

begin_export_template(resource_group_name: str, parameters: _models.ExportTemplateRequest, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ResourceGroupExportResult]

パラメーター

resource_group_name

str

必須

リソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

parameters

ExportTemplateRequest または IO

必須

テンプレートをエクスポートするためのパラメーター。 ExportTemplateRequest 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[ResourceGroupExportResult]

例外

HttpResponseError

check_existence

リソース グループが存在するかどうかを確認します。

check_existence(resource_group_name: str, **kwargs: Any) -> bool

パラメーター

resource_group_name

str

必須

確認するリソース グループの名前です。 名前の大文字と小文字は区別されます。 必須。

cls

callable

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

戻り値

bool または cls(response) の結果

の戻り値の型 :

bool

例外

HttpResponseError

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) の結果

の戻り値の型 :

ResourceGroup

例外

HttpResponseError

get

リソース グループを取得します。

get(resource_group_name: str, **kwargs: Any) -> ResourceGroup

パラメーター

resource_group_name

str

必須

取得するリソース グループの名前です。 名前の大文字と小文字は区別されます。 必須。

cls

callable

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

戻り値

ResourceGroup または cls(response) の結果

の戻り値の型 :

ResourceGroup

例外

HttpResponseError

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' を使用します。 既定値は [なし] です。

top

int

必須

返される結果の数。 null が渡された場合は、すべてのリソース グループを返します。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[ResourceGroup]

例外

HttpResponseError

update

リソース グループを更新します。

リソース グループは、グループのアドレスに対する単純な PATCH 操作で更新できます。 要求の形式は、リソース グループを作成する場合と同じです。 フィールドが指定されていない場合、現在の値は保持されます。

update(resource_group_name: str, parameters: _models.ResourceGroupPatchable, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ResourceGroup

パラメーター

resource_group_name

str

必須

更新するリソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

parameters

ResourceGroupPatchable または IO

必須

リソース グループを更新するために指定されたパラメーター。 ResourceGroupPatchable 型または IO 型です。 必須。

content_type

str

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

cls

callable

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

戻り値

ResourceGroup または cls(response) の結果

の戻り値の型 :

ResourceGroup

例外

HttpResponseError

属性

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'>