Microsoft.Resources (stable:2024-11-01)

2024/12/10 • 95 new methods

Operations_List (new)
Description :  Lists all of the available Microsoft.Resources REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Microsoft.Resources operations. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Resources ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtScope (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_GetAtScope (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtScope (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListAtScope (new)
Description :  Get all the deployments at the given scope.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtTenantScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtTenantScope (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtTenantScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_GetAtTenantScope (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtTenantScope (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtTenantScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIfAtTenantScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the tenant group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtTenantScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListAtTenantScope (new)
Description :  Get all the deployments at the tenant scope.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/
{
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtManagementGroupScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtManagementGroupScope (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtManagementGroupScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_GetAtManagementGroupScope (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtManagementGroupScope (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtManagementGroupScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIfAtManagementGroupScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the management group.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: True ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtManagementGroupScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListAtManagementGroupScope (new)
Description :  Get all the deployments for a management group.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_DeleteAtSubscriptionScope (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtSubscriptionScope (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdateAtSubscriptionScope (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_GetAtSubscriptionScope (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CancelAtSubscriptionScope (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ValidateAtSubscriptionScope (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIfAtSubscriptionScope (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the subscription.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to What If. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtSubscriptionScope (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListAtSubscriptionScope (new)
Description :  Get all the deployments for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/
{
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Delete (new)
Description :  A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group with the deployment to delete. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CheckExistence (new)
Description :  Checks whether the deployment exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group with the deployment to check. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CreateOrUpdate (new)
Description :  You can provide the template and parameters directly in the request or link to JSON files.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Additional parameters supplied to the operation. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Get (new)
Description :  Gets a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Cancel (new)
Description :  You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_Validate (new)
Description :  Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate
{
resourceGroupName:
{
Description: The name of the resource group the template will be deployed to. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
template:
{
Description: The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
object ,
templateLink:
{
Description: The URI of the template. Use either the templateLink property or the template property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: 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. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: True ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
expressionEvaluationOptions:
{
Description: Specifies whether template expressions are evaluated within the scope of the parent template or nested template. Only applicable to nested templates. If not specified, default value is outer. ,
Required: False ,
}
{
scope:
{
Description: The scope to be used for evaluation of parameters, variables and functions in a nested template. ,
Enum:
{
NotSpecified: No description available. ,
Outer: No description available. ,
Inner: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_WhatIf (new)
Description :  Returns changes that will be made by the deployment if executed at the scope of the resource group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf
{
resourceGroupName:
{
Description: The name of the resource group the template will be deployed to. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters to validate. ,
Required: True ,
}
{
location:
{
Description: The location to store the deployment data. ,
Required: False ,
}
string ,
properties:
{
Description: The deployment properties. ,
Required: True ,
}
{
whatIfSettings:
{
Description: Optional What-If operation settings. ,
Required: False ,
}
{
resultFormat:
{
Description: The format of the What-If results ,
Enum:
{
ResourceIdOnly: No description available. ,
FullResourcePayloads: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Status of the What-If operation. ,
Required: False ,
}
string ,
properties:
{
Description: What-If operation properties. ,
Required: False ,
}
{
changes:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
potentialChanges:
{
Description: List of resource changes predicted by What-If operation. ,
Required: False ,
}
[
{
resourceId:
{
Description: Resource ID ,
Required: True ,
}
string ,
deploymentId:
{
Description: The resource id of the Deployment responsible for this change. ,
Required: False ,
}
string ,
symbolicName:
{
Description: The symbolic name of the resource responsible for this change. ,
Required: False ,
}
string ,
identifiers:
{
Description: A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has. ,
Required: False ,
}
object ,
changeType:
{
Description: Type of change that will be made to the resource when the deployment is executed. ,
Enum:
{
Create: The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed. ,
Delete: The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed. ,
Ignore: The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed. ,
Deploy: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change. ,
NoChange: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change. ,
Modify: The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change. ,
Unsupported: The resource is not supported by What-If. ,
}
,
Required: True ,
}
enum ,
unsupportedReason:
{
Description: The explanation about why the resource is unsupported by What-If. ,
Required: False ,
}
string ,
before:
{
Description: The snapshot of the resource before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The predicted snapshot of the resource after the deployment is executed. ,
Required: False ,
}
object ,
delta:
{
Description: The predicted changes to resource properties. ,
Required: False ,
}
[
{
path:
{
Description: The path of the property. ,
Required: True ,
}
string ,
propertyChangeType:
{
Description: The type of property change. ,
Enum:
{
Create: The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed. ,
Delete: The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed. ,
Modify: The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed. ,
Array: The property is an array and contains nested changes. ,
NoEffect: The property will not be set or updated. ,
}
,
Required: True ,
}
enum ,
before:
{
Description: The value of the property before the deployment is executed. ,
Required: False ,
}
object ,
after:
{
Description: The value of the property after the deployment is executed. ,
Required: False ,
}
object ,
children:
{
Description: Nested property changes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
diagnostics:
{
Description: List of resource diagnostics detected by What-If operation. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
}
,
error:
{
Description: Error when What-If operation fails. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
retry-after:
{
Description: Number of seconds to wait before polling for status. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ExportTemplate (new)
Description :  Exports the template used for specified deployment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
template:
{
Description: The template content. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_ListByResourceGroup (new)
Description :  Get all the deployments for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/
{
resourceGroupName:
{
Description: The name of the resource group with the deployments to get. The name is case insensitive. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to get. If null is passed, returns all deployments. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployments. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the deployment. ,
Required: False ,
}
string ,
name:
{
Description: The name of the deployment. ,
Required: False ,
}
string ,
type:
{
Description: The type of the deployment. ,
Required: False ,
}
string ,
location:
{
Description: the location of the deployment. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Denotes the state of provisioning. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Updating: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: The correlation ID of the deployment. ,
Required: False ,
}
string ,
timestamp:
{
Description: The timestamp of the template deployment. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the template deployment. ,
Required: False ,
}
string ,
outputs:
{
Description: Key/value pairs that represent deployment output. ,
Required: False ,
}
object ,
providers:
{
Description: The list of resource providers needed for the deployment. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
dependencies:
{
Description: The list of deployment dependencies. ,
Required: False ,
}
[
{
dependsOn:
{
Description: The list of dependencies. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
id:
{
Description: The ID of the dependency. ,
Required: False ,
}
string ,
resourceType:
{
Description: The dependency resource type. ,
Required: False ,
}
string ,
resourceName:
{
Description: The dependency resource name. ,
Required: False ,
}
string ,
}
,
]
,
templateLink:
{
Description: The URI referencing the template. ,
Required: False ,
}
{
uri:
{
Description: The URI of the template to deploy. Use either the uri or id property, but not both. ,
Required: False ,
}
string ,
id:
{
Description: The resource id of a Template Spec. Use either the id or uri property, but not both. ,
Required: False ,
}
string ,
relativePath:
{
Description: 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 ,
Required: False ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
queryString:
{
Description: The query string (for example, a SAS token) to be used with the templateLink URI. ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Deployment parameters. ,
Required: False ,
}
object ,
parametersLink:
{
Description: The URI referencing the parameters. ,
Required: False ,
}
{
uri:
{
Description: The URI of the parameters file. ,
Required: True ,
}
string ,
contentVersion:
{
Description: If included, must match the ContentVersion in the template. ,
Required: False ,
}
string ,
}
,
mode:
{
Description: The deployment mode. Possible values are Incremental and Complete. ,
Enum:
{
Incremental: No description available. ,
Complete: No description available. ,
}
,
Required: False ,
}
enum ,
debugSetting:
{
Description: The debug setting of the deployment. ,
Required: False ,
}
{
detailLevel:
{
Description: 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. ,
Required: False ,
}
string ,
}
,
onErrorDeployment:
{
Description: The deployment on error behavior. ,
Required: False ,
}
{
provisioningState:
{
Description: The state of the provisioning for the on error deployment. ,
Required: False ,
}
string ,
type:
{
Description: The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. ,
Enum:
{
LastSuccessful: No description available. ,
SpecificDeployment: No description available. ,
}
,
Required: False ,
}
enum ,
deploymentName:
{
Description: The deployment to be used on error case. ,
Required: False ,
}
string ,
}
,
templateHash:
{
Description: The hash produced for the template. ,
Required: False ,
}
string ,
outputResources:
{
Description: Array of provisioned resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
validatedResources:
{
Description: Array of validated resources. ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified resource Id. ,
Required: False ,
}
string ,
}
,
]
,
error:
{
Description: The deployment error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
diagnostics:
{
Description: Contains diagnostic information collected during validation process. ,
Required: False ,
}
[
{
level:
{
Description: Denotes the additional response level. ,
Enum:
{
Warning: No description available. ,
Info: No description available. ,
Error: No description available. ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The error code. ,
Required: True ,
}
string ,
message:
{
Description: The error message. ,
Required: True ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
validationLevel:
{
Description: The validation level of the deployment ,
Enum:
{
Template: Static analysis of the template is performed. ,
Provider: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Validates that the caller has RBAC write permissions on each resource. ,
ProviderNoRbac: Static analysis of the template is performed and resource declarations are sent to resource providers for semantic validation. Skips validating that the caller has RBAC write permissions on each resource. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Deployment tags ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_Unregister (new)
Description :  Unregisters a subscription from a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to unregister. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_RegisterAtManagementGroupScope (new)
Description :  Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to register. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_ProviderPermissions (new)
Description :  Get the provider permissions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/providerPermissions
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of provider permissions. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application id. ,
Required: False ,
}
string ,
roleDefinition:
{
Description: Role definition properties. ,
Required: False ,
}
{
id:
{
Description: The role definition ID. ,
Required: False ,
}
string ,
name:
{
Description: The role definition name. ,
Required: False ,
}
string ,
isServiceRole:
{
Description: If this is a service role. ,
Required: False ,
}
boolean ,
permissions:
{
Description: Role definition permissions. ,
Required: False ,
}
[
{
actions:
{
Description: Allowed actions. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: Denied actions. ,
Required: False ,
}
[
string ,
]
,
dataActions:
{
Description: Allowed Data actions. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: Denied Data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scopes:
{
Description: Role definition assignable scopes. ,
Required: False ,
}
[
string ,
]
,
}
,
managedByRoleDefinition:
{
Description: Role definition properties. ,
Required: False ,
}
{
id:
{
Description: The role definition ID. ,
Required: False ,
}
string ,
name:
{
Description: The role definition name. ,
Required: False ,
}
string ,
isServiceRole:
{
Description: If this is a service role. ,
Required: False ,
}
boolean ,
permissions:
{
Description: Role definition permissions. ,
Required: False ,
}
[
{
actions:
{
Description: Allowed actions. ,
Required: False ,
}
[
string ,
]
,
notActions:
{
Description: Denied actions. ,
Required: False ,
}
[
string ,
]
,
dataActions:
{
Description: Allowed Data actions. ,
Required: False ,
}
[
string ,
]
,
notDataActions:
{
Description: Denied Data actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scopes:
{
Description: Role definition assignable scopes. ,
Required: False ,
}
[
string ,
]
,
}
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_Register (new)
Description :  Registers a subscription with a resource provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register
{
resourceProviderNamespace:
{
Description: The namespace of the resource provider to register. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
properties:
{
Description: The third party consent for S2S. ,
Required: False ,
}
{
thirdPartyProviderConsent:
{
Description: The provider consent. ,
Required: False ,
}
{
consentToAuthorization:
{
Description: A value indicating whether authorization is consented or not. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_List (new)
Description :  Gets all resource providers for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers
{
$expand:
{
Description: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_ListAtTenantScope (new)
Description :  Gets all resource providers for the tenant.
Reference :  Link ¶

⚼ Request

GET:  /providers
{
$expand:
{
Description: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource providers. ,
Required: False ,
}
[
{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_Get (new)
Description :  Gets the specified resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderResourceTypes_List (new)
Description :  List the resource types for a specified resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes
{
$expand:
{
Description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Providers_GetAtTenantScope (new)
Description :  Gets the specified resource provider at the tenant level.
Reference :  Link ¶

⚼ Request

GET:  /providers/{resourceProviderNamespace}
{
$expand:
{
Description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. ,
Required: False ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The provider ID. ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace of the resource provider. ,
Required: False ,
}
string ,
registrationState:
{
Description: The registration state of the resource provider. ,
Required: False ,
}
string ,
registrationPolicy:
{
Description: The registration policy of the resource provider. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The collection of provider resource types. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
locations:
{
Description: The collection of locations where this resource type can be created. ,
Required: False ,
}
[
string ,
]
,
locationMappings:
{
Description: The location mappings that are supported by this resource type. ,
Required: False ,
}
[
{
location:
{
Description: The azure location. ,
Required: False ,
}
string ,
type:
{
Description: The extended location type. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations for the azure location. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
aliases:
{
Description: The aliases that are supported by this resource type. ,
Required: False ,
}
[
{
name:
{
Description: The alias name. ,
Required: False ,
}
string ,
paths:
{
Description: The paths for an alias. ,
Required: False ,
}
[
{
path:
{
Description: The path of an alias. ,
Required: False ,
}
string ,
apiVersions:
{
Description: The API versions. ,
Required: False ,
}
[
string ,
]
,
pattern:
{
Description: The pattern for an alias path. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
metadata:
{
Description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
type:
{
Description: The type of the alias. ,
Enum:
{
NotSpecified: Alias type is unknown (same as not providing alias type). ,
PlainText: Alias value is not secret. ,
Mask: Alias value is secret. ,
}
,
Required: False ,
}
enum ,
defaultPath:
{
Description: The default path for an alias. ,
Required: False ,
}
string ,
defaultPattern:
{
Description: The default pattern for an alias. ,
Required: False ,
}
{
phrase:
{
Description: The alias pattern phrase. ,
Required: False ,
}
string ,
variable:
{
Description: The alias pattern variable. ,
Required: False ,
}
string ,
type:
{
Description: The type of alias pattern ,
Enum:
{
NotSpecified: NotSpecified is not allowed. ,
Extract: Extract is the only allowed value. ,
}
,
Required: False ,
}
enum ,
}
,
defaultMetadata:
{
Description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata ,
Required: False ,
}
{
type:
{
Description: The type of the token that the alias path is referring to. ,
Enum:
{
NotSpecified: The token type is not specified. ,
Any: The token type can be anything. ,
String: The token type is string. ,
Object: The token type is object. ,
Array: The token type is array. ,
Integer: The token type is integer. ,
Number: The token type is number. ,
Boolean: The token type is boolean. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: The attributes of the token that the alias path is referring to. ,
Enum:
{
None: The token that the alias path is referring to has no attributes. ,
Modifiable: The token that the alias path is referring to is modifiable by policies with 'modify' effect. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
apiVersions:
{
Description: The API version. ,
Required: False ,
}
[
string ,
]
,
defaultApiVersion:
{
Description: The default API version. ,
Required: False ,
}
string ,
zoneMappings:
{
Required: False ,
}
[
{
location:
{
Description: The location of the zone mapping. ,
Required: False ,
}
string ,
zones:
{
Required: False ,
}
[
string ,
]
,
}
,
]
,
apiProfiles:
{
Description: The API profiles for the resource provider. ,
Required: False ,
}
[
{
profileVersion:
{
Description: The profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: The API version. ,
Required: False ,
}
string ,
}
,
]
,
capabilities:
{
Description: The additional capabilities offered by this resource type. ,
Required: False ,
}
string ,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
providerAuthorizationConsentState:
{
Description: The provider authorization consent state. ,
Enum:
{
NotSpecified: No description available. ,
Required: No description available. ,
NotRequired: No description available. ,
Consented: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_ListByResourceGroup (new)
Description :  Get all the resources for a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources
{
resourceGroupName:
{
Description: The resource group with the resources to get. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resources. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_CheckExistence (new)
Description :  Checks whether a resource group exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to check. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_CreateOrUpdate (new)
Description :  Creates or updates a resource group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update a resource group. ,
Required: True ,
}
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_Delete (new)
Description :  When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to delete. The name is case insensitive. ,
Required: True ,
}
string ,
forceDeletionTypes:
{
Description: The resource types you want to force delete. Currently, only the following is supported: forceDeletionTypes=Microsoft.Compute/virtualMachines,Microsoft.Compute/virtualMachineScaleSets ,
Required: False ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_Get (new)
Description :  Gets a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to get. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_Update (new)
Description :  Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}
{
resourceGroupName:
{
Description: The name of the resource group to update. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to update a resource group. ,
Required: True ,
}
{
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_ExportTemplate (new)
Description :  Captures the specified resource group as a template.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate
{
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for exporting the template. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'. ,
Required: False ,
}
[
string ,
]
,
options:
{
Description: The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization' ,
Required: False ,
}
string ,
outputFormat:
{
Description: The output format for the exported resources. ,
Enum:
{
Json: No description available. ,
Bicep: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
template:
{
Description: The template content. Used if outputFormat is empty or set to 'Json'. ,
Required: False ,
}
object ,
output:
{
Description: The formatted export content. Used if outputFormat is set to 'Bicep'. ,
Required: False ,
}
string ,
error:
{
Description: The template export error. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGroups_List (new)
Description :  Gets all the resource groups for a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups
{
$filter:
{
Description: The filter to apply on the operation.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1' ,
Required: False ,
}
string ,
$top:
{
Description: The number of results to return. If null is passed, returns all resource groups. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resource groups. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the resource group. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource group. ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource group. ,
Required: False ,
}
string ,
properties:
{
Description: The resource group properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Required: False ,
}
string ,
}
,
location:
{
Description: The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations. ,
Required: True ,
}
string ,
managedBy:
{
Description: The ID of the resource that manages this resource group. ,
Required: False ,
}
string ,
tags:
{
Description: The tags attached to the resource group. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_MoveResources (new)
Description :  The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group from the source subscription containing the resources to be moved. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_ValidateMoveResources (new)
Description :  This operation checks whether the specified resources can be moved to the target. The resources to be moved must be in the same source resource group in the source subscription being used. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources
{
sourceResourceGroupName:
{
Description: The name of the resource group from the source subscription containing the resources to be validated for move. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for moving resources. ,
Required: True ,
}
{
resources:
{
Description: The IDs of the resources. ,
Required: False ,
}
[
string ,
]
,
targetResourceGroup:
{
Description: The target resource group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_List (new)
Description :  Get all the resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resources
{
$filter:
{
Description: The filter to apply on the operation.

Filter comparison operators include `eq` (equals) and `ne` (not equals) and may be used with the following properties: `location`, `resourceType`, `name`, `resourceGroup`, `identity`, `identity/principalId`, `plan`, `plan/publisher`, `plan/product`, `plan/name`, `plan/version`, and `plan/promotionCode`.

For example, to filter by a resource type, use `$filter=resourceType eq 'Microsoft.Network/virtualNetworks'`


`substringof(value, property)` can be used to filter for substrings of the following currently-supported properties: `name` and `resourceGroup`

For example, to get all resources with 'demo' anywhere in the resource name, use `$filter=substringof('demo', name)`

Multiple substring operations can also be combined using `and`/`or` operators.

Note that any truncated number of results queried via `$top` may also not be compatible when using a filter.


Resources can be filtered by tag names and values. For example, to filter for a tag name and value, use `$filter=tagName eq 'tag1' and tagValue eq 'Value1'`. Note that when resources are filtered by tag name and value, the original tags for each resource will not be returned in the results. Any list of additional properties queried via `$expand` may also not be compatible when filtering by tag names/values.

For tag names only, resources can be filtered by prefix using the following syntax: `$filter=startswith(tagName, 'depart')`. This query will return all resources with a tag name prefixed by the phrase `depart` (i.e.`department`, `departureDate`, `departureTime`, etc.)


Note that some properties can be combined when filtering resources, which include the following: `substringof() and/or resourceType`, `plan and plan/publisher and plan/name`, and `identity and identity/principalId`. ,
Required: False ,
}
string ,
$expand:
{
Description: Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`. ,
Required: False ,
}
string ,
$top:
{
Description: The number of recommendations per page if a paged version of this API is being used. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of resources. ,
Required: False ,
}
[
{
createdTime:
{
Description: The created time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time of the resource. This is only present if requested via the $expand query parameter. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. This is only present if requested via the $expand query parameter. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_CheckExistence (new)
Description :  Checks whether a resource exists.
Reference :  Link ¶

⚼ Request

HEAD:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to check. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The resource provider of the resource to check. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to check whether it exists. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_Delete (new)
Description :  Deletes a resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group that contains the resource to delete. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_CreateOrUpdate (new)
Description :  Creates a resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to create. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for creating or updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_Update (new)
Description :  Updates a resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group for the resource. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource to update. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to update. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for updating the resource. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_Get (new)
Description :  Gets a resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}
{
resourceGroupName:
{
Description: The name of the resource group containing the resource to get. The name is case insensitive. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourcePath:
{
Description: The parent resource identity. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type of the resource. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_CheckExistenceById (new)
Description :  Checks by ID whether a resource exists. This API currently works only for a limited set of Resource providers. In the event that a Resource provider does not implement this API, ARM will respond with a 405. The alternative then is to use the GET API to check for the existence of the resource.
Reference :  Link ¶

⚼ Request

HEAD:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_DeleteById (new)
Description :  Deletes a resource by ID.
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_CreateOrUpdateById (new)
Description :  Create a resource by ID.
Reference :  Link ¶

⚼ Request

PUT:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_UpdateById (new)
Description :  Updates a resource by ID.
Reference :  Link ¶

⚼ Request

PATCH:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
parameters:
{
Description: Update resource parameters. ,
Required: True ,
}
{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Resources_GetById (new)
Description :  Gets a resource by ID.
Reference :  Link ¶

⚼ Request

GET:  /{resourceId}
{
resourceId:
{
Description: The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name} ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
plan:
{
Description: The plan of the resource. ,
Required: False ,
}
{
name:
{
Description: The plan ID. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher ID. ,
Required: False ,
}
string ,
product:
{
Description: The offer ID. ,
Required: False ,
}
string ,
promotionCode:
{
Description: The promotion code. ,
Required: False ,
}
string ,
version:
{
Description: The plan's version. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource properties. ,
Required: False ,
}
object ,
kind:
{
Description: The kind of the resource. ,
Required: False ,
}
string ,
managedBy:
{
Description: ID of the resource that manages this resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the resource. ,
Required: False ,
}
{
name:
{
Description: The SKU name. ,
Required: False ,
}
string ,
tier:
{
Description: The SKU tier. ,
Required: False ,
}
string ,
size:
{
Description: The SKU size. ,
Required: False ,
}
string ,
family:
{
Description: The SKU family. ,
Required: False ,
}
string ,
model:
{
Description: The SKU model. ,
Required: False ,
}
string ,
capacity:
{
Description: The SKU capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned, UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_DeleteValue (new)
Description :  This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to delete. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_CreateOrUpdateValue (new)
Description :  This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
tagValue:
{
Description: The value of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag value ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The tag value ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_CreateOrUpdate (new)
Description :  This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag to create. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The tag name ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag value ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (201)

{
id:
{
Description: The tag name ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag value ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_Delete (new)
Description :  This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/tagNames/{tagName}
{
tagName:
{
Description: The name of the tag. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_List (new)
Description :  This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/tagNames
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of tags. ,
Required: False ,
}
[
{
id:
{
Description: The tag name ID. ,
Required: False ,
}
string ,
tagName:
{
Description: The tag name. ,
Required: False ,
}
string ,
count:
{
Description: The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
values:
{
Description: The list of tag values. ,
Required: False ,
}
[
{
id:
{
Description: The tag value ID. ,
Required: False ,
}
string ,
tagValue:
{
Description: The tag value. ,
Required: False ,
}
string ,
count:
{
Description: The tag value count. ,
Required: False ,
}
{
type:
{
Description: Type of count. ,
Required: False ,
}
string ,
value:
{
Description: Value of count. ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtTenantScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtTenantScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtManagementGroupScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtManagementGroupScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
groupId:
{
Description: The management group ID. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_GetAtSubscriptionScope (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_ListAtSubscriptionScope (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations
{
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_Get (new)
Description :  Gets a deployments operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation to get. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentOperations_List (new)
Description :  Gets all deployments operations for a deployment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
deploymentName:
{
Description: The name of the deployment. ,
Required: True ,
}
string ,
$top:
{
Description: The number of results to return. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Microsoft Azure subscription ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of deployment operations. ,
Required: False ,
}
[
{
id:
{
Description: Full deployment operation ID. ,
Required: False ,
}
string ,
operationId:
{
Description: Deployment operation ID. ,
Required: False ,
}
string ,
properties:
{
Description: Deployment properties. ,
Required: False ,
}
{
provisioningOperation:
{
Description: The name of the current provisioning operation. ,
Enum:
{
NotSpecified: The provisioning operation is not specified. ,
Create: The provisioning operation is create. ,
Delete: The provisioning operation is delete. ,
Waiting: The provisioning operation is waiting. ,
AzureAsyncOperationWaiting: The provisioning operation is waiting Azure async operation. ,
ResourceCacheWaiting: The provisioning operation is waiting for resource cache. ,
Action: The provisioning operation is action. ,
Read: The provisioning operation is read. ,
EvaluateDeploymentOutput: The provisioning operation is evaluate output. ,
DeploymentCleanup: The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The state of the provisioning. ,
Required: False ,
}
string ,
timestamp:
{
Description: The date and time of the operation. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the operation. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Deployment operation service request id. ,
Required: False ,
}
string ,
statusCode:
{
Description: Operation status code from the resource provider. This property may not be set if a response has not yet been received. ,
Required: False ,
}
string ,
statusMessage:
{
Description: Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider. ,
Required: False ,
}
{
status:
{
Description: Status of the deployment operation. ,
Required: False ,
}
string ,
error:
{
Description: The error reported by the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
targetResource:
{
Description: The target resource. ,
Required: False ,
}
{
id:
{
Description: The ID of the resource. ,
Required: False ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: False ,
}
string ,
resourceType:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
}
,
request:
{
Description: The HTTP request message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
response:
{
Description: The HTTP response message. ,
Required: False ,
}
{
content:
{
Description: HTTP message content. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to use for getting the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Deployments_CalculateTemplateHash (new)
Description :  Calculate the hash of the given template.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.Resources/calculateTemplateHash
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
template:
{
Description: The template provided to calculate hash. ,
Required: True ,
}
object ,
}

⚐ Response (200)

{
minifiedTemplate:
{
Description: The minified template string. ,
Required: False ,
}
string ,
templateHash:
{
Description: The template hash. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_CreateOrUpdateAtScope (new)
Description :  This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.
Reference :  Link ¶

⚼ Request

PUT:  /{scope}/providers/Microsoft.Resources/tags/default
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
id:
{
Description: The ID of the tags wrapper resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the tags wrapper resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tags wrapper resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of tags. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the tags wrapper resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the tags wrapper resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tags wrapper resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of tags. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_UpdateAtScope (new)
Description :  This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.
Reference :  Link ¶

⚼ Request

PATCH:  /{scope}/providers/Microsoft.Resources/tags/default
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Required: True ,
}
{
operation:
{
Description: The operation type for the patch API. ,
Enum:
{
Replace: The 'replace' option replaces the entire set of existing tags with a new set. ,
Merge: The 'merge' option allows adding tags with new names and updating the values of tags with existing names. ,
Delete: The 'delete' option allows selectively deleting tags based on given names or name/value pairs. ,
}
,
Required: False ,
}
enum ,
properties:
{
Description: The set of tags. ,
Required: False ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the tags wrapper resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the tags wrapper resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tags wrapper resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of tags. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_GetAtScope (new)
Description :  Gets the entire set of tags on a resource or subscription.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/tags/default
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the tags wrapper resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the tags wrapper resource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the tags wrapper resource. ,
Required: False ,
}
string ,
properties:
{
Description: The set of tags. ,
Required: True ,
}
{
tags:
{
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tags_DeleteAtScope (new)
Description :  Deletes the entire set of tags on a resource or subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /{scope}/providers/Microsoft.Resources/tags/default
{
scope:
{
Description: The resource scope. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: URL to get status of this long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}