Share via

Deployments - Get At Scope

  • Reference
Service:
Resource Management
API Version:
2021-04-01

Gets a deployment.

GET https://management.azure.com/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI Parameters

Name In Required Type Description
deploymentName
 path True

string

The name of the deployment.

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

string

The resource scope.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

DeploymentExtended

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

CloudError

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

Name Description
Alias

The alias type.
AliasPath

The type of the paths for alias.
AliasPathAttributes

The attributes of the token that the alias path is referring to.
AliasPathMetadata
AliasPathTokenType

The type of the token that the alias path is referring to.
AliasPattern

The type of the pattern for an alias path.
AliasPatternType

The type of alias pattern
AliasType

The type of the alias.
ApiProfile
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

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

The provider authorization consent state.
ProviderExtendedLocation

The provider extended location.
ProviderResourceType

Resource type managed by the resource provider.
ProvisioningState

Denotes the state of provisioning.
ResourceReference

The resource Id model.
TemplateLink

Entity representing the reference to the template.
ZoneMapping

Alias

The alias type.

Name Type Description
defaultMetadata

AliasPathMetadata

The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata
defaultPath

string

The default path for an alias.
defaultPattern

AliasPattern

The default pattern for an alias.
name

string

The alias name.
paths

AliasPath[]

The paths for an alias.
type

AliasType

The type of the alias.

AliasPath

The type of the paths for alias.

Name Type Description
apiVersions

string[]

The API versions.
metadata

AliasPathMetadata

The metadata of the alias path. If missing, fall back to the default metadata of the alias.
path

string

The path of an alias.
pattern

AliasPattern

The pattern for an alias path.

AliasPathAttributes

The attributes of the token that the alias path is referring to.

Name Type Description
Modifiable

string

The token that the alias path is referring to is modifiable by policies with 'modify' effect.
None

string

The token that the alias path is referring to has no attributes.

AliasPathMetadata

Name Type Description
attributes

AliasPathAttributes

The attributes of the token that the alias path is referring to.
type

AliasPathTokenType

The type of the token that the alias path is referring to.

AliasPathTokenType

The type of the token that the alias path is referring to.

Name Type Description
Any

string

The token type can be anything.
Array

string

The token type is array.
Boolean

string

The token type is boolean.
Integer

string

The token type is integer.
NotSpecified

string

The token type is not specified.
Number

string

The token type is number.
Object

string

The token type is object.
String

string

The token type is string.

AliasPattern

The type of the pattern for an alias path.

Name Type Description
phrase

string

The alias pattern phrase.
type

AliasPatternType

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.

ApiProfile

Name Type Description
apiVersion

string

The API version.
profileVersion

string

The profile version.

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

ErrorResponse

Error Response
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

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

BasicDependency[]

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

DeploymentPropertiesExtended

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

DebugSetting

The debug setting of the deployment.
dependencies

Dependency[]

The list of deployment dependencies.
duration

string

The duration of the template deployment.
error

ErrorResponse

Error Response
The deployment error.
mode

DeploymentMode

The deployment mode. Possible values are Incremental and Complete.
onErrorDeployment

OnErrorDeploymentExtended

The deployment on error behavior.
outputResources

ResourceReference[]

Array of provisioned resources.
outputs

object

Key/value pairs that represent deployment output.
parameters

object

Deployment parameters.
parametersLink

ParametersLink

The URI referencing the parameters.
providers

Provider[]

The list of resource providers needed for the deployment.
provisioningState

ProvisioningState

Denotes the state of provisioning.
templateHash

string

The hash produced for the template.
templateLink

TemplateLink

The URI referencing the template.
timestamp

string

The timestamp of the template deployment.
validatedResources

ResourceReference[]

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

Error Response

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorResponse[]

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

OnErrorDeploymentType

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

ProviderAuthorizationConsentState

The provider authorization consent state.
registrationPolicy

string

The registration policy of the resource provider.
registrationState

string

The registration state of the resource provider.
resourceTypes

ProviderResourceType[]

The collection of provider resource types.

ProviderAuthorizationConsentState

The provider authorization consent state.

Name Type Description
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

The provider extended location.

Name Type Description
extendedLocations

string[]

The extended locations for the azure location.
location

string

The azure location.
type

string

The extended location type.

ProviderResourceType

Resource type managed by the resource provider.

Name Type Description
aliases

Alias[]

The aliases that are supported by this resource type.
apiProfiles

ApiProfile[]

The API profiles for the resource provider.
apiVersions

string[]

The API version.
capabilities

string

The additional capabilities offered by this resource type.
defaultApiVersion

string

The default API version.
locationMappings

ProviderExtendedLocation[]

The location mappings that are supported 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.
zoneMappings

ZoneMapping[]

ProvisioningState

Denotes the state of provisioning.

Name Type Description
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

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

string

The resource id of a Template Spec. Use either the id or uri property, but not both.
queryString

string

The query string (for example, a SAS token) to be used with the templateLink URI.
relativePath

string

The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs
uri

string

The URI of the template to deploy. Use either the uri or id property, but not both.

ZoneMapping

Name Type Description
location

string

The location of the zone mapping.
zones

string[]