azure.mgmt.deploymentmanager.operations module¶

class azure.mgmt.deploymentmanager.operations.ArtifactSourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s artifact_sources attribute.

create_or_update(resource_group_name: str, artifact_source_name: str, artifact_source_info: Optional[_models.ArtifactSource] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArtifactSource[source]¶

create_or_update(resource_group_name: str, artifact_source_name: str, artifact_source_info: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ArtifactSource

Creates or updates an artifact source.

Synchronously creates a new artifact source or updates an existing artifact source.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
artifact_source_name (str) – The name of the artifact source. Required.
artifact_source_info (ArtifactSource or IO) – Source object that defines the resource. Is either a model type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ArtifactSource or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(resource_group_name: str, artifact_source_name: str, **kwargs: Any) → None [source]¶

Deletes an artifact source.

Deletes an artifact source.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
artifact_source_name (str) – The name of the artifact source. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, artifact_source_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.ArtifactSource[source]¶

Gets an artifact source.

Gets an artifact source.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
artifact_source_name (str) – The name of the artifact source. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ArtifactSource or the result of cls(response)

Return type

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.ArtifactSource][source]¶

Lists the artifact sources in a resource group.

Lists the artifact sources in a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of ArtifactSource or the result of cls(response)
Return type: list[ArtifactSource]
Raises: HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s operations attribute.

list(**kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.OperationsList[source]¶

Lists the supported operations.

Lists the supported operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: OperationsList or the result of cls(response)
Return type: OperationsList
Raises: HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.RolloutsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s rollouts attribute.

begin_create_or_update(resource_group_name: str, rollout_name: str, rollout_request: Optional[_models.RolloutRequest] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RolloutRequest][source]¶

begin_create_or_update(resource_group_name: str, rollout_name: str, rollout_request: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.RolloutRequest]

Creates or updates a rollout.

This is an asynchronous operation and can be polled to completion using the location header returned by this operation.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
rollout_name (str) – The rollout name. Required.
rollout_request (RolloutRequest or IO) – Source rollout request object that defines the rollout. Is either a model type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 RolloutRequest or the result of cls(response)

Return type

LROPoller[RolloutRequest]

Raises

HttpResponseError –

cancel(resource_group_name: str, rollout_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.Rollout[source]¶

Stops a running rollout.

Only running rollouts can be canceled.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
rollout_name (str) – The rollout name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Rollout or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(resource_group_name: str, rollout_name: str, **kwargs: Any) → None [source]¶

Deletes a rollout resource.

Only rollouts in terminal state can be deleted.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
rollout_name (str) – The rollout name. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, rollout_name: str, retry_attempt: Optional[int] = None, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.Rollout[source]¶

Gets detailed information of a rollout.

Gets detailed information of a rollout.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
rollout_name (str) – The rollout name. Required.
retry_attempt (int) – Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Rollout or the result of cls(response)

Return type

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.Rollout][source]¶

Lists the rollouts in a resource group.

Lists the rollouts in a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of Rollout or the result of cls(response)
Return type: list[Rollout]
Raises: HttpResponseError –

restart(resource_group_name: str, rollout_name: str, skip_succeeded: Optional[bool] = None, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.Rollout[source]¶

Restarts a failed rollout and optionally skips all succeeded steps.

Only failed rollouts can be restarted.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
rollout_name (str) – The rollout name. Required.
skip_succeeded (bool) – If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Rollout or the result of cls(response)

Return type

Raises

HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.ServiceTopologiesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s service_topologies attribute.

create_or_update(resource_group_name: str, service_topology_name: str, service_topology_info: _models.ServiceTopologyResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceTopologyResource[source]¶

create_or_update(resource_group_name: str, service_topology_name: str, service_topology_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceTopologyResource

Creates or updates a service topology.

Synchronously creates a new service topology or updates an existing service topology.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_topology_info (ServiceTopologyResource or IO) – Source topology object defines the resource. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceTopologyResource or the result of cls(response)

Return type

ServiceTopologyResource

Raises

HttpResponseError –

delete(resource_group_name: str, service_topology_name: str, **kwargs: Any) → None [source]¶

Deletes the service topology.

Deletes the service topology.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, service_topology_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.ServiceTopologyResource[source]¶

Gets the service topology.

Gets the service topology.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceTopologyResource or the result of cls(response)

Return type

ServiceTopologyResource

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.ServiceTopologyResource][source]¶

Lists the service topologies in the resource group.

Lists the service topologies in the resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of ServiceTopologyResource or the result of cls(response)
Return type: list[ServiceTopologyResource]
Raises: HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.ServiceUnitsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s service_units attribute.

begin_create_or_update(resource_group_name: str, service_topology_name: str, service_name: str, service_unit_name: str, service_unit_info: _models.ServiceUnitResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceUnitResource][source]¶

begin_create_or_update(resource_group_name: str, service_topology_name: str, service_name: str, service_unit_name: str, service_unit_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ServiceUnitResource]

Creates or updates a service unit under the service in the service topology.

This is an asynchronous operation and can be polled to completion using the operation resource returned by this operation.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.
service_unit_name (str) – The name of the service unit resource. Required.
service_unit_info (ServiceUnitResource or IO) – The service unit resource object. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
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 ServiceUnitResource or the result of cls(response)

Return type

LROPoller[ServiceUnitResource]

Raises

HttpResponseError –

delete(resource_group_name: str, service_topology_name: str, service_name: str, service_unit_name: str, **kwargs: Any) → None [source]¶

Deletes the service unit.

Deletes the service unit.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.
service_unit_name (str) – The name of the service unit resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, service_topology_name: str, service_name: str, service_unit_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.ServiceUnitResource[source]¶

Gets the service unit.

Gets the service unit.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.
service_unit_name (str) – The name of the service unit resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceUnitResource or the result of cls(response)

Return type

ServiceUnitResource

Raises

HttpResponseError –

list(resource_group_name: str, service_topology_name: str, service_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.ServiceUnitResource][source]¶

Lists the service units under a service in the service topology.

Lists the service units under a service in the service topology.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of ServiceUnitResource or the result of cls(response)

Return type

list[ServiceUnitResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.ServicesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s services attribute.

create_or_update(resource_group_name: str, service_topology_name: str, service_name: str, service_info: _models.ServiceResource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceResource[source]¶

create_or_update(resource_group_name: str, service_topology_name: str, service_name: str, service_info: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ServiceResource

Creates or updates a service in the service topology.

Synchronously creates a new service or updates an existing service.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.
service_info (ServiceResource or IO) – The service object. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceResource or the result of cls(response)

Return type

ServiceResource

Raises

HttpResponseError –

delete(resource_group_name: str, service_topology_name: str, service_name: str, **kwargs: Any) → None [source]¶

Deletes the service.

Deletes the service.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, service_topology_name: str, service_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.ServiceResource[source]¶

Gets the service.

Gets the service.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.
service_name (str) – The name of the service resource. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ServiceResource or the result of cls(response)

Return type

ServiceResource

Raises

HttpResponseError –

list(resource_group_name: str, service_topology_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.ServiceResource][source]¶

Lists the services in the service topology.

Lists the services in the service topology.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
service_topology_name (str) – The name of the service topology . Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of ServiceResource or the result of cls(response)

Return type

list[ServiceResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶

class azure.mgmt.deploymentmanager.operations.StepsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AzureDeploymentManager’s steps attribute.

create_or_update(resource_group_name: str, step_name: str, step_info: Optional[_models.StepResource] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StepResource[source]¶

create_or_update(resource_group_name: str, step_name: str, step_info: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.StepResource

Creates or updates a rollout step with the given step properties.

Synchronously creates a new step or updates an existing step.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
step_name (str) – The name of the deployment step. Required.
step_info (StepResource or IO) – The step object. Is either a model type or a IO type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

StepResource or the result of cls(response)

Return type

Raises

HttpResponseError –

delete(resource_group_name: str, step_name: str, **kwargs: Any) → None [source]¶

Deletes the step.

Deletes the step.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
step_name (str) – The name of the deployment step. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

HttpResponseError –

get(resource_group_name: str, step_name: str, **kwargs: Any) → azure.mgmt.deploymentmanager.models._models_py3.StepResource[source]¶

Gets the step.

Gets the step.

Parameters

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
step_name (str) – The name of the deployment step. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

StepResource or the result of cls(response)

Return type

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → List[azure.mgmt.deploymentmanager.models._models_py3.StepResource][source]¶

Lists the steps in a resource group.

Lists the steps in a resource group.

Parameters: resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: list of StepResource or the result of cls(response)
Return type: list[StepResource]
Raises: HttpResponseError –

models = <module 'azure.mgmt.deploymentmanager.models' from '/mnt/vss/_work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>¶