Deployments - Get

Gets a deployment.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2019-10-01

URI Parameters

Name In Required Type Description
deploymentName
path True
  • string

The name of the deployment.

Regex pattern: ^[-\w\._\(\)]+$

resourceGroupName
path True
  • string

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

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

OK - Returns information about the deployment, including provisioning status.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

Alias

The alias type.

AliasPath

The type of the paths for alias.

AliasPattern

The type of the pattern for an alias path.

AliasPatternType

The type of alias pattern

AliasType

The type of the alias.

BasicDependency

Deployment dependency information.

CloudError

An error response for a resource management request.

DebugSetting

The debug setting.

Dependency

Deployment dependency information.

DeploymentExtended

Deployment information.

DeploymentMode

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

DeploymentPropertiesExtended

Deployment properties with additional details.

ErrorAdditionalInfo

The resource management error additional info.

ErrorResponse

The resource management error response.

OnErrorDeploymentExtended

Deployment on error behavior with additional details.

OnErrorDeploymentType

The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

ParametersLink

Entity representing the reference to the deployment parameters.

Provider

Resource provider information.

ProviderResourceType

Resource type managed by the resource provider.

ResourceReference

The resource Id model.

TemplateLink

Entity representing the reference to the template.

Alias

The alias type.

Name Type Description
defaultPath
  • string

The default path for an alias.

defaultPattern

The default pattern for an alias.

name
  • string

The alias name.

paths

The paths for an alias.

type

The type of the alias.

AliasPath

The type of the paths for alias.

Name Type Description
apiVersions
  • string[]

The API versions.

path
  • string

The path of an alias.

pattern

The pattern for an alias path.

AliasPattern

The type of the pattern for an alias path.

Name Type Description
phrase
  • string

The alias pattern phrase.

type

The type of alias pattern

variable
  • string

The alias pattern variable.

AliasPatternType

The type of alias pattern

Name Type Description
Extract
  • string

Extract is the only allowed value.

NotSpecified
  • string

NotSpecified is not allowed.

AliasType

The type of the alias.

Name Type Description
Mask
  • string

Alias value is secret.

NotSpecified
  • string

Alias type is unknown (same as not providing alias type).

PlainText
  • string

Alias value is not secret.

BasicDependency

Deployment dependency information.

Name Type Description
id
  • string

The ID of the dependency.

resourceName
  • string

The dependency resource name.

resourceType
  • string

The dependency resource type.

CloudError

An error response for a resource management request.

Name Type Description
error

The resource management error response.

DebugSetting

The debug setting.

Name Type Description
detailLevel
  • string

Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations.

Dependency

Deployment dependency information.

Name Type Description
dependsOn

The list of dependencies.

id
  • string

The ID of the dependency.

resourceName
  • string

The dependency resource name.

resourceType
  • string

The dependency resource type.

DeploymentExtended

Deployment information.

Name Type Description
id
  • string

The ID of the deployment.

location
  • string

the location of the deployment.

name
  • string

The name of the deployment.

properties

Deployment properties.

tags
  • object

Deployment tags

type
  • string

The type of the deployment.

DeploymentMode

The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentPropertiesExtended

Deployment properties with additional details.

Name Type Description
correlationId
  • string

The correlation ID of the deployment.

debugSetting

The debug setting of the deployment.

dependencies

The list of deployment dependencies.

duration
  • string

The duration of the template deployment.

error

The deployment error.

mode

The deployment mode. Possible values are Incremental and Complete.

onErrorDeployment

The deployment on error behavior.

outputResources

Array of provisioned resources.

outputs
  • object

Key/value pairs that represent deployment output.

parameters
  • object

Deployment parameters.

parametersLink

The URI referencing the parameters.

providers

The list of resource providers needed for the deployment.

provisioningState
  • string

The state of the provisioning.

templateHash
  • string

The hash produced for the template.

templateLink

The URI referencing the template.

timestamp
  • string

The timestamp of the template deployment.

validatedResources

Array of validated resources.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorResponse

The resource management error response.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

OnErrorDeploymentExtended

Deployment on error behavior with additional details.

Name Type Description
deploymentName
  • string

The deployment to be used on error case.

provisioningState
  • string

The state of the provisioning for the on error deployment.

type

The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

OnErrorDeploymentType

The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

Entity representing the reference to the deployment parameters.

Name Type Description
contentVersion
  • string

If included, must match the ContentVersion in the template.

uri
  • string

The URI of the parameters file.

Provider

Resource provider information.

Name Type Description
id
  • string

The provider ID.

namespace
  • string

The namespace of the resource provider.

registrationPolicy
  • string

The registration policy of the resource provider.

registrationState
  • string

The registration state of the resource provider.

resourceTypes

The collection of provider resource types.

ProviderResourceType

Resource type managed by the resource provider.

Name Type Description
aliases

The aliases that are supported by this resource type.

apiVersions
  • string[]

The API version.

capabilities
  • string

The additional capabilities offered by this resource type.

locations
  • string[]

The collection of locations where this resource type can be created.

properties
  • object

The properties.

resourceType
  • string

The resource type.

ResourceReference

The resource Id model.

Name Type Description
id
  • string

The fully qualified resource Id.

Entity representing the reference to the template.

Name Type Description
contentVersion
  • string

If included, must match the ContentVersion in the template.

uri
  • string

The URI of the template to deploy.