ResourcesOperations クラス

警告

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

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

ResourceManagementClient's

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

継承

builtins.object

ResourcesOperations

コンストラクター

ResourcesOperations(*args, **kwargs)

メソッド

begin_create_or_update	リソースを作成します。
begin_create_or_update_by_id	ID でリソースを作成します。
begin_delete	リソースを削除します。
begin_delete_by_id	ID でリソースを削除します。
begin_move_resources	あるリソース グループから別のリソース グループにリソースを移動します。 移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションに存在する場合があります。 リソースを移動すると、操作の間、ソース グループとターゲット グループの両方がロックされます。 これらのグループに対する書き込み操作および削除操作は、移動が完了するまでブロックされます。
begin_update	リソースを更新します。
begin_update_by_id	ID でリソースを更新します。
begin_validate_move_resources	あるリソース グループから別のリソース グループにリソースを移動できるかどうかを検証します。 この操作では、指定したリソースをターゲットに移動できるかどうかを確認します。 移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションに存在する場合があります。 検証に成功すると、HTTP 応答コード 204 (コンテンツなし) が返されます。 検証に失敗すると、HTTP 応答コード 409 (競合) とエラー メッセージが返されます。 Location ヘッダー値の URL を取得して、実行時間の長い操作の結果をチェックします。
check_existence	リソースが存在するかどうかを確認します。
check_existence_by_id	リソースが存在するかどうかを ID で確認します。 この API は現在、限られたリソース プロバイダーのセットに対してのみ機能します。 リソース プロバイダーがこの API を実装していない場合、ARM は 405 で応答します。 次に、GET API を使用してリソースの存在をチェックすることもできます。
get	リソースを取得します。
get_by_id	ID でリソースを取得します。
list	サブスクリプション内のすべてのリソースを取得します。
list_by_resource_group	リソース グループのすべてのリソースを取得します。

begin_create_or_update

リソースを作成します。

begin_create_or_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

パラメーター

resource_group_name

str

必須

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

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 必須。

parent_resource_path

str

必須

親リソース ID。 必須。

resource_type

str

必須

作成するリソースのリソースの種類。 必須。

resource_name

str

必須

作成するリソースの名前です。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

parameters

GenericResource または IO

必須

リソースを作成または更新するためのパラメーター。 GenericResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[GenericResource]

例外

HttpResponseError

begin_create_or_update_by_id

ID でリソースを作成します。

begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

パラメーター

resource_id

str

必須

リソースの完全修飾 ID。リソース名とリソースの種類が含まれます。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

parameters

GenericResource または IO

必須

リソース パラメーターを作成または更新します。 GenericResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[GenericResource]

例外

HttpResponseError

begin_delete

リソースを削除します。

