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: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtScope (new)
Description Checks whether the deployment exists.
Reference Link ¶

⚼ Request

HEAD:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
deploymentName: string ,
parameters:
{
location: string ,
properties:
{
template: object ,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
type: enum ,
deploymentName: string ,
}
,
expressionEvaluationOptions:
{
scope: enum ,
}
,
validationLevel: enum ,
}
,
tags: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}

⚐ Response (201)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_GetAtScope (new)
Description Gets a deployment.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}
{
scope: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
deploymentName: string ,
parameters:
{
location: string ,
properties:
{
template: object ,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
type: enum ,
deploymentName: string ,
}
,
expressionEvaluationOptions:
{
scope: enum ,
}
,
validationLevel: enum ,
}
,
tags: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_ExportTemplateAtScope (new)
Description Exports the template used for specified deployment.
Reference Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate
{
scope: string ,
deploymentName: string ,
api-version: string ,
}

⚐ Response (200)

{
template: object ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_ListAtScope (new)
Description Get all the deployments at the given scope.
Reference Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.Resources/deployments/
{
scope: string ,
$filter: string ,
$top: integer ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
api-version: string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Deployments_CheckExistenceAtTenantScope (new)
Description Checks whether the deployment exists.
Reference Link ¶

⚼ Request

HEAD:  /providers/Microsoft.Resources/deployments/{deploymentName}
{
deploymentName: string ,
api-version: string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
parameters:
{
location: string ,
properties:
{
template: object ,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
type: enum ,
deploymentName: string ,
}
,
expressionEvaluationOptions:
{
scope: enum ,
}
,
validationLevel: enum ,
}
,
tags: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
apiVersions:
[
string ,
]
,
defaultApiVersion: string ,
zoneMappings:
[
{
location: string ,
zones:
[
string ,
]
,
}
,
]
,
apiProfiles:
[
{
profileVersion: string ,
apiVersion: string ,
}
,
]
,
capabilities: string ,
properties: object ,
}
,
]
,
providerAuthorizationConsentState: enum ,
}
,
]
,
dependencies:
[
{
dependsOn:
[
{
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
id: string ,
resourceType: string ,
resourceName: string ,
}
,
]
,
templateLink:
{
uri: string ,
id: string ,
relativePath: string ,
contentVersion: string ,
queryString: string ,
}
,
parameters: object ,
parametersLink:
{
uri: string ,
contentVersion: string ,
}
,
mode: enum ,
debugSetting:
{
detailLevel: string ,
}
,
onErrorDeployment:
{
provisioningState: string ,
type: enum ,
deploymentName: string ,
}
,
templateHash: string ,
outputResources:
[
{
id: string ,
}
,
]
,
validatedResources:
[
{
id: string ,
}
,
]
,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
diagnostics:
[
{
level: enum ,
code: string ,
message: string ,
target: string ,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
]
,
validationLevel: enum ,
}
,
tags: object ,
}

⚐ Response (201)

{
id: string ,
name: string ,
type: string ,
location: string ,
properties:
{
provisioningState: enum ,
correlationId: string ,
timestamp: string ,
duration: string ,
outputs: object ,
providers:
[
{
id: string ,
namespace: string ,
registrationState: string ,
registrationPolicy: string ,
resourceTypes:
[
{
resourceType: string ,
locations:
[
string ,
]
,
locationMappings:
[
{
location: string ,
type: string ,
extendedLocations:
[
string ,
]
,
}
,
]
,
aliases:
[
{
name: string ,
paths:
[
{
path: string ,
apiVersions:
[
string ,
]
,
pattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
metadata:
{
type: enum ,
attributes: enum ,
}
,
}
,
]
,
type: enum ,
defaultPath: string ,
defaultPattern:
{
phrase: string ,
variable: string ,
type: enum ,
}
,
defaultMetadata:
{
type: