DeploymentsOperations Class

DeploymentsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DeploymentsOperations

Constructor

DeploymentsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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.

begin_create_or_update(resource_group_name: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Deployment, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

deployment_name

str

Required

The name of the deployment.

parameters

Deployment

Required

Additional parameters supplied to the operation.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DeploymentExtended]

Exceptions

HttpResponseError

begin_delete

Delete deployment.

begin_delete(resource_group_name: str, deployment_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

deployment_name

str

Required

The name of the deployment to be deleted.

cls

callable

A custom type or function that will be passed the direct response

continuation_token

str

A continuation token to restart a poller from a saved state.

polling

bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval

int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

calculate_template_hash

Calculate the hash of the given template.

calculate_template_hash(template: Any, **kwargs: Any) -> azure.mgmt.resource.resources.v2016_02_01.models._models_py3.TemplateHashResult

Parameters

template

any

Required

The template provided to calculate hash.

cls

callable

A custom type or function that will be passed the direct response

Returns

TemplateHashResult, or the result of cls(response)

Return type

TemplateHashResult

Exceptions

HttpResponseError

cancel

Cancel a currently running template deployment.

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

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

deployment_name

str

Required

The name of the deployment.

cls

callable

A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

check_existence

Checks whether deployment exists.

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

Parameters

resource_group_name

str

Required

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

deployment_name

str

Required

The name of the deployment.

cls

callable

A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

bool

Exceptions

HttpResponseError

export_template

Exports a deployment template.

export_template(resource_group_name: str, deployment_name: str, **kwargs: Any) -> azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExportResult

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

deployment_name

str

Required

The name of the deployment.

cls

callable

A custom type or function that will be passed the direct response

Returns

DeploymentExportResult, or the result of cls(response)

Return type

DeploymentExportResult

Exceptions

HttpResponseError

get

Get a deployment.

get(resource_group_name: str, deployment_name: str, **kwargs: Any) -> azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentExtended

Parameters

resource_group_name

str

Required

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

deployment_name

str

Required

The name of the deployment.

cls

callable

A custom type or function that will be passed the direct response

Returns

DeploymentExtended, or the result of cls(response)

Return type

DeploymentExtended

Exceptions

HttpResponseError

list

Get a list of deployments.

list(resource_group_name: str, filter: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentListResult]

Parameters

resource_group_name

str

Required

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

filter

str

Required

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

top

int

Required

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

cls

callable

A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[DeploymentListResult]

Exceptions

HttpResponseError

validate

Validate a deployment template.

validate(resource_group_name: str, deployment_name: str, parameters: azure.mgmt.resource.resources.v2016_02_01.models._models_py3.Deployment, **kwargs: Any) -> azure.mgmt.resource.resources.v2016_02_01.models._models_py3.DeploymentValidateResult

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

deployment_name

str

Required

The name of the deployment.

parameters

Deployment

Required

Deployment to validate.

cls

callable

A custom type or function that will be passed the direct response

Returns

DeploymentValidateResult, or the result of cls(response)

Return type

DeploymentValidateResult

Exceptions

HttpResponseError

Attributes

models

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