begin_delete(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> LROPoller[None]

パラメーター

resource_group_name

str

必須

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

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 必須。

parent_resource_path

str

必須

親リソース ID。 必須。

resource_type

str

必須

リソースの種類。 必須。

resource_name

str

必須

削除するリソースの名前。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

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_delete_by_id

ID でリソースを削除します。

begin_delete_by_id(resource_id: str, api_version: str, **kwargs: Any) -> LROPoller[None]

パラメーター

resource_id

str

必須

リソースの完全修飾 ID。リソース名とリソースの種類が含まれます。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

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_move_resources

あるリソース グループから別のリソース グループにリソースを移動します。

移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションに存在する場合があります。 リソースを移動すると、操作の間、ソース グループとターゲット グループの両方がロックされます。 これらのグループに対する書き込み操作および削除操作は、移動が完了するまでブロックされます。

begin_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

パラメーター

source_resource_group_name

str

必須

移動するリソースを含むソース サブスクリプションのリソース グループの名前。 必須。

parameters

ResourcesMoveInfo または IO

必須

リソースを移動するためのパラメーター。 ResourcesMoveInfo 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[None]

例外

HttpResponseError

begin_update

リソースを更新します。

begin_update(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

パラメーター

resource_group_name

str

必須

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

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 必須。

parent_resource_path

str

必須

親リソース ID。 必須。

resource_type

str

必須

更新するリソースのリソースの種類。 必須。

resource_name

str

必須

更新するリソースの名前。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

parameters

GenericResource または IO

必須

リソースを更新するためのパラメーター。 GenericResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[GenericResource]

例外

HttpResponseError

begin_update_by_id

ID でリソースを更新します。

begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.GenericResource]

パラメーター

resource_id

str

必須

リソースの完全修飾 ID。リソース名とリソースの種類が含まれます。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

parameters

GenericResource または IO

必須

リソース パラメーターを更新します。 GenericResource 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[GenericResource]

例外

HttpResponseError

begin_validate_move_resources

あるリソース グループから別のリソース グループにリソースを移動できるかどうかを検証します。

この操作では、指定したリソースをターゲットに移動できるかどうかを確認します。 移動するリソースは、使用されているソース サブスクリプション内の同じソース リソース グループ内にある必要があります。 ターゲット リソース グループが別のサブスクリプションに存在する場合があります。 検証に成功すると、HTTP 応答コード 204 (コンテンツなし) が返されます。 検証に失敗すると、HTTP 応答コード 409 (競合) とエラー メッセージが返されます。 Location ヘッダー値の URL を取得して、実行時間の長い操作の結果をチェックします。

begin_validate_move_resources(source_resource_group_name: str, parameters: _models.ResourcesMoveInfo, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

パラメーター

source_resource_group_name

str

必須

移動の検証対象となるリソースを含むソース サブスクリプションのリソース グループの名前。 必須。

parameters

ResourcesMoveInfo または IO

必須

リソースを移動するためのパラメーター。 ResourcesMoveInfo 型または 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 つのポーリング間の既定の待機時間。

戻り値

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

の戻り値の型 :

LROPoller[None]

例外

HttpResponseError

check_existence

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

check_existence(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> bool

パラメーター

resource_group_name

str

必須

チェックするリソースを含むリソース グループの名前。 名前の大文字と小文字は区別されます。 必須。

resource_provider_namespace

str

必須

チェックするリソースのリソース プロバイダー。 必須。

parent_resource_path

str

必須

親リソース ID。 必須。

resource_type

str

必須

リソースの種類。 必須。

resource_name

str

必須

存在するかどうかをチェックするリソースの名前。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

cls

callable

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

戻り値

bool または cls(response) の結果

の戻り値の型 :

bool

例外

HttpResponseError

check_existence_by_id

リソースが存在するかどうかを ID で確認します。 この API は現在、限られたリソース プロバイダーのセットに対してのみ機能します。 リソース プロバイダーがこの API を実装していない場合、ARM は 405 で応答します。 次に、GET API を使用してリソースの存在をチェックすることもできます。

check_existence_by_id(resource_id: str, api_version: str, **kwargs: Any) -> bool

パラメーター

resource_id

str

必須

リソースの完全修飾 ID。リソース名とリソースの種類が含まれます。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

cls

callable

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

戻り値

bool または cls(response) の結果

の戻り値の型 :

bool

例外

HttpResponseError

get

リソースを取得します。

get(resource_group_name: str, resource_provider_namespace: str, parent_resource_path: str, resource_type: str, resource_name: str, api_version: str, **kwargs: Any) -> GenericResource

パラメーター

resource_group_name

str

必須

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

resource_provider_namespace

str

必須

リソース プロバイダーの名前空間。 必須。

parent_resource_path

str

必須

親リソース ID。 必須。

resource_type

str

必須

リソースのリソースの種類。 必須。

resource_name

str

必須

取得するリソースの名前。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

cls

callable

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

戻り値

GenericResource または cls(response) の結果

の戻り値の型 :

GenericResource

例外

HttpResponseError

get_by_id

ID でリソースを取得します。

get_by_id(resource_id: str, api_version: str, **kwargs: Any) -> GenericResource

パラメーター

resource_id

str

必須

リソースの完全修飾 ID。リソース名とリソースの種類が含まれます。 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} の形式を使用します。 必須。

api_version

str

必須

操作に使用する API バージョン。 必須。

cls

callable

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

戻り値

GenericResource または cls(response) の結果

の戻り値の型 :

GenericResource

例外

HttpResponseError

list

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

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

パラメーター

filter

str

必須

操作に適用するフィルター。:code:
<br>フィルター比較演算子には (等しい) と (等しくない) が含eqまれており、、name、 planidentityresourceGroupplan/nameplan/versionplan/publisheridentity/principalIdplan/productおよび .:code のresourceTypelocation各プロパティでplan/promotionCode使用できます。ne
<br>たとえば、リソースの種類でフィルター処理するには、 $filter=resourceType eq 'Microsoft.Network/virtualNetworks'```<br>
<br>` `substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup
<br>`For example, to get all resources with 'demo' anywhere in the resource name, use $filter=substringof('demo', name)''
<br>`Multiple substring operations can also be combined using and/`or` operators.:code:*<br>*`<br>`Note that any truncated number of results queried via $top may also not be compatible when using a filter.:code:*<br>*`<br>
Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use ``$filter=tagName eq 'tag1' and tagValue eq 'Value1'``. Note that when resources are filtered by tag name and value, 各リソースの元のタグは結果に返されません。Any list of additional properties queried via$expandmay also not be compatible when filtering by tag names/values.
<br>`For tag names only, resources can be filtered by prefix using the following syntax: $filter=startswith(tagName, 'depart'). This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.):code:*<br>*`<br>
Note that some properties can be combined when filtering resources, which include the following: ``substringof() and/or resourceType``, plan と plan/publisher、plan/name, and IDENTITy and identity/principalId' 既定値は [なし] です。

expand

str

必須

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

top

int

必須

この API のページ バージョンが使用されている場合の、ページあたりの推奨事項の数。 既定値は [なし] です。

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[GenericResourceExpanded]

例外

HttpResponseError

list_by_resource_group

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

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

パラメーター

resource_group_name

str

必須

取得するリソースを含むリソース グループ。 必須。

filter

str

必須

操作に適用するフィルター。:code:
<br>eq (equals) または ne (not equals) に使用できるプロパティは、location、 resourceType、name、resourceGroup、identity/principalId、plan、plan/publisher、plan/product、plan/name、plan/version、plan/promotionCode.:code:<br>``<br>たとえば、リソースの種類でフィルター処理するには、$filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:code:<br>``<br>substringof(value, property) をフィルターで使用できます。 部分文字列に使用できるプロパティは、name と resourceGroup.:code:<br>``<br>たとえば、名前内の任意の場所で 'demo' を持つすべてのリソースを取得するには、次を使用します。$filter=substringof('demo', name):code:<br>``<br>複数の部分文字列をリンクするには、 および/または 演算子を追加します。:code:<br>``<br>タグの名前と値でフィルター処理できます。 たとえば、タグ名と値をフィルター処理するには、$filter=tagName eq 'tag1' と tagValue eq 'Value1' を使用します。 タグ名と値でフィルター処理すると、各リソースのタグは結果に返されません。:code:<br>:code:Code:>><<<br>フィルター処理時に一部のプロパティを一緒に使用できます。 使用できる組み合わせは、substringof や resourceType、plan と plan/publisher、plan/name、identity と identity/principalId です。 既定値は [なし] です。

expand

str

必須

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

top

int

必須

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

cls

callable

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

戻り値

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

の戻り値の型 :

ItemPaged[GenericResourceExpanded]

例外

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