共用方式為


ResourcesOperations 類別

警告

請勿直接具現化此類別。

相反地,您應該透過 存取下列作業

ResourceManagementClient's

<xref:resources> 屬性。

繼承
builtins.object
ResourcesOperations

建構函式

ResourcesOperations(*args, **kwargs)

方法

begin_create_or_update

建立資源。

begin_create_or_update_by_id

依標識碼 Create 資源。

begin_delete

刪除資源。

begin_delete_by_id

依標識碼刪除資源。

begin_move_resources

將資源從某個資源群組移至另一個資源群組。

要移動的資源必須位於所使用來源訂用帳戶中的相同來源資源群組中。 目標資源群組可能位於不同的訂用帳戶中。 移動資源時,來源群組和目標組都會在作業期間鎖定。 群組上的寫入和刪除作業將會封鎖,直到移動完成。

begin_update

更新資源。

begin_update_by_id

依標識碼 匯報 資源。

begin_validate_move_resources

驗證是否可以將資源從某個資源群組移至另一個資源群組。

這項作業會檢查指定的資源是否可以移至目標。 要移動的資源必須位於所使用來源訂用帳戶中的相同來源資源群組中。 目標資源群組可能位於不同的訂用帳戶中。 如果驗證成功,它會傳回 HTTP 回應碼 204 (沒有內容) 。 如果驗證失敗,它會傳回 HTTP 回應碼 409 (衝突) 錯誤訊息。 擷取 [位置] 標頭值中的 URL,以檢查長時間執行作業的結果。

check_existence

檢查資源是否存在。

check_existence_by_id

依標識碼檢查資源是否存在。 此 API 目前僅適用於一組有限的資源提供者。 如果資源提供者未實作此 API,ARM 會以 405 回應。 接著,替代方法是使用 GET API 來檢查資源是否存在。

get

取得資源。

get_by_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]

參數

名稱 Description
resource_group_name
必要
str

資源的資源群組名稱。 名稱不區分大小寫。 必要。

resource_provider_namespace
必要
str

資源提供者的命名空間。 必要。

parent_resource_path
必要
str

父資源識別。 必要。

resource_type
必要
str

要建立之資源的資源類型。 必要。

resource_name
必要
str

是要建立的資源的名稱。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

parameters
必要

用於建立或更新資源的參數。 這是 GenericResource 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 GenericResource 或 cls (回應的結果)

例外狀況

類型 Description

begin_create_or_update_by_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]

參數

名稱 Description
resource_id
必要
str

資源的完整標識碼,包括資源名稱和資源類型。 使用格式 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

parameters
必要

建立或更新資源參數。 這是 GenericResource 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 GenericResource 或 cls (回應的結果)

例外狀況

類型 Description

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]

參數

名稱 Description
resource_group_name
必要
str

包含要刪除之資源的資源組名。 名稱不區分大小寫。 必要。

resource_provider_namespace
必要
str

資源提供者的命名空間。 必要。

parent_resource_path
必要
str

父資源識別。 必要。

resource_type
必要
str

資源類型。 必要。

resource_name
必要
str

要刪除的資源名稱。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)

例外狀況

類型 Description

begin_delete_by_id

依標識碼刪除資源。

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

參數

名稱 Description
resource_id
必要
str

資源的完整標識碼,包括資源名稱和資源類型。 使用格式 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)

例外狀況

類型 Description

begin_move_resources

將資源從某個資源群組移至另一個資源群組。

要移動的資源必須位於所使用來源訂用帳戶中的相同來源資源群組中。 目標資源群組可能位於不同的訂用帳戶中。 移動資源時,來源群組和目標組都會在作業期間鎖定。 群組上的寫入和刪除作業將會封鎖,直到移動完成。

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

參數

名稱 Description
source_resource_group_name
必要
str

來源訂用帳戶中的資源組名,其中包含要移動的資源。 必要。

parameters
必要

移動資源的參數。 這是 ResourcesMoveInfo 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)

例外狀況

類型 Description

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]

參數

名稱 Description
resource_group_name
必要
str

資源的資源群組名稱。 名稱不區分大小寫。 必要。

resource_provider_namespace
必要
str

資源提供者的命名空間。 必要。

parent_resource_path
必要
str

父資源識別。 必要。

resource_type
必要
str

要更新之資源的資源類型。 必要。

resource_name
必要
str

要更新的資源名稱。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

parameters
必要

更新資源的參數。 這是 GenericResource 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 GenericResource 或 cls (回應的結果)

例外狀況

類型 Description

begin_update_by_id

依標識碼 匯報 資源。

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

參數

名稱 Description
resource_id
必要
str

資源的完整標識碼,包括資源名稱和資源類型。 使用格式 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

parameters
必要

更新資源參數。 這是 GenericResource 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 GenericResource 或 cls (回應的結果)

例外狀況

類型 Description

begin_validate_move_resources

驗證是否可以將資源從某個資源群組移至另一個資源群組。

這項作業會檢查指定的資源是否可以移至目標。 要移動的資源必須位於所使用來源訂用帳戶中的相同來源資源群組中。 目標資源群組可能位於不同的訂用帳戶中。 如果驗證成功,它會傳回 HTTP 回應碼 204 (沒有內容) 。 如果驗證失敗,它會傳回 HTTP 回應碼 409 (衝突) 錯誤訊息。 擷取 [位置] 標頭值中的 URL,以檢查長時間執行作業的結果。

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

