次の方法で共有

ResourceGroupsOperations クラス

  • リファレンス

警告

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

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

ResourceManagementClient's

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

継承
builtins.object
ResourceGroupsOperations

コンストラクター

ResourceGroupsOperations(*args, **kwargs)

メソッド

begin_delete

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

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

リソース グループを作成する。
export_template

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

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

リソース グループのコレクションを取得します。
list_resources

サブスクリプションのすべてのリソースの一覧を取得します。
patch

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

begin_delete

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

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

パラメーター

resource_group_name
str
必須

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

cls
callable

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

continuation_token
str

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

polling
bool または PollingMethod

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

polling_interval
int

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

戻り値

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

の戻り値の型 :

LROPoller[None]

例外

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
必須

作成または更新するリソース グループの名前です。 必須。

parameters
ResourceGroup または IO
必須

リソース グループの作成または更新を行うサービス操作に対して指定するパラメーターです。 ResourceGroup 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

ResourceGroup または cls(response) の結果

の戻り値の型 :

ResourceGroup

例外

HttpResponseError

export_template

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

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

パラメーター

resource_group_name
str
必須

作成または更新するリソース グループの名前です。 必須。

parameters
ExportTemplateRequest または IO
必須

エクスポート テンプレート リソース グループ操作に指定されたパラメーター。 ExportTemplateRequest 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

ResourceGroupExportResult または cls(response) の結果

の戻り値の型 :

ResourceGroupExportResult

例外

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
必須

操作に適用するフィルター。 既定値は [なし] です。

top
int
必須

クエリ パラメーターです。 null を渡した場合、すべてのリソース グループが返されます。 既定値は [なし] です。

cls
callable

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

戻り値

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

の戻り値の型 :

ItemPaged[ResourceGroup]

例外

HttpResponseError

list_resources

サブスクリプションのすべてのリソースの一覧を取得します。

list_resources(resource_group_name: str, filter: str | None = None, expand: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[GenericResourceExpanded]

パラメーター

resource_group_name
str
必須

クエリ パラメーターです。 null を渡した場合、すべてのリソース グループが返されます。 必須。

filter
str
必須

操作に適用するフィルター。 既定値は [なし] です。

expand
str
必須

応答に含める追加のプロパティのコンマ区切りの一覧。 有効な値には、 と changedTime がprovisioningState含まれますcreatedTime。 たとえば、$expand=createdTime,changedTime のように指定します。 既定値は [なし] です。

top
int
必須

クエリ パラメーターです。 null を渡した場合、すべてのリソース グループが返されます。 既定値は [なし] です。

cls
callable

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

戻り値

GenericResourceExpanded または cls(response) の結果のインスタンスのような反復子

の戻り値の型 :

ItemPaged[GenericResourceExpanded]

例外

HttpResponseError

patch

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

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

パラメーター

resource_group_name
str
必須

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

parameters
ResourceGroup または IO
必須

リソース グループの状態を更新するサービス操作に対して指定するパラメーターです。 ResourceGroup 型または IO 型のいずれかです。 必須。

content_type
str

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

cls
callable

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

戻り値

ResourceGroup または cls(response) の結果

の戻り値の型 :

ResourceGroup

例外

HttpResponseError

属性

models 

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