共用方式為


ResourcesOperations 類別

警告

請勿直接具現化此類別。

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

ResourceManagementClient's

<xref:resources> 屬性。

繼承
builtins.object
ResourcesOperations

建構函式

ResourcesOperations(*args, **kwargs)

方法

begin_create_or_update

建立資源。

begin_create_or_update_by_id

依識別碼建立資源。

begin_delete

刪除資源。

begin_delete_by_id

依識別碼刪除資源。

begin_move_resources

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

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

begin_update

更新資源。

begin_update_by_id

依識別碼更新資源。

begin_validate_move_resources

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

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

check_existence

檢查資源是否存在。

check_existence_by_id

依識別碼檢查資源是否存在。

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]

參數

resource_group_name
str
必要

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

resource_provider_namespace
str
必要

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

parent_resource_path
str
必要

父資源識別。 必要。

resource_type
str
必要

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

resource_name
str
必要

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

api_version
str
必要

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

parameters
GenericResourceIO
必要

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

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

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

傳回類型

例外狀況

begin_create_or_update_by_id

依識別碼建立資源。

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

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

api_version
str
必要

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

parameters
GenericResourceIO
必要

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

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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

父資源識別。 必要。

resource_type
str
必要

資源類型。 必要。

resource_name
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

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

傳回類型

例外狀況

begin_delete_by_id

依識別碼刪除資源。

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

參數

resource_id
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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
ResourcesMoveInfoIO
必要

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

content_type
str

本文參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 傳入 False 表示此作業無法輪詢,或傳入您自己的已初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則兩次輪詢 LRO 作業之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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

父資源識別。 必要。

resource_type
str
必要

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

resource_name
str
必要

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

api_version
str
必要

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

parameters
GenericResourceIO
必要

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

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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]

參數

resource_id
str
必要

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

api_version
str
必要

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

parameters
GenericResourceIO
必要

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

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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
ResourcesMoveInfoIO
必要

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

content_type
str

Body 參數內容類型。 已知值為:'application/json'。 預設值為 [無]。

cls
callable

將傳遞直接回應的自訂類型或函式

continuation_token
str

從已儲存狀態重新開機輪詢器的接續權杖。

polling
boolAsyncPollingMethod

根據預設,您的輪詢方法會是 AsyncARMPolling。 針對此作業傳入 False,以不輪詢,或傳入您自己的初始化輪詢物件,以取得個人輪詢策略。

polling_interval
int

如果沒有Retry-After標頭,則為 LRO 作業的兩個輪詢之間的預設等候時間。

傳回

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

傳回類型

例外狀況

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

父資源識別。 必要。

resource_type
str
必要

資源類型。 必要。

resource_name
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

bool 或 cls (回應的結果)

傳回類型

例外狀況

check_existence_by_id

依識別碼檢查資源是否存在。

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

參數

resource_id
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

bool 或 cls (回應的結果)

傳回類型

例外狀況

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

父資源識別。 必要。

resource_type
str
必要

資源的資源類型。 必要。

resource_name
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

GenericResource 或 cls 的結果 (回應)

傳回類型

例外狀況

get_by_id

依識別碼取得資源。

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

參數

resource_id
str
必要

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

api_version
str
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

GenericResource 或 cls 的結果 (回應)

傳回類型

例外狀況

list

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

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

參數

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 透過新增 和/或運算子,將多個子字串連結在一起。:code: <br>``<br> 您可以依標籤名稱和值進行篩選。 例如,若要篩選標籤名稱和值,請使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'。 當您依標籤名稱和值進行篩選時,結果中不會傳回每個資源的標記。:code: <br> :code: >><<<br> You 可以在篩選時一起使用某些屬性。 您可以使用的組合包括:substringof 和/或 resourceType、plan 和 plan/publisher 和 plan/name、identity 和 identity/principalId。 預設值為 [無]。

expand
str
必要

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

top
int
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 GenericResourceExpanded 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

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

要套用至 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 透過新增 和/或運算子,將多個子字串連結在一起。:code: <br>``<br> 您可以依標籤名稱和值進行篩選。 例如,若要篩選標籤名稱和值,請使用 $filter=tagName eq 'tag1' 和 tagValue eq 'Value1'。 當您依標籤名稱和值進行篩選時,結果中不會傳回每個資源的標記。:code: <br> :code: >><<<br> You 可以在篩選時一起使用某些屬性。 您可以使用的組合包括:substringof 和/或 resourceType、plan 和 plan/publisher 和 plan/name、identity 和 identity/principalId。 預設值為 [無]。

expand
str
必要

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

top
int
必要

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

cls
callable

將傳遞直接回應的自訂類型或函式

傳回

像是 GenericResourceExpanded 實例或 cls (回應結果的反覆運算器)

傳回類型

例外狀況

屬性

models

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