DeploymentsOperations 類別

警告

請勿直接具現化此類別。

您應該改為透過 存取下列作業

ResourceManagementClient's

<xref:deployments> 屬性。

繼承

builtins.object

DeploymentsOperations

建構函式

DeploymentsOperations(*args, **kwargs)

方法

begin_create_or_update	將資源部署至資源群組。 您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。
begin_create_or_update_at_management_group_scope	在管理群組範圍部署資源。 您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。
begin_create_or_update_at_subscription_scope	在訂用帳戶範圍部署資源。 您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。
begin_delete	從部署歷程記錄中刪除部署。 無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 刪除範本部署不會影響資源群組的狀態。 這是非同步作業，會傳回狀態為 202，直到成功刪除範本部署為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。
begin_delete_at_management_group_scope	從部署歷程記錄中刪除部署。 無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 這是非同步作業，會傳回狀態為 202，直到成功刪除範本部署為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。
begin_delete_at_subscription_scope	從部署歷程記錄中刪除部署。 無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 這是非同步作業，會傳回狀態為 202，直到範本部署成功為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。
calculate_template_hash	計算指定範本的雜湊。
cancel	取消目前正在執行的範本部署。 只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前執行中的範本部署，並且讓資源群組維持部分部署。
cancel_at_management_group_scope	取消目前正在執行的範本部署。 只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前正在執行的範本部署，並讓資源部分部署。
cancel_at_subscription_scope	取消目前正在執行的範本部署。 只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前正在執行的範本部署，並讓資源部分部署。
check_existence	檢查部署是否存在。
check_existence_at_management_group_scope	檢查部署是否存在。
check_existence_at_subscription_scope	檢查部署是否存在。
export_template	匯出用於指定部署的範本。
export_template_at_management_group_scope	匯出用於指定部署的範本。
export_template_at_subscription_scope	匯出用於指定部署的範本。
get	取得部署。
get_at_management_group_scope	取得部署。
get_at_subscription_scope	取得部署。
list_at_management_group_scope	取得管理群組的所有部署。
list_at_subscription_scope	取得訂用帳戶的所有部署。
list_by_resource_group	取得某個資源群組的所有部署。
validate	驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。
validate_at_management_group_scope	驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。
validate_at_subscription_scope	驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。

begin_create_or_update

將資源部署至資源群組。

您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

參數

resource_group_name

str

必要

要部署資源的資源群組名稱。 名稱不區分大小寫。 資源群組必須已存在。 必要。

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

提供給作業的其他參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

會傳回 DeploymentExtended 或 cls (回應結果的 LROPoller 實例)

傳回類型

LROPoller[DeploymentExtended]

例外狀況

HttpResponseError

begin_create_or_update_at_management_group_scope

在管理群組範圍部署資源。

您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。

begin_create_or_update_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

提供給作業的其他參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

會傳回 DeploymentExtended 或 cls (回應結果的 LROPoller 實例)

傳回類型

LROPoller[DeploymentExtended]

例外狀況

HttpResponseError

begin_create_or_update_at_subscription_scope

在訂用帳戶範圍部署資源。

您可以直接在要求中提供範本和參數，或連結到 JSON 檔案。

begin_create_or_update_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.DeploymentExtended]

參數

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

提供給作業的其他參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

會傳回 DeploymentExtended 或 cls (回應結果的 LROPoller 實例)

傳回類型

LROPoller[DeploymentExtended]

例外狀況

HttpResponseError

begin_delete

從部署歷程記錄中刪除部署。

無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 刪除範本部署不會影響資源群組的狀態。 這是非同步作業，會傳回狀態為 202，直到成功刪除範本部署為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。

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

參數

resource_group_name

str

必要

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

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

LROPoller 的實例，會傳回 None 或 cls (回應的結果)

傳回類型

LROPoller[None]

例外狀況

HttpResponseError

begin_delete_at_management_group_scope

從部署歷程記錄中刪除部署。

無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 這是非同步作業，會傳回狀態為 202，直到成功刪除範本部署為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。

begin_delete_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> LROPoller[None]

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

LROPoller 的實例，會傳回 None 或 cls (回應的結果)

傳回類型

LROPoller[None]

例外狀況

HttpResponseError

begin_delete_at_subscription_scope

從部署歷程記錄中刪除部署。

無法刪除目前正在執行的範本部署。 刪除範本部署會移除相關聯的部署作業。 這是非同步作業，會傳回狀態為 202，直到範本部署成功為止。 位置回應標頭包含用來取得進程狀態的 URI。 當程序正在執行時，呼叫 Location 標頭中的 URI 會傳回狀態 202。 當進程完成時，Location 標頭中的 URI 會在成功時傳回 204 的狀態。 如果非同步要求失敗，Location 標頭中的 URI 會傳回錯誤層級的狀態碼。

begin_delete_at_subscription_scope(deployment_name: str, **kwargs: Any) -> LROPoller[None]

參數

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

continuation_token

str

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

polling

bool 或 PollingMethod

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

polling_interval

int

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

傳回

LROPoller 的實例，會傳回 None 或 cls (回應的結果)

傳回類型

LROPoller[None]

例外狀況

HttpResponseError

calculate_template_hash

計算指定範本的雜湊。

calculate_template_hash(template: MutableMapping[str, Any], **kwargs: Any) -> TemplateHashResult

參數

template

<xref:JSON>

必要

提供用來計算雜湊的範本。 必要。

cls

callable

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

傳回

TemplateHashResult 或 cls (回應的結果)

傳回類型

TemplateHashResult

例外狀況

HttpResponseError

cancel

取消目前正在執行的範本部署。

只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前執行中的範本部署，並且讓資源群組維持部分部署。

cancel(resource_group_name: str, deployment_name: str, **kwargs: Any) -> None

參數

resource_group_name

str

必要

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

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

cancel_at_management_group_scope

取消目前正在執行的範本部署。

只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前正在執行的範本部署，並讓資源部分部署。

cancel_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> None

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

cancel_at_subscription_scope

取消目前正在執行的範本部署。

只有在 provisioningState 已接受或執行時，您才可以取消部署。 取消部署之後，provisioningState 會設定為 [已取消]。 取消範本部署會停止目前正在執行的範本部署，並讓資源部分部署。

cancel_at_subscription_scope(deployment_name: str, **kwargs: Any) -> None

參數

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

無或 cls (回應的結果)

傳回類型

None

例外狀況

HttpResponseError

check_existence

檢查部署是否存在。

check_existence(resource_group_name: str, deployment_name: str, **kwargs: Any) -> bool

參數

resource_group_name

str

必要

要檢查之部署的資源群組名稱。 名稱不區分大小寫。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

bool 或 cls (回應的結果)

傳回類型

bool

例外狀況

HttpResponseError

check_existence_at_management_group_scope

檢查部署是否存在。

check_existence_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> bool

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

bool 或 cls (回應的結果)

傳回類型

bool

例外狀況

HttpResponseError

check_existence_at_subscription_scope

檢查部署是否存在。

check_existence_at_subscription_scope(deployment_name: str, **kwargs: Any) -> bool

參數

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

bool 或 cls (回應的結果)

傳回類型

bool

例外狀況

HttpResponseError

export_template

匯出用於指定部署的範本。

export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

參數

resource_group_name

str

必要

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

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExportResult 或 cls 的結果 (回應)

傳回類型

DeploymentExportResult

例外狀況

HttpResponseError

export_template_at_management_group_scope

匯出用於指定部署的範本。

export_template_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExportResult

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExportResult 或 cls 的結果 (回應)

傳回類型

DeploymentExportResult

例外狀況

HttpResponseError

export_template_at_subscription_scope

匯出用於指定部署的範本。

export_template_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExportResult

參數

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExportResult 或 cls 的結果 (回應)

傳回類型

DeploymentExportResult

例外狀況

HttpResponseError

get

取得部署。

get(resource_group_name: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

參數

resource_group_name

str

必要

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

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExtended 或 cls 的結果 (回應)

傳回類型

DeploymentExtended

例外狀況

HttpResponseError

get_at_management_group_scope

取得部署。

get_at_management_group_scope(group_id: str, deployment_name: str, **kwargs: Any) -> DeploymentExtended

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExtended 或 cls (回應的結果)

傳回類型

DeploymentExtended

例外狀況

HttpResponseError

get_at_subscription_scope

取得部署。

get_at_subscription_scope(deployment_name: str, **kwargs: Any) -> DeploymentExtended

參數

deployment_name

str

必要

部署的名稱。 必要。

cls

callable

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

傳回

DeploymentExtended 或 cls (回應的結果)

傳回類型

DeploymentExtended

例外狀況

HttpResponseError

list_at_management_group_scope

取得管理群組的所有部署。

list_at_management_group_scope(group_id: str, filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

參數

group_id

str

必要

管理群組識別碼。 必要。

filter

str

必要

要套用至作業的篩選準則。 例如，您可以使用 $filter=provisioningState eq '{state}'。 預設值為 [無]。

top

int

必要

要取得的結果數目。 如果傳遞 null，則會傳回所有部署。 預設值為 [無]。

cls

callable

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

傳回

例如 DeploymentExtended 實例或 cls (回應結果的反覆運算器)

傳回類型

ItemPaged[DeploymentExtended]

例外狀況

HttpResponseError

list_at_subscription_scope

取得訂用帳戶的所有部署。

list_at_subscription_scope(filter: str | None = None, top: int | None = None, **kwargs: Any) -> Iterable[DeploymentExtended]

參數

filter

str

必要

要套用至作業的篩選準則。 例如，您可以使用 $filter=provisioningState eq '{state}'。 預設值為 [無]。

top

int

必要

要取得的結果數目。 如果傳遞 null，則會傳回所有部署。 預設值為 [無]。

cls

callable

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

傳回

例如 DeploymentExtended 實例或 cls (回應結果的反覆運算器)

傳回類型

ItemPaged[DeploymentExtended]

例外狀況

HttpResponseError

list_by_resource_group

取得某個資源群組的所有部署。

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

參數

resource_group_name

str

必要

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

filter

str

必要

要套用至作業的篩選準則。 例如，您可以使用 $filter=provisioningState eq '{state}'。 預設值為 [無]。

top

int

必要

要取得的結果數目。 如果傳遞 null，則會傳回所有部署。 預設值為 [無]。

cls

callable

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

傳回

例如 DeploymentExtended 實例或 cls (回應結果的反覆運算器)

傳回類型

ItemPaged[DeploymentExtended]

例外狀況

HttpResponseError

validate

驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。

validate(resource_group_name: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

參數

resource_group_name

str

必要

將部署範本的資源群組名稱。 名稱不區分大小寫。 必要。

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

要驗證的參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

傳回

DeploymentValidateResult 或 cls (回應的結果)

傳回類型

DeploymentValidateResult

例外狀況

HttpResponseError

validate_at_management_group_scope

驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。

validate_at_management_group_scope(group_id: str, deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

參數

group_id

str

必要

管理群組識別碼。 必要。

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

要驗證的參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

傳回

DeploymentValidateResult 或 cls (回應的結果)

傳回類型

DeploymentValidateResult

例外狀況

HttpResponseError

validate_at_subscription_scope

驗證指定的範本是否語法正確，且將由 Azure Resource Manager 接受。

validate_at_subscription_scope(deployment_name: str, parameters: _models.Deployment, *, content_type: str = 'application/json', **kwargs: Any) -> _models.DeploymentValidateResult

參數

deployment_name

str

必要

部署的名稱。 必要。

parameters

Deployment 或 IO

必要

要驗證的參數。 這是部署類型或 IO 類型。 必要。

content_type

str

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

cls

callable

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

傳回

DeploymentValidateResult 或 cls (回應的結果)

傳回類型

DeploymentValidateResult

例外狀況

HttpResponseError

屬性

models

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