ResourcesOperations クラス

警告

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

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

ResourceManagementClient's

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

継承
builtins.object
ResourcesOperations

コンストラクター

ResourcesOperations(*args, **kwargs)

メソッド

begin_create_or_update

リソースを作成します。

begin_create_or_update_by_id

ID でリソースをCreateします。

begin_delete

リソースを削除します。

begin_delete_by_id

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

begin_move_resources

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

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

begin_update

リソースを更新します。

begin_update_by_id

ID でリソースをUpdatesします。

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

リソースを作成します。

async 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) -> AsyncLROPoller[_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[bytes]

リソースを作成または更新するためのパラメーター。 GenericResource 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

begin_create_or_update_by_id

ID でリソースをCreateします。

async begin_create_or_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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[bytes]

リソース パラメーターを作成または更新します。 GenericResource 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

begin_delete

リソースを削除します。

async 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) -> AsyncLROPoller[None]

パラメーター

名前 説明
resource_group_name
必須
str

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

resource_provider_namespace
必須
str

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

parent_resource_path
必須
str

親リソース ID。 必須。

resource_type
必須
str

リソースの種類。 必須。

resource_name
必須
str

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

api_version
必須
str

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

戻り値

説明

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

例外

説明

begin_delete_by_id

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

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

パラメーター

名前 説明
resource_id
必須
str

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

api_version
必須
str

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

戻り値

説明

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

例外

説明

begin_move_resources

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

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

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

パラメーター

名前 説明
source_resource_group_name
必須
str

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

parameters
必須

リソースを移動するためのパラメーター。 ResourcesMoveInfo 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

begin_update

リソースを更新します。

async 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) -> AsyncLROPoller[_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[bytes]

リソースを更新するためのパラメーター。 GenericResource 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

begin_update_by_id

ID でリソースをUpdatesします。

async begin_update_by_id(resource_id: str, api_version: str, parameters: _models.GenericResource, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_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[bytes]

リソース パラメーターを更新します。 GenericResource 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

begin_validate_move_resources

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

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

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

パラメーター

名前 説明
source_resource_group_name
必須
str

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

parameters
必須

リソースを移動するためのパラメーター。 ResourcesMoveInfo 型または IO[bytes] 型のいずれかです。 必須。

戻り値

説明

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

例外

説明

check_existence

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

async 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 バージョン。 必須。

戻り値

説明

bool または cls(response) の結果

例外

説明

check_existence_by_id

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

async 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 バージョン。 必須。

戻り値

説明

bool または cls(response) の結果

例外

説明

get

リソースを取得します。

async 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 バージョン。 必須。

戻り値

説明

GenericResource または cls(response) の結果

例外

説明

get_by_id

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

async 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 バージョン。 必須。

戻り値

説明

GenericResource または cls(response) の結果

例外

説明

list

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

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

パラメーター

名前 説明
filter
必須
str

操作に適用するフィルター。:code:
<br>フィルター比較演算子には (等しい) と (等しくない) が含eqまれており、、nameresourceTypeplan/nameresourceGroupplan/publisheridentityplan/versionplanidentity/principalIdplan/productおよび .:code のlocation各プロパティで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:nameandresourceGroup<br>
For example, to get all resources with 'demo' anywhere in the resource name, use ``$filter=substringof('demo', name)```<br>``<br>演算子を使用して複数の部分文字列操作を and/or 組み合わせることもできます。:code:
<br>フィルターを使用する場合、クエリ $top の結果の切り捨て数にも互換性がない場合があることに注意してください。:code:
<br>``<br>リソースは、タグの名前と値でフィルター処理できます。 たとえば、タグの名前と値をフィルター処理するには、 を使用 $filter=tagName eq 'tag1' and tagValue eq 'Value1'します。 リソースがタグ名と値でフィルター処理される場合、タグ名/値でフィルター処理するときに、 <b>the original tags for each resource will not be returned in the results.</b> を使用して $expand クエリを実行する追加のプロパティの一覧にも互換性がない場合があることに注意してください。 <br>``<br>タグ名の場合のみ、次の構文を使用してプレフィックスでリソースをフィルター処理できます。 $filter=startswith(tagName, 'depart') このクエリは、タグ名の前に語句 depart (、departmentdepartureDatedepartureTimeなど) が付いたすべてのリソースを返します。コード:
<br>``<br>一部のプロパティは、リソースをフィルター処理するときに結合できることに注意してください。これには、、substringof() and/or resourceTypeplan and plan/publisher and plan/name、および identity and identity/principalIdが含まれます。 既定値は [なし] です。

expand
必須
str

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

top
必須
int

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

戻り値

説明

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

例外

説明

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) -> AsyncIterable[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 が渡された場合は、すべてのリソースを返します。 既定値は [なし] です。

戻り値

説明

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

例外

説明

属性

models

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