azure.mgmt.deploymentmanager.operations module

class azure.mgmt.deploymentmanager.operations.ServiceTopologiesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceTopologiesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

create_or_update(service_topology_info, resource_group_name, service_topology_name, custom_headers=None, raw=False, **operation_config)[source]

Creates or updates a service topology.

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

Parameters

  • service_topology_info (ServiceTopologyResource) – Source topology object defines the resource.

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceTopologyResource or ClientRawResponse if raw=true

Return type

ServiceTopologyResource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, service_topology_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the service topology.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, service_topology_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the service topology.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceTopologyResource or ClientRawResponse if raw=true

Return type

ServiceTopologyResource or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the service topologies in the resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ServiceTopologyResource] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.ServicesOperations(client, config, serializer, deserializer)[source]

Bases: object

ServicesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

create_or_update(resource_group_name, service_topology_name, service_name, service_info, custom_headers=None, raw=False, **operation_config)[source]

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.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • service_info (ServiceResource) – The service object

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceResource or ClientRawResponse if raw=true

Return type

ServiceResource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, service_topology_name, service_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the service.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, service_topology_name, service_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the service.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceResource or ClientRawResponse if raw=true

Return type

ServiceResource or ClientRawResponse

Raises

CloudError

list(resource_group_name, service_topology_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the services in the service topology.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ServiceResource] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.ServiceUnitsOperations(client, config, serializer, deserializer)[source]

Bases: object

ServiceUnitsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

create_or_update(resource_group_name, service_topology_name, service_name, service_unit_name, service_unit_info, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • service_unit_name (str) – The name of the service unit resource.

  • service_unit_info (ServiceUnitResource) – The service unit resource object.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns ServiceUnitResource or ClientRawResponse<ServiceUnitResource> if raw==True

Return type

AzureOperationPoller[ServiceUnitResource] or AzureOperationPoller[ClientRawResponse[ServiceUnitResource]]

Raises

CloudError

delete(resource_group_name, service_topology_name, service_name, service_unit_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the service unit.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • service_unit_name (str) – The name of the service unit resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, service_topology_name, service_name, service_unit_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the service unit.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • service_unit_name (str) – The name of the service unit resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ServiceUnitResource or ClientRawResponse if raw=true

Return type

ServiceUnitResource or ClientRawResponse

Raises

CloudError

list(resource_group_name, service_topology_name, service_name, custom_headers=None, raw=False, **operation_config)[source]

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.

  • service_topology_name (str) – The name of the service topology .

  • service_name (str) – The name of the service resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ServiceUnitResource] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.StepsOperations(client, config, serializer, deserializer)[source]

Bases: object

StepsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

create_or_update(resource_group_name, step_name, step_info=None, custom_headers=None, raw=False, **operation_config)[source]

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.

  • step_name (str) – The name of the deployment step.

  • step_info (StepResource) – The step object.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

StepResource or ClientRawResponse if raw=true

Return type

StepResource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, step_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes the step.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • step_name (str) – The name of the deployment step.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, step_name, custom_headers=None, raw=False, **operation_config)[source]

Gets the step.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • step_name (str) – The name of the deployment step.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

StepResource or ClientRawResponse if raw=true

Return type

StepResource or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the steps in a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[StepResource] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.RolloutsOperations(client, config, serializer, deserializer)[source]

Bases: object

RolloutsOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

cancel(resource_group_name, rollout_name, custom_headers=None, raw=False, **operation_config)[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.

  • rollout_name (str) – The rollout name.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Rollout or ClientRawResponse if raw=true

Return type

Rollout or ClientRawResponse

Raises

CloudError

create_or_update(resource_group_name, rollout_name, rollout_request=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]

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.

  • rollout_name (str) – The rollout name.

  • rollout_request (RolloutRequest) – Source rollout request object that defines the rollout.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response

  • polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

Returns

An instance of LROPoller that returns RolloutRequest or ClientRawResponse<RolloutRequest> if raw==True

Return type

AzureOperationPoller[RolloutRequest] or AzureOperationPoller[ClientRawResponse[RolloutRequest]]

Raises

CloudError

delete(resource_group_name, rollout_name, custom_headers=None, raw=False, **operation_config)[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.

  • rollout_name (str) – The rollout name.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, rollout_name, retry_attempt=None, custom_headers=None, raw=False, **operation_config)[source]

Gets detailed information of a rollout.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • rollout_name (str) – The rollout name.

  • retry_attempt (int) – Rollout retry attempt ordinal to get the result of. If not specified, result of the latest attempt will be returned.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Rollout or ClientRawResponse if raw=true

Return type

Rollout or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the rollouts in a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[Rollout] or ClientRawResponse

Raises

CloudError

restart(resource_group_name, rollout_name, skip_succeeded=None, custom_headers=None, raw=False, **operation_config)[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.

  • rollout_name (str) – The rollout name.

  • 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.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

Rollout or ClientRawResponse if raw=true

Return type

Rollout or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.ArtifactSourcesOperations(client, config, serializer, deserializer)[source]

Bases: object

ArtifactSourcesOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

create_or_update(resource_group_name, artifact_source_name, artifact_source_info=None, custom_headers=None, raw=False, **operation_config)[source]

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.

  • artifact_source_name (str) – The name of the artifact source.

  • artifact_source_info (ArtifactSource) – Source object that defines the resource.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ArtifactSource or ClientRawResponse if raw=true

Return type

ArtifactSource or ClientRawResponse

Raises

CloudError

delete(resource_group_name, artifact_source_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an artifact source.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • artifact_source_name (str) – The name of the artifact source.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

CloudError

get(resource_group_name, artifact_source_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an artifact source.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • artifact_source_name (str) – The name of the artifact source.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

ArtifactSource or ClientRawResponse if raw=true

Return type

ArtifactSource or ClientRawResponse

Raises

CloudError

list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists the artifact sources in a resource group.

Parameters

  • resource_group_name (str) – The name of the resource group. The name is case insensitive.

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

list or ClientRawResponse if raw=true

Return type

list[ArtifactSource] or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>
class azure.mgmt.deploymentmanager.operations.Operations(client, config, serializer, deserializer)[source]

Bases: object

Operations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Parameters

  • client – Client for service requests.

  • config – Configuration of service client.

  • serializer – An object model serializer.

  • deserializer – An object model deserializer.

Variables

api_version – The API version to use for this operation. Constant value: “2019-11-01-preview”.

list(custom_headers=None, raw=False, **operation_config)[source]

Lists the supported operations.

Parameters

  • custom_headers (dict) – headers that will be added to the request

  • raw (bool) – returns the direct response alongside the deserialized response

  • operation_config – Operation configuration overrides.

Returns

OperationsList or ClientRawResponse if raw=true

Return type

OperationsList or ClientRawResponse

Raises

CloudError

models = <module 'azure.mgmt.deploymentmanager.models' from '/home/vsts/work/1/s/sdk/deploymentmanager/azure-mgmt-deploymentmanager/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/deploymentmanager/models/__init__.py'>