參數

名稱 Description
source_resource_group_name
必要
str

來源訂用帳戶中的資源組名,其中包含要驗證要移動的資源。 必要。

parameters
必要

移動資源的參數。 這是 ResourcesMoveInfo 類型或 IO[bytes] 類型。 必要。

傳回

類型 Description

AsyncLROPoller 的實例,會傳回 None 或 cls (回應的結果)

例外狀況

類型 Description

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

參數

名稱 Description
resource_group_name
必要
str

包含要檢查之資源的資源組名。 名稱不區分大小寫。 必要。

resource_provider_namespace
必要
str

要檢查之資源的資源提供者。 必要。

parent_resource_path
必要
str

父資源識別。 必要。

resource_type
必要
str

資源類型。 必要。

resource_name
必要
str

要檢查資源是否存在的資源名稱。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

bool 或 cls (回應的結果)

例外狀況

類型 Description

check_existence_by_id

依標識碼檢查資源是否存在。 此 API 目前僅適用於一組有限的資源提供者。 如果資源提供者未實作此 API,ARM 會以 405 回應。 接著,替代方法是使用 GET API 來檢查資源是否存在。

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

參數

名稱 Description
resource_id
必要
str

資源的完整標識碼,包括資源名稱和資源類型。 使用格式 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

bool 或 cls (回應的結果)

例外狀況

類型 Description

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

參數

名稱 Description
resource_group_name
必要
str

包含要取得之資源的資源組名。 名稱不區分大小寫。 必要。

resource_provider_namespace
必要
str

資源提供者的命名空間。 必要。

parent_resource_path
必要
str

父資源識別。 必要。

resource_type
必要
str

資源的資源類型。 必要。

resource_name
必要
str

要取得的資源名稱。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

GenericResource 或 cls 的結果 (回應)

例外狀況

類型 Description

get_by_id

依標識碼取得資源。

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

參數

名稱 Description
resource_id
必要
str

資源的完整標識碼,包括資源名稱和資源類型。 使用格式 /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}。 必要。

api_version
必要
str

要用於作業的 API 版本。 必要。

傳回

類型 Description

GenericResource 或 cls 的結果 (回應)

例外狀況

類型 Description

list

取得訂用帳戶中的所有資源。

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

參數

名稱 Description
filter
必要
str

要套用至 operation.:code 的篩選條件:
<br>篩選比較運算子包括 eq (等於) 和 ne (不等於) ,而且可以搭配下列屬性使用:locationresourceTypenameresourceGroup、、、identityidentity/principalIdplanplan/nameplan/publisherplan/productplan/versionplan/promotionCode.:code:
<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 operators.:code 合併多個子字串作業:
<br>請注意,使用 filter.:code 時,透過 查詢 $top 的任何截斷結果數目可能也不相容:
<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等 ) :code:
<br>``<br>請注意,篩選資源時可以合併某些屬性,包括下列各項: substringof() and/or resourceTypeplan and plan/publisher and plan/nameidentity and identity/principalId。 預設值為 [無]。

expand
必要
str

要包含在回應中的其他屬性逗號分隔清單。 有效值包括 createdTimechangedTimeprovisioningState。 例如: $expand=createdTime,changedTime 。 預設值為 [無]。

top
必要
int

如果使用此 API 的分頁版本,則每個頁面的建議數目。 預設值為 [無]。

傳回

類型 Description

一個反覆運算器,例如 GenericResourceExpanded 的實例或 cls (回應的結果)

例外狀況

類型 Description

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]

參數

名稱 Description
resource_group_name
必要
str

具有要取得之資源的資源群組。 必要。

filter
必要
str

要套用至 operation.:code 的篩選條件:
<br>您可以用於 eq (等於) 或 ne (不等於) 的屬性為:location、 resourceType、name、resourceGroup、identity、identity/principalId、plan、plan/publisher、plan/product、plan/name、plan/version 和 plan/promotionCode.:code:<br>``<br>例如,若要依資源類型進行篩選,請使用: $filter=resourceType eq 'Microsoft.Network/virtualNetworks':code:<br>``<br>You can use substringof (value, 屬性) 篩選。 您可以用於子字串的屬性包括:name 和 resourceGroup.:code:<br>``<br>例如,若要在名稱中的任何位置取得具有 'demo' 的所有資源,請使用:$filter=substringof ('demo',name) :code:<br>``<br>You can link 一起多個子字符串,方法是新增 和/或運算符。:code:<br>``<br>You can filter by tag names and values。 例如,若要篩選標籤名稱和值,請使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'。 當您依標籤標名稱和值進行篩選時,結果中不會傳回每個資源的標記。:code:<br>:code:>><<<br>:You can use some properties when filter. 您可以使用的組合包括:substringof 和/或 resourceType、plan 和 plan/publisher 和 plan/name、identity 和 identity/principalId。 預設值為 [無]。

expand
必要
str

要包含在回應中的其他屬性逗號分隔清單。 有效值包括 createdTimechangedTimeprovisioningState。 例如: $expand=createdTime,changedTime 。 預設值為 [無]。

top
必要
int

要傳回的結果數目。 如果傳遞 null,則會傳回所有資源。 預設值為 [無]。

傳回

類型 Description

一個反覆運算器,例如 GenericResourceExpanded 的實例或 cls (回應的結果)

例外狀況

類型 Description

屬性

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