azure.mgmt.deploymentmanager.models module

class azure.mgmt.deploymentmanager.models.ApiKeyAuthentication(*, name: str, in_property: Union[str, _models.RestAuthLocation], value: str, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.RestRequestAuthentication

ApiKey authentication gives a name and a value that can be included in either the request header or query parameters.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str or RestAuthType) – The authentication type. Required. Known values are: “ApiKey” and “RolloutIdentity”.

  • name (str) – The key name of the authentication key/value pair. Required.

  • in_property (str or RestAuthLocation) – The location of the authentication key/value pair in the request. Required. Known values are: “Query” and “Header”.

  • value (str) – The value of the authentication key/value pair. Required.

Keyword Arguments

  • name (str) – The key name of the authentication key/value pair. Required.

  • in_property (str or RestAuthLocation) – The location of the authentication key/value pair in the request. Required. Known values are: “Query” and “Header”.

  • value (str) – The value of the authentication key/value pair. Required.

class azure.mgmt.deploymentmanager.models.ArtifactSource(*, location: str, tags: Optional[Dict[str, str]] = None, source_type: Optional[str] = None, artifact_root: Optional[str] = None, authentication: Optional[_models.Authentication] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

The resource that defines the source location where the artifacts are located.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • source_type (str) – The type of artifact source used.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • source_type (str) – The type of artifact source used.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source.

class azure.mgmt.deploymentmanager.models.ArtifactSourceProperties(*, source_type: str, authentication: _models.Authentication, artifact_root: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ArtifactSourcePropertiesAutoGenerated

The properties that define the artifact source.

All required parameters must be populated in order to send to Azure.

Variables

  • source_type (str) – The type of artifact source used. Required.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source. Required.

Keyword Arguments

  • source_type (str) – The type of artifact source used. Required.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source. Required.

class azure.mgmt.deploymentmanager.models.ArtifactSourcePropertiesAutoGenerated(*, source_type: str, authentication: _models.Authentication, artifact_root: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties that define the source location where the artifacts are located.

All required parameters must be populated in order to send to Azure.

Variables

  • source_type (str) – The type of artifact source used. Required.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source. Required.

Keyword Arguments

  • source_type (str) – The type of artifact source used. Required.

  • artifact_root (str) – The path from the location that the ‘authentication’ property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.

  • authentication (Authentication) – The authentication method to use to access the artifact source. Required.

class azure.mgmt.deploymentmanager.models.Authentication(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Defines the authentication method and properties to access the artifacts.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: SasAuthentication

All required parameters must be populated in order to send to Azure.

Variables

type (str) – The authentication type. Required.

class azure.mgmt.deploymentmanager.models.CloudErrorBody(*, target: Optional[str] = None, details: Optional[List[_models.CloudErrorBody]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Detailed error information of any failure.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • code (str) – Error code string.

  • message (str) – Descriptive error information.

  • target (str) – Error target.

  • details (list[CloudErrorBody]) – More detailed error information.

Keyword Arguments
class azure.mgmt.deploymentmanager.models.DeploymentMode(value)[source]

Bases: str, enum.Enum

Describes the type of ARM deployment to be performed on the resource.

COMPLETE = 'Complete'
INCREMENTAL = 'Incremental'
class azure.mgmt.deploymentmanager.models.HealthCheckStepAttributes(*, healthy_state_duration: str, wait_duration: Optional[str] = None, max_elastic_duration: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The attributes for the health check step.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: RestHealthCheckStepAttributes

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – The type of health check. Required.

  • wait_duration (str) – The duration in ISO 8601 format for which health check waits idly without any checks.

  • max_elastic_duration (str) – The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn’t. Health check starts to enforce healthyStateDuration once resource becomes healthy.

  • healthy_state_duration (str) – The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. Required.

Keyword Arguments

  • wait_duration (str) – The duration in ISO 8601 format for which health check waits idly without any checks.

  • max_elastic_duration (str) – The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn’t. Health check starts to enforce healthyStateDuration once resource becomes healthy.

  • healthy_state_duration (str) – The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. Required.

class azure.mgmt.deploymentmanager.models.HealthCheckStepProperties(*, attributes: _models.HealthCheckStepAttributes, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.StepProperties

Defines the properties of a health check step.

All required parameters must be populated in order to send to Azure.

Variables

  • step_type (str or StepType) – The type of step. Required. Known values are: “Wait” and “HealthCheck”.

  • attributes (HealthCheckStepAttributes) – The health check step attributes. Required.

Keyword Arguments

attributes (HealthCheckStepAttributes) – The health check step attributes. Required.

class azure.mgmt.deploymentmanager.models.Identity(*, type: str, identity_ids: List[str], **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Identity for the resource.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – The identity type. Required.

  • identity_ids (list[str]) – The list of identities. Required.

Keyword Arguments

  • type (str) – The identity type. Required.

  • identity_ids (list[str]) – The list of identities. Required.

class azure.mgmt.deploymentmanager.models.Message(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Supplementary contextual messages during a rollout.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • time_stamp (datetime) – Time in UTC this message was provided.

  • message (str) – The actual message text.

class azure.mgmt.deploymentmanager.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationDetail] = None, origin: Optional[str] = None, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Represents an operation that can be performed on the service.

Variables

  • name (str) – The name of the operation.

  • display (OperationDetail) – The display name of the operation.

  • origin (str) – The origin of the operation.

  • properties (JSON) – The properties of the operation.

Keyword Arguments

  • name (str) – The name of the operation.

  • display (OperationDetail) – The display name of the operation.

  • origin (str) – The origin of the operation.

  • properties (JSON) – The properties of the operation.

class azure.mgmt.deploymentmanager.models.OperationDetail(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The detail about an operation.

Variables

  • provider (str) – The name of the provider that supports the operation.

  • resource (str) – The resource type on which this operation can be performed.

  • operation (str) – The name of the operation.

  • description (str) – The description of the operation.

Keyword Arguments

  • provider (str) – The name of the provider that supports the operation.

  • resource (str) – The resource type on which this operation can be performed.

  • operation (str) – The name of the operation.

  • description (str) – The description of the operation.

class azure.mgmt.deploymentmanager.models.OperationsList(*, value: Optional[_models.Operation] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The operations response.

Variables

value (Operation) – The list of supported operations.

Keyword Arguments

value (Operation) – The list of supported operations.

class azure.mgmt.deploymentmanager.models.PrePostStep(*, step_id: str, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties that define a step.

All required parameters must be populated in order to send to Azure.

Variables

step_id (str) – The resource Id of the step to be run. Required.

Keyword Arguments

step_id (str) – The resource Id of the step to be run. Required.

class azure.mgmt.deploymentmanager.models.Resource(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.deploymentmanager.models.ResourceOperation(*, resource_name: Optional[str] = None, resource_type: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Individual resource operation information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • resource_name (str) – Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template.

  • operation_id (str) – Unique identifier of the operation. For ARM resources, this is the operationId obtained from ARM service.

  • resource_type (str) – Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template.

  • provisioning_state (str) – State of the resource deployment. For ARM resources, this is the current provisioning state of the resource.

  • status_message (str) – Descriptive information of the resource operation.

  • status_code (str) – Http status code of the operation.

Keyword Arguments

  • resource_name (str) – Name of the resource as specified in the artifacts. For ARM resources, this is the name of the resource specified in the template.

  • resource_type (str) – Type of the resource as specified in the artifacts. For ARM resources, this is the type of the resource specified in the template.

class azure.mgmt.deploymentmanager.models.RestAuthLocation(value)[source]

Bases: str, enum.Enum

The location of the authentication key/value pair in the request.

HEADER = 'Header'
QUERY = 'Query'
class azure.mgmt.deploymentmanager.models.RestAuthType(value)[source]

Bases: str, enum.Enum

The authentication type.

API_KEY = 'ApiKey'
ROLLOUT_IDENTITY = 'RolloutIdentity'
class azure.mgmt.deploymentmanager.models.RestHealthCheck(*, name: str, request: _models.RestRequest, response: Optional[_models.RestResponse] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

A REST based health check.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – A unique name for this check. Required.

  • request (RestRequest) – The request to the health provider. Required.

  • response (RestResponse) – The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.

Keyword Arguments

  • name (str) – A unique name for this check. Required.

  • request (RestRequest) – The request to the health provider. Required.

  • response (RestResponse) – The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.

class azure.mgmt.deploymentmanager.models.RestHealthCheckStepAttributes(*, healthy_state_duration: str, wait_duration: Optional[str] = None, max_elastic_duration: Optional[str] = None, health_checks: Optional[List[_models.RestHealthCheck]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.HealthCheckStepAttributes

Defines the REST health check step properties.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – The type of health check. Required.

  • wait_duration (str) – The duration in ISO 8601 format for which health check waits idly without any checks.

  • max_elastic_duration (str) – The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn’t. Health check starts to enforce healthyStateDuration once resource becomes healthy.

  • healthy_state_duration (str) – The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. Required.

  • health_checks (list[RestHealthCheck]) – The list of checks that form the health check step.

Keyword Arguments

  • wait_duration (str) – The duration in ISO 8601 format for which health check waits idly without any checks.

  • max_elastic_duration (str) – The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn’t. Health check starts to enforce healthyStateDuration once resource becomes healthy.

  • healthy_state_duration (str) – The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal. Required.

  • health_checks (list[RestHealthCheck]) – The list of checks that form the health check step.

class azure.mgmt.deploymentmanager.models.RestMatchQuantifier(value)[source]

Bases: str, enum.Enum

Indicates whether any or all of the expressions should match with the response content.

ALL = 'All'
ANY = 'Any'
class azure.mgmt.deploymentmanager.models.RestRequest(*, method: Union[str, _models.RestRequestMethod], uri: str, authentication: _models.RestRequestAuthentication, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties that make up a REST request.

All required parameters must be populated in order to send to Azure.

Variables

  • method (str or RestRequestMethod) – The HTTP method to use for the request. Required. Known values are: “GET” and “POST”.

  • uri (str) – The HTTP URI to use for the request. Required.

  • authentication (RestRequestAuthentication) – The authentication information required in the request to the health provider. Required.

Keyword Arguments

  • method (str or RestRequestMethod) – The HTTP method to use for the request. Required. Known values are: “GET” and “POST”.

  • uri (str) – The HTTP URI to use for the request. Required.

  • authentication (RestRequestAuthentication) – The authentication information required in the request to the health provider. Required.

class azure.mgmt.deploymentmanager.models.RestRequestAuthentication(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The authentication information required in the REST health check request to the health provider.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ApiKeyAuthentication, RolloutIdentityAuthentication

All required parameters must be populated in order to send to Azure.

Variables

type (str or RestAuthType) – The authentication type. Required. Known values are: “ApiKey” and “RolloutIdentity”.

class azure.mgmt.deploymentmanager.models.RestRequestMethod(value)[source]

Bases: str, enum.Enum

The HTTP method to use for the request.

GET = 'GET'
POST = 'POST'
class azure.mgmt.deploymentmanager.models.RestResponse(*, success_status_codes: Optional[List[str]] = None, regex: Optional[_models.RestResponseRegex] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties that make up the expected REST response.

Variables

  • success_status_codes (list[str]) – The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.

  • regex (RestResponseRegex) – The regular expressions to match the response content with.

Keyword Arguments

  • success_status_codes (list[str]) – The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.

  • regex (RestResponseRegex) – The regular expressions to match the response content with.

class azure.mgmt.deploymentmanager.models.RestResponseRegex(*, matches: Optional[List[str]] = None, match_quantifier: Optional[Union[str, _models.RestMatchQuantifier]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The regular expressions to match the response content with.

Variables

  • matches (list[str]) – The list of regular expressions.

  • match_quantifier (str or RestMatchQuantifier) – Indicates whether any or all of the expressions should match with the response content. Known values are: “All” and “Any”.

Keyword Arguments

  • matches (list[str]) – The list of regular expressions.

  • match_quantifier (str or RestMatchQuantifier) – Indicates whether any or all of the expressions should match with the response content. Known values are: “All” and “Any”.

class azure.mgmt.deploymentmanager.models.Rollout(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.Identity] = None, build_version: Optional[str] = None, artifact_source_id: Optional[str] = None, target_service_topology_id: Optional[str] = None, step_groups: Optional[List[_models.StepGroup]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

Defines the rollout.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (Identity) – Identity for the resource.

  • build_version (str) – The version of the build being deployed.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration.

  • status (str) – The current status of the rollout.

  • total_retry_attempts (int) – The cardinal count of total number of retries performed on the rollout at a given time.

  • operation_info (RolloutOperationInfo) – Operational information of the rollout.

  • services (list[Service]) – The detailed information on the services being deployed.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (Identity) – Identity for the resource.

  • build_version (str) – The version of the build being deployed.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration.

class azure.mgmt.deploymentmanager.models.RolloutIdentityAuthentication(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.RestRequestAuthentication

RolloutIdentity uses the user-assigned managed identity authentication context specified in the Identity property during rollout creation.

All required parameters must be populated in order to send to Azure.

Variables

type (str or RestAuthType) – The authentication type. Required. Known values are: “ApiKey” and “RolloutIdentity”.

class azure.mgmt.deploymentmanager.models.RolloutOperationInfo(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Detailed runtime information of the rollout.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • retry_attempt (int) – The ordinal count of the number of retry attempts on a rollout. 0 if no retries of the rollout have been performed. If the rollout is updated with a PUT, this count is reset to 0.

  • skip_succeeded_on_retry (bool) – True, if all steps that succeeded on the previous run/attempt were chosen to be skipped in this retry attempt. False, otherwise.

  • start_time (datetime) – The start time of the rollout in UTC.

  • end_time (datetime) – The start time of the rollout in UTC. This property will not be set if the rollout has not completed yet.

  • error (CloudErrorBody) – The detailed error information for any failure.

class azure.mgmt.deploymentmanager.models.RolloutProperties(*, build_version: str, target_service_topology_id: str, step_groups: List[_models.StepGroup], artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.RolloutRequestProperties, azure.mgmt.deploymentmanager.models._models_py3.RolloutPropertiesAutoGenerated

The properties that define a rollout.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • status (str) – The current status of the rollout.

  • total_retry_attempts (int) – The cardinal count of total number of retries performed on the rollout at a given time.

  • operation_info (RolloutOperationInfo) – Operational information of the rollout.

  • services (list[Service]) – The detailed information on the services being deployed.

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

Keyword Arguments

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

class azure.mgmt.deploymentmanager.models.RolloutPropertiesAutoGenerated(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Defines the properties of a rollout.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • status (str) – The current status of the rollout.

  • total_retry_attempts (int) – The cardinal count of total number of retries performed on the rollout at a given time.

  • operation_info (RolloutOperationInfo) – Operational information of the rollout.

  • services (list[Service]) – The detailed information on the services being deployed.

class azure.mgmt.deploymentmanager.models.RolloutRequest(*, location: str, identity: _models.Identity, build_version: str, target_service_topology_id: str, step_groups: List[_models.StepGroup], tags: Optional[Dict[str, str]] = None, artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

Defines the PUT rollout request body.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (Identity) – Identity for the resource. Required.

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • identity (Identity) – Identity for the resource. Required.

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

class azure.mgmt.deploymentmanager.models.RolloutRequestProperties(*, build_version: str, target_service_topology_id: str, step_groups: List[_models.StepGroup], artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties for defining a rollout.

All required parameters must be populated in order to send to Azure.

Variables

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

Keyword Arguments

  • build_version (str) – The version of the build being deployed. Required.

  • artifact_source_id (str) – The reference to the artifact source resource Id where the payload is located.

  • target_service_topology_id (str) – The resource Id of the service topology from which service units are being referenced in step groups to be deployed. Required.

  • step_groups (list[StepGroup]) – The list of step groups that define the orchestration. Required.

class azure.mgmt.deploymentmanager.models.RolloutStep(*, name: str, step_group: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Defines a specific step on a target service unit.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – Name of the step. Required.

  • status (str) – Current state of the step.

  • step_group (str) – The step group the current step is part of.

  • operation_info (StepOperationInfo) – Detailed information of specific action execution.

  • resource_operations (list[ResourceOperation]) – Set of resource operations that were performed, if any, on an Azure resource.

  • messages (list[Message]) – Supplementary informative messages during rollout.

Keyword Arguments

  • name (str) – Name of the step. Required.

  • step_group (str) – The step group the current step is part of.

class azure.mgmt.deploymentmanager.models.SasAuthentication(*, sas_uri: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.Authentication

Defines the properties to access the artifacts using an Azure Storage SAS URI.

All required parameters must be populated in order to send to Azure.

Variables

  • type (str) – The authentication type. Required.

  • sas_uri (str) – The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot.

Keyword Arguments

sas_uri (str) – The SAS URI to the Azure Storage blob container. Any offset from the root of the container to where the artifacts are located can be defined in the artifactRoot.

class azure.mgmt.deploymentmanager.models.Service(*, target_location: str, target_subscription_id: str, name: Optional[str] = None, service_units: Optional[List[_models.ServiceUnit]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ServiceProperties

Defines a service.

All required parameters must be populated in order to send to Azure.

Variables

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

  • name (str) – Name of the service.

  • service_units (list[ServiceUnit]) – The detailed information about the units that make up the service.

Keyword Arguments

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

  • name (str) – Name of the service.

  • service_units (list[ServiceUnit]) – The detailed information about the units that make up the service.

class azure.mgmt.deploymentmanager.models.ServiceProperties(*, target_location: str, target_subscription_id: str, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties of a service.

All required parameters must be populated in order to send to Azure.

Variables

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

Keyword Arguments

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

class azure.mgmt.deploymentmanager.models.ServiceResource(*, location: str, target_location: str, target_subscription_id: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

The resource representation of a service in a service topology.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

class azure.mgmt.deploymentmanager.models.ServiceResourceProperties(*, target_location: str, target_subscription_id: str, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ServiceProperties

The properties that define a service in a service topology.

All required parameters must be populated in order to send to Azure.

Variables

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

Keyword Arguments

  • target_location (str) – The Azure location to which the resources in the service belong to or should be deployed to. Required.

  • target_subscription_id (str) – The subscription to which the resources in the service belong to or should be deployed to. Required.

class azure.mgmt.deploymentmanager.models.ServiceTopologyProperties(*, artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties of a service topology.

Variables

artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

Keyword Arguments

artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

class azure.mgmt.deploymentmanager.models.ServiceTopologyResource(*, location: str, tags: Optional[Dict[str, str]] = None, artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

The resource representation of a service topology.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

class azure.mgmt.deploymentmanager.models.ServiceTopologyResourceProperties(*, artifact_source_id: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ServiceTopologyProperties

The properties that define the service topology.

Variables

artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

Keyword Arguments

artifact_source_id (str) – The resource Id of the artifact source that contains the artifacts that can be referenced in the service units.

class azure.mgmt.deploymentmanager.models.ServiceUnit(*, target_resource_group: str, deployment_mode: Union[str, _models.DeploymentMode], artifacts: Optional[_models.ServiceUnitArtifacts] = None, name: Optional[str] = None, steps: Optional[List[_models.RolloutStep]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ServiceUnitProperties

Defines a service unit.

All required parameters must be populated in order to send to Azure.

Variables

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

  • name (str) – Name of the service unit.

  • steps (list[RolloutStep]) – Detailed step information, if present.

Keyword Arguments

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

  • name (str) – Name of the service unit.

  • steps (list[RolloutStep]) – Detailed step information, if present.

class azure.mgmt.deploymentmanager.models.ServiceUnitArtifacts(*, template_uri: Optional[str] = None, parameters_uri: Optional[str] = None, template_artifact_source_relative_path: Optional[str] = None, parameters_artifact_source_relative_path: Optional[str] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Defines the artifacts of a service unit.

Variables

  • template_uri (str) – The full URI of the ARM template file with the SAS token.

  • parameters_uri (str) – The full URI of the ARM parameters file with the SAS token.

  • template_artifact_source_relative_path (str) – The path to the ARM template file relative to the artifact source.

  • parameters_artifact_source_relative_path (str) – The path to the ARM parameters file relative to the artifact source.

Keyword Arguments

  • template_uri (str) – The full URI of the ARM template file with the SAS token.

  • parameters_uri (str) – The full URI of the ARM parameters file with the SAS token.

  • template_artifact_source_relative_path (str) – The path to the ARM template file relative to the artifact source.

  • parameters_artifact_source_relative_path (str) – The path to the ARM parameters file relative to the artifact source.

class azure.mgmt.deploymentmanager.models.ServiceUnitProperties(*, target_resource_group: str, deployment_mode: Union[str, _models.DeploymentMode], artifacts: Optional[_models.ServiceUnitArtifacts] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Defines the properties of a service unit.

All required parameters must be populated in order to send to Azure.

Variables

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

Keyword Arguments

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

class azure.mgmt.deploymentmanager.models.ServiceUnitResource(*, location: str, target_resource_group: str, deployment_mode: Union[str, _models.DeploymentMode], tags: Optional[Dict[str, str]] = None, artifacts: Optional[_models.ServiceUnitArtifacts] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

Represents the response of a service unit resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

class azure.mgmt.deploymentmanager.models.ServiceUnitResourceProperties(*, target_resource_group: str, deployment_mode: Union[str, _models.DeploymentMode], artifacts: Optional[_models.ServiceUnitArtifacts] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.ServiceUnitProperties

The properties that define the service unit.

All required parameters must be populated in order to send to Azure.

Variables

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

Keyword Arguments

  • target_resource_group (str) – The Azure Resource Group to which the resources in the service unit belong to or should be deployed to. Required.

  • deployment_mode (str or DeploymentMode) – Describes the type of ARM deployment to be performed on the resource. Required. Known values are: “Incremental” and “Complete”.

  • artifacts (ServiceUnitArtifacts) – The artifacts for the service unit.

class azure.mgmt.deploymentmanager.models.StepGroup(*, name: str, deployment_target_id: str, depends_on_step_groups: Optional[List[str]] = None, pre_deployment_steps: Optional[List[_models.PrePostStep]] = None, post_deployment_steps: Optional[List[_models.PrePostStep]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties that define a Step group in a rollout.

All required parameters must be populated in order to send to Azure.

Variables

  • name (str) – The name of the step group. Required.

  • depends_on_step_groups (list[str]) – The list of step group names on which this step group depends on.

  • pre_deployment_steps (list[PrePostStep]) – The list of steps to be run before deploying the target.

  • deployment_target_id (str) – The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId. Required.

  • post_deployment_steps (list[PrePostStep]) – The list of steps to be run after deploying the target.

Keyword Arguments

  • name (str) – The name of the step group. Required.

  • depends_on_step_groups (list[str]) – The list of step group names on which this step group depends on.

  • pre_deployment_steps (list[PrePostStep]) – The list of steps to be run before deploying the target.

  • deployment_target_id (str) – The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId. Required.

  • post_deployment_steps (list[PrePostStep]) – The list of steps to be run after deploying the target.

class azure.mgmt.deploymentmanager.models.StepOperationInfo(*, error: Optional[_models.CloudErrorBody] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

Detailed information of a specific step run.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

  • deployment_name (str) – The name of the ARM deployment initiated as part of the step.

  • correlation_id (str) – Unique identifier to track the request for ARM-based resources.

  • start_time (datetime) – Start time of the action in UTC.

  • end_time (datetime) – End time of the action in UTC.

  • last_updated_time (datetime) – Last time in UTC this operation was updated.

  • error (CloudErrorBody) – The errors, if any, for the action.

Keyword Arguments

error (CloudErrorBody) – The errors, if any, for the action.

class azure.mgmt.deploymentmanager.models.StepProperties(**kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The properties of a step resource.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: HealthCheckStepProperties, WaitStepProperties

All required parameters must be populated in order to send to Azure.

Variables

step_type (str or StepType) – The type of step. Required. Known values are: “Wait” and “HealthCheck”.

class azure.mgmt.deploymentmanager.models.StepResource(*, location: str, properties: _models.StepProperties, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.TrackedResource

The resource representation of a rollout step.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (StepProperties) – The properties that define the step. Required.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

  • properties (StepProperties) – The properties that define the step. Required.

class azure.mgmt.deploymentmanager.models.StepType(value)[source]

Bases: str, enum.Enum

The type of step.

HEALTH_CHECK = 'HealthCheck'
WAIT = 'Wait'
class azure.mgmt.deploymentmanager.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.Resource

The resource model definition for an Azure Resource Manager tracked top level resource which has ‘tags’ and a ‘location’.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

  • id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

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

  • type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

Keyword Arguments

  • tags (dict[str, str]) – Resource tags.

  • location (str) – The geo-location where the resource lives. Required.

class azure.mgmt.deploymentmanager.models.WaitStepAttributes(*, duration: str, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager._serialization.Model

The parameters for the wait step.

All required parameters must be populated in order to send to Azure.

Variables

duration (str) – The duration in ISO 8601 format of how long the wait should be. Required.

Keyword Arguments

duration (str) – The duration in ISO 8601 format of how long the wait should be. Required.

class azure.mgmt.deploymentmanager.models.WaitStepProperties(*, attributes: _models.WaitStepAttributes, **kwargs)[source]

Bases: azure.mgmt.deploymentmanager.models._models_py3.StepProperties

Defines the properties of a Wait step.

All required parameters must be populated in order to send to Azure.

Variables

  • step_type (str or StepType) – The type of step. Required. Known values are: “Wait” and “HealthCheck”.

  • attributes (WaitStepAttributes) – The Wait attributes. Required.

Keyword Arguments

attributes (WaitStepAttributes) – The Wait attributes. Required.