Share via

DeploymentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ResourceManagementClient's

<xref:deployments> attribute.

Constructor

DeploymentsOperations(*args, **kwargs)

Methods

begin_create_or_update

Create a named template deployment using a template.
begin_delete

Delete deployment.
calculate_template_hash

Calculate the hash of the given template.
cancel

Cancel a currently running template deployment.
check_existence

Checks whether deployment exists.
export_template

Exports a deployment template.
get

Get a deployment.
list

Get a list of deployments.
validate

Validate a deployment template.

begin_create_or_update

Create a named template deployment using a template.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Additional parameters supplied to the operation. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[DeploymentExtended]

An instance of AsyncLROPoller that returns either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete deployment.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment to be deleted. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

calculate_template_hash

Calculate the hash of the given template.

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

Parameters

Name Description
template
Required
<xref:JSON>

The template provided to calculate hash. Required.

Returns

Type Description
TemplateHashResult

TemplateHashResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

cancel

Cancel a currently running template deployment.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

check_existence

Checks whether deployment exists.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to check. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
bool

bool or the result of cls(response)

Exceptions

Type Description
HttpResponseError

export_template

Exports a deployment template.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExportResult

DeploymentExportResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get a deployment.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to get. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.

Returns

Type Description
DeploymentExtended

DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Get a list of deployments.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to filter by. The name is case insensitive. Required.
filter
str

The filter to apply on the operation. Default value is None.

Default value: None
top
int

Query parameters. If null is passed returns all deployments. Default value is None.

Default value: None

Returns

Type Description
AsyncItemPaged[DeploymentExtended]

An iterator like instance of either DeploymentExtended or the result of cls(response)

Exceptions

Type Description
HttpResponseError

validate

Validate a deployment template.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
deployment_name
Required
str

The name of the deployment. Required.
parameters
Required
Deployment or IO[bytes]

Deployment to validate. Is either a Deployment type or a IO[bytes] type. Required.

Returns

Type Description
DeploymentValidateResult

DeploymentValidateResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.resource.resources.v2016_02_01.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv206\\Lib\\site-packages\\azure\\mgmt\\resource\\resources\\v2016_02_01\\models\\__init__.py'>