{ "swagger": "2.0", "info": { "title": "DeploymentsClient", "version": "2026-06-01", "description": "Provides operations for working with deployments.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "Deployments" }, { "name": "DeploymentOperations" } ], "paths": { "/{scope}/providers/Microsoft.Resources/deployments": { "get": { "operationId": "Deployments_ListAtScope", "tags": [ "Deployments" ], "description": "Get all the deployments at the given scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "The number of results to get. If null is passed, returns all deployments.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}": { "get": { "operationId": "Deployments_GetAtScope", "tags": [ "Deployments" ], "description": "Gets a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "operationId": "Deployments_CreateOrUpdateAtScope", "tags": [ "Deployments" ], "summary": "Deploys resources at a given scope.", "description": "You can provide the template and parameters directly in the request or link to JSON files.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Additional parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Resource 'DeploymentExtended' update operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "201": { "description": "Resource 'DeploymentExtended' create operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Create deployment at a given scope.": { "$ref": "./examples/PutDeploymentAtScope.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentExtended" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Deployments_DeleteAtScope", "tags": [ "Deployments" ], "summary": "Deletes a deployment from the deployment history.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "head": { "operationId": "Deployments_CheckExistenceAtScope", "tags": [ "Deployments" ], "description": "Checks whether the deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "The Azure resource exists" }, "404": { "description": "The Azure resource is not found" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { "post": { "operationId": "Deployments_CancelAtScope", "tags": [ "Deployments" ], "summary": "Cancels a currently running template deployment.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "operationId": "Deployments_ExportTemplateAtScope", "tags": [ "Deployments" ], "description": "Exports the template used for specified deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExportResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { "get": { "operationId": "DeploymentOperations_ListAtScope", "tags": [ "DeploymentOperations" ], "description": "Gets all deployments operations for a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "$top", "in": "query", "description": "The number of results to return.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { "get": { "operationId": "DeploymentOperations_GetAtScope", "tags": [ "DeploymentOperations" ], "description": "Gets a deployments operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "operationId", "in": "path", "description": "The ID of the operation to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { "post": { "operationId": "Deployments_ValidateAtScope", "tags": [ "Deployments" ], "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "scope", "in": "path", "description": "The fully qualified Azure Resource manager identifier of the resource.", "required": true, "type": "string", "x-ms-skip-url-encoding": true }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "400": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Validates a template at scope": { "$ref": "./examples/PostDeploymentValidateOnScope.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentValidateResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments": { "get": { "operationId": "Deployments_ListAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Get all the deployments for a management group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "The number of results to get. If null is passed, returns all deployments.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}": { "get": { "operationId": "Deployments_GetAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Gets a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "operationId": "Deployments_CreateOrUpdateAtManagementGroupScope", "tags": [ "Deployments" ], "summary": "Deploys resources at management group scope.", "description": "You can provide the template and parameters directly in the request or link to JSON files.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Additional parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeployment" } } ], "responses": { "200": { "description": "Resource 'DeploymentExtended' update operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "201": { "description": "Resource 'DeploymentExtended' create operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Create deployment at management group scope.": { "$ref": "./examples/PutDeploymentAtManagementGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentExtended" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Deployments_DeleteAtManagementGroupScope", "tags": [ "Deployments" ], "summary": "Deletes a deployment from the deployment history.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "head": { "operationId": "Deployments_CheckExistenceAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Checks whether the deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "The Azure resource exists" }, "404": { "description": "The Azure resource is not found" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { "post": { "operationId": "Deployments_CancelAtManagementGroupScope", "tags": [ "Deployments" ], "summary": "Cancels a currently running template deployment.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "operationId": "Deployments_ExportTemplateAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Exports the template used for specified deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExportResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { "get": { "operationId": "DeploymentOperations_ListAtManagementGroupScope", "tags": [ "DeploymentOperations" ], "description": "Gets all deployments operations for a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "$top", "in": "query", "description": "The number of results to return.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { "get": { "operationId": "DeploymentOperations_GetAtManagementGroupScope", "tags": [ "DeploymentOperations" ], "description": "Gets a deployments operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "operationId", "in": "path", "description": "The ID of the operation to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { "post": { "operationId": "Deployments_ValidateAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeployment" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "400": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Validates a template at management group scope": { "$ref": "./examples/PostDeploymentValidateOnManagementGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentValidateResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { "post": { "operationId": "Deployments_WhatIfAtManagementGroupScope", "tags": [ "Deployments" ], "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "groupId", "in": "path", "description": "The management group ID.", "required": true, "type": "string", "minLength": 1, "maxLength": 90 }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeploymentWhatIf" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WhatIfOperationResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Predict template changes at management group scope": { "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/WhatIfOperationResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Resources/calculateTemplateHash": { "post": { "operationId": "Deployments_CalculateTemplateHash", "tags": [ "Deployments" ], "description": "Calculate the hash of the given template.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "template", "in": "body", "description": "The request body", "required": true, "schema": {} } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/TemplateHashResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Calculate template hash": { "$ref": "./examples/CalculateTemplateHash.json" } } } }, "/providers/Microsoft.Resources/deployments": { "get": { "operationId": "Deployments_ListAtTenantScope", "tags": [ "Deployments" ], "description": "Get all the deployments at the tenant scope.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "The number of results to get. If null is passed, returns all deployments.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}": { "get": { "operationId": "Deployments_GetAtTenantScope", "tags": [ "Deployments" ], "description": "Gets a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "operationId": "Deployments_CreateOrUpdateAtTenantScope", "tags": [ "Deployments" ], "summary": "Deploys resources at tenant scope.", "description": "You can provide the template and parameters directly in the request or link to JSON files.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Additional parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeployment" } } ], "responses": { "200": { "description": "Resource 'DeploymentExtended' update operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "201": { "description": "Resource 'DeploymentExtended' create operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Create deployment at tenant scope.": { "$ref": "./examples/PutDeploymentAtTenant.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentExtended" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Deployments_DeleteAtTenantScope", "tags": [ "Deployments" ], "summary": "Deletes a deployment from the deployment history.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "head": { "operationId": "Deployments_CheckExistenceAtTenantScope", "tags": [ "Deployments" ], "description": "Checks whether the deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "The Azure resource exists" }, "404": { "description": "The Azure resource is not found" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { "post": { "operationId": "Deployments_CancelAtTenantScope", "tags": [ "Deployments" ], "summary": "Cancels a currently running template deployment.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "operationId": "Deployments_ExportTemplateAtTenantScope", "tags": [ "Deployments" ], "description": "Exports the template used for specified deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExportResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { "get": { "operationId": "DeploymentOperations_ListAtTenantScope", "tags": [ "DeploymentOperations" ], "description": "Gets all deployments operations for a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "$top", "in": "query", "description": "The number of results to return.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { "get": { "operationId": "DeploymentOperations_GetAtTenantScope", "tags": [ "DeploymentOperations" ], "description": "Gets a deployments operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "operationId", "in": "path", "description": "The ID of the operation to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { "post": { "operationId": "Deployments_ValidateAtTenantScope", "tags": [ "Deployments" ], "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeployment" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "400": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Validates a template at tenant scope": { "$ref": "./examples/PostDeploymentValidateOnTenant.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentValidateResult" }, "x-ms-long-running-operation": true } }, "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { "post": { "operationId": "Deployments_WhatIfAtTenantScope", "tags": [ "Deployments" ], "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/ScopedDeploymentWhatIf" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WhatIfOperationResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Predict template changes at management group scope": { "$ref": "./examples/PostDeploymentWhatIfOnTenant.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/WhatIfOperationResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments": { "get": { "operationId": "Deployments_ListAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Get all the deployments for a subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "The number of results to get. If null is passed, returns all deployments.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": { "get": { "operationId": "Deployments_GetAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Gets a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope", "tags": [ "Deployments" ], "summary": "Deploys resources at subscription scope.", "description": "You can provide the template and parameters directly in the request or link to JSON files.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Additional parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Resource 'DeploymentExtended' update operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "201": { "description": "Resource 'DeploymentExtended' create operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Create a deployment that will deploy a templateSpec with the given resourceId": { "$ref": "./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentExtended" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Deployments_DeleteAtSubscriptionScope", "tags": [ "Deployments" ], "summary": "Deletes a deployment from the deployment history.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "head": { "operationId": "Deployments_CheckExistenceAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Checks whether the deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "The Azure resource exists" }, "404": { "description": "The Azure resource is not found" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { "post": { "operationId": "Deployments_CancelAtSubscriptionScope", "tags": [ "Deployments" ], "summary": "Cancels a currently running template deployment.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "operationId": "Deployments_ExportTemplateAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Exports the template used for specified deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExportResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { "get": { "operationId": "DeploymentOperations_ListAtSubscriptionScope", "tags": [ "DeploymentOperations" ], "description": "Gets all deployments operations for a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "$top", "in": "query", "description": "The number of results to return.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { "get": { "operationId": "DeploymentOperations_GetAtSubscriptionScope", "tags": [ "DeploymentOperations" ], "description": "Gets a deployments operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "operationId", "in": "path", "description": "The ID of the operation to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { "post": { "operationId": "Deployments_ValidateAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "400": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Validates a template at subscription scope": { "$ref": "./examples/PostDeploymentValidateOnSubscription.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentValidateResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { "post": { "operationId": "Deployments_WhatIfAtSubscriptionScope", "tags": [ "Deployments" ], "description": "Returns changes that will be made by the deployment if executed at the scope of the subscription.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to What If.", "required": true, "schema": { "$ref": "#/definitions/DeploymentWhatIf" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WhatIfOperationResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Predict template changes at subscription scope": { "$ref": "./examples/PostDeploymentWhatIfOnSubscription.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/WhatIfOperationResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { "get": { "operationId": "DeploymentOperations_List", "tags": [ "DeploymentOperations" ], "description": "Gets all deployments operations for a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "$top", "in": "query", "description": "The number of results to return.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperationsListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { "get": { "operationId": "DeploymentOperations_Get", "tags": [ "DeploymentOperations" ], "description": "Gets a deployments operation.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "operationId", "in": "path", "description": "The ID of the operation to get.", "required": true, "type": "string" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentOperation" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments": { "get": { "operationId": "Deployments_ListByResourceGroup", "tags": [ "Deployments" ], "description": "Get all the deployments for a resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "$filter", "in": "query", "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'.", "required": false, "type": "string" }, { "name": "$top", "in": "query", "description": "The number of results to get. If null is passed, returns all deployments.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeploymentListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { "get": { "operationId": "Deployments_Get", "tags": [ "Deployments" ], "description": "Gets a deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "operationId": "Deployments_CreateOrUpdate", "tags": [ "Deployments" ], "summary": "Deploys resources to a resource group.", "description": "You can provide the template and parameters directly in the request or link to JSON files.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Additional parameters supplied to the operation.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Resource 'DeploymentExtended' update operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" } }, "201": { "description": "Resource 'DeploymentExtended' create operation succeeded", "schema": { "$ref": "#/definitions/DeploymentExtended" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Create a deployment that will deploy a template with a uri and queryString": { "$ref": "./examples/PutDeploymentResourceGroup.json" }, "Create a deployment that will deploy a templateSpec with the given resourceId": { "$ref": "./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json" }, "Create a deployment that will redeploy another deployment on failure": { "$ref": "./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json" }, "Create a deployment that will redeploy the last successful deployment on failure": { "$ref": "./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json" }, "Create deployment using external inputs": { "$ref": "./examples/PutDeploymentWithExternalInputs.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentExtended" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "Deployments_Delete", "tags": [ "Deployments" ], "summary": "Deletes a deployment from the deployment history.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "head": { "operationId": "Deployments_CheckExistence", "tags": [ "Deployments" ], "description": "Checks whether the deployment exists.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "The Azure resource exists" }, "404": { "description": "The Azure resource is not found" }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { "post": { "operationId": "Deployments_Cancel", "tags": [ "Deployments" ], "summary": "Cancels a currently running template deployment.", "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.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "operationId": "Deployments_ExportTemplate", "tags": [ "Deployments" ], "description": "Exports the template used for specified deployment.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentExportResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { "post": { "operationId": "Deployments_Validate", "tags": [ "Deployments" ], "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/Deployment" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "400": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DeploymentValidateResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Validates a template at resource group scope": { "$ref": "./examples/PostDeploymentValidateOnResourceGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/DeploymentValidateResult" }, "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { "post": { "operationId": "Deployments_WhatIf", "tags": [ "Deployments" ], "description": "Returns changes that will be made by the deployment if executed at the scope of the resource group.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" }, { "name": "resourceGroupName", "in": "path", "description": "The name of the resource group.", "required": true, "type": "string" }, { "name": "deploymentName", "in": "path", "description": "The name of the deployment.", "required": true, "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, { "name": "parameters", "in": "body", "description": "Parameters to validate.", "required": true, "schema": { "$ref": "#/definitions/DeploymentWhatIf" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/WhatIfOperationResult" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { "Predict template changes at resource group scope": { "$ref": "./examples/PostDeploymentWhatIfOnResourceGroup.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/WhatIfOperationResult" }, "x-ms-long-running-operation": true } } }, "definitions": { "Alias": { "type": "object", "description": "The alias type.", "properties": { "name": { "type": "string", "description": "The alias name." }, "paths": { "type": "array", "description": "The paths for an alias.", "items": { "$ref": "#/definitions/AliasPath" }, "x-ms-identifiers": [] }, "type": { "$ref": "#/definitions/AliasType", "description": "The type of the alias." }, "defaultPath": { "type": "string", "description": "The default path for an alias." }, "defaultPattern": { "$ref": "#/definitions/AliasPattern", "description": "The default pattern for an alias." }, "defaultMetadata": { "$ref": "#/definitions/AliasPathMetadata", "description": "The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata", "readOnly": true } } }, "AliasPath": { "type": "object", "description": "The type of the paths for alias.", "properties": { "path": { "type": "string", "description": "The path of an alias." }, "apiVersions": { "type": "array", "description": "The API versions.", "items": { "type": "string" } }, "pattern": { "$ref": "#/definitions/AliasPattern", "description": "The pattern for an alias path." }, "metadata": { "$ref": "#/definitions/AliasPathMetadata", "description": "The metadata of the alias path. If missing, fall back to the default metadata of the alias.", "readOnly": true } } }, "AliasPathAttributes": { "type": "string", "description": "The attributes of the token that the alias path is referring to.", "enum": [ "None", "Modifiable" ], "x-ms-enum": { "name": "AliasPathAttributes", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "The token that the alias path is referring to has no attributes." }, { "name": "Modifiable", "value": "Modifiable", "description": "The token that the alias path is referring to is modifiable by policies with 'modify' effect." } ] } }, "AliasPathMetadata": { "type": "object", "properties": { "type": { "$ref": "#/definitions/AliasPathTokenType", "description": "The type of the token that the alias path is referring to.", "readOnly": true }, "attributes": { "$ref": "#/definitions/AliasPathAttributes", "description": "The attributes of the token that the alias path is referring to.", "readOnly": true } } }, "AliasPathTokenType": { "type": "string", "description": "The type of the token that the alias path is referring to.", "enum": [ "NotSpecified", "Any", "String", "Object", "Array", "Integer", "Number", "Boolean" ], "x-ms-enum": { "name": "AliasPathTokenType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "The token type is not specified." }, { "name": "Any", "value": "Any", "description": "The token type can be anything." }, { "name": "String", "value": "String", "description": "The token type is string." }, { "name": "Object", "value": "Object", "description": "The token type is object." }, { "name": "Array", "value": "Array", "description": "The token type is array." }, { "name": "Integer", "value": "Integer", "description": "The token type is integer." }, { "name": "Number", "value": "Number", "description": "The token type is number." }, { "name": "Boolean", "value": "Boolean", "description": "The token type is boolean." } ] } }, "AliasPattern": { "type": "object", "description": "The type of the pattern for an alias path.", "properties": { "phrase": { "type": "string", "description": "The alias pattern phrase." }, "variable": { "type": "string", "description": "The alias pattern variable." }, "type": { "$ref": "#/definitions/AliasPatternType", "description": "The type of alias pattern" } } }, "AliasPatternType": { "type": "string", "description": "The type of alias pattern", "enum": [ "NotSpecified", "Extract" ], "x-ms-enum": { "name": "AliasPatternType", "modelAsString": false, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified is not allowed." }, { "name": "Extract", "value": "Extract", "description": "Extract is the only allowed value." } ] } }, "AliasType": { "type": "string", "description": "The type of the alias.", "enum": [ "NotSpecified", "PlainText", "Mask" ], "x-ms-enum": { "name": "AliasType", "modelAsString": false, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "Alias type is unknown (same as not providing alias type)." }, { "name": "PlainText", "value": "PlainText", "description": "Alias value is not secret." }, { "name": "Mask", "value": "Mask", "description": "Alias value is secret." } ] } }, "ApiProfile": { "type": "object", "properties": { "profileVersion": { "type": "string", "description": "The profile version.", "readOnly": true }, "apiVersion": { "type": "string", "description": "The API version.", "readOnly": true } } }, "BasicDependency": { "type": "object", "description": "Deployment dependency information.", "properties": { "id": { "type": "string", "description": "The ID of the dependency." }, "resourceType": { "type": "string", "description": "The dependency resource type." }, "resourceName": { "type": "string", "description": "The dependency resource name." } } }, "ChangeType": { "type": "string", "description": "Type of change that will be made to the resource when the deployment is executed.", "enum": [ "Create", "Delete", "Ignore", "Deploy", "NoChange", "Modify", "Unsupported" ], "x-ms-enum": { "name": "ChangeType", "modelAsString": false, "values": [ { "name": "Create", "value": "Create", "description": "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." }, { "name": "Delete", "value": "Delete", "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed." }, { "name": "Ignore", "value": "Ignore", "description": "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." }, { "name": "Deploy", "value": "Deploy", "description": "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." }, { "name": "NoChange", "value": "NoChange", "description": "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." }, { "name": "Modify", "value": "Modify", "description": "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." }, { "name": "Unsupported", "value": "Unsupported", "description": "The resource is not supported by What-If." } ] } }, "CloudError": { "type": "object", "description": "An error response for a resource management request.", "properties": { "error": { "$ref": "#/definitions/ErrorResponse", "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.)" } }, "x-ms-external": true }, "DebugSetting": { "type": "object", "description": "The debug setting.", "properties": { "detailLevel": { "type": "string", "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." } } }, "Dependency": { "type": "object", "description": "Deployment dependency information.", "properties": { "dependsOn": { "type": "array", "description": "The list of dependencies.", "items": { "$ref": "#/definitions/BasicDependency" } }, "id": { "type": "string", "description": "The ID of the dependency." }, "resourceType": { "type": "string", "description": "The dependency resource type." }, "resourceName": { "type": "string", "description": "The dependency resource name." } } }, "Deployment": { "type": "object", "description": "Deployment operation parameters.", "properties": { "location": { "type": "string", "description": "The location to store the deployment data." }, "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The deployment properties." }, "tags": { "type": "object", "description": "Deployment tags", "additionalProperties": { "type": "string" } }, "identity": { "$ref": "#/definitions/DeploymentIdentity", "description": "The Managed Identity configuration for a deployment." } }, "required": [ "properties" ] }, "DeploymentDiagnosticsDefinition": { "type": "object", "properties": { "level": { "$ref": "#/definitions/Level", "description": "Denotes the additional response level.", "readOnly": true }, "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "target": { "type": "string", "description": "The error target.", "readOnly": true }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorAdditionalInfo" }, "readOnly": true, "x-ms-identifiers": [] } }, "required": [ "level", "code", "message" ] }, "DeploymentExportResult": { "type": "object", "description": "The deployment export result.", "properties": { "template": { "description": "The template content." } } }, "DeploymentExtended": { "type": "object", "description": "Deployment information.", "properties": { "properties": { "$ref": "#/definitions/DeploymentPropertiesExtended", "description": "Deployment properties." }, "location": { "type": "string", "description": "the location of the deployment." }, "tags": { "type": "object", "description": "Deployment tags", "additionalProperties": { "type": "string" } } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" } ] }, "DeploymentExtensionConfigItem": { "type": "object", "description": "Represents the value for an extension config property.", "properties": { "value": { "description": "The value of the extension config property." }, "keyVaultReference": { "$ref": "#/definitions/KeyVaultParameterReference", "description": "The Azure Key Vault reference used to retrieve the secret value of the extension config property." } } }, "DeploymentExtensionDefinition": { "type": "object", "properties": { "alias": { "type": "string", "description": "The alias of the extension as defined in the deployment template.", "readOnly": true }, "name": { "type": "string", "description": "The extension name.", "readOnly": true }, "version": { "type": "string", "description": "The extension version.", "readOnly": true }, "configId": { "type": "string", "description": "The extension configuration ID. It uniquely identifies a deployment target within an extension.", "readOnly": true }, "configHash": { "type": "string", "description": "The extension configuration hash. Can be used to distinguish different configurations that have the same config ID.", "readOnly": true }, "config": { "type": "object", "description": "The extension configuration.", "additionalProperties": { "$ref": "#/definitions/DeploymentExtensionConfigItem" }, "readOnly": true } } }, "DeploymentExternalInput": { "type": "object", "description": "Deployment external input for parameterization.", "properties": { "value": { "description": "External input value." } }, "required": [ "value" ] }, "DeploymentExternalInputDefinition": { "type": "object", "description": "Deployment external input definition for parameterization.", "properties": { "kind": { "type": "string", "description": "The kind of external input." }, "config": { "description": "Configuration for the external input." } }, "required": [ "kind" ] }, "DeploymentIdentity": { "type": "object", "description": "The Managed Identity configuration for a deployment.", "properties": { "type": { "$ref": "#/definitions/DeploymentIdentityType", "description": "The identity type." }, "userAssignedIdentities": { "type": "object", "description": "The set of user assigned identities associated with the resource.", "additionalProperties": { "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/UserAssignedIdentity" } } }, "required": [ "type" ] }, "DeploymentIdentityType": { "type": "string", "description": "The identity type.", "enum": [ "None", "UserAssigned" ], "x-ms-enum": { "name": "DeploymentIdentityType", "modelAsString": true, "values": [ { "name": "None", "value": "None", "description": "None" }, { "name": "UserAssigned", "value": "UserAssigned", "description": "UserAssigned" } ] } }, "DeploymentListResult": { "type": "object", "description": "Paged collection of DeploymentExtended items", "properties": { "value": { "type": "array", "description": "The DeploymentExtended items on this page", "items": { "$ref": "#/definitions/DeploymentExtended" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DeploymentMode": { "type": "string", "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", "Complete" ], "x-ms-enum": { "name": "DeploymentMode", "modelAsString": false, "values": [ { "name": "Incremental", "value": "Incremental", "description": "Incremental" }, { "name": "Complete", "value": "Complete", "description": "Complete" } ] } }, "DeploymentOperation": { "type": "object", "description": "Deployment operation information.", "properties": { "id": { "type": "string", "description": "Full deployment operation ID.", "readOnly": true }, "operationId": { "type": "string", "description": "Deployment operation ID.", "readOnly": true }, "properties": { "$ref": "#/definitions/DeploymentOperationProperties", "description": "Deployment properties." } } }, "DeploymentOperationProperties": { "type": "object", "description": "Deployment operation properties.", "properties": { "provisioningOperation": { "$ref": "#/definitions/ProvisioningOperation", "description": "The name of the current provisioning operation.", "readOnly": true }, "provisioningState": { "type": "string", "description": "The state of the provisioning.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "The date and time of the operation.", "readOnly": true }, "duration": { "type": "string", "description": "The duration of the operation.", "readOnly": true }, "serviceRequestId": { "type": "string", "description": "Deployment operation service request id.", "readOnly": true }, "statusCode": { "type": "string", "description": "Operation status code from the resource provider. This property may not be set if a response has not yet been received.", "readOnly": true }, "statusMessage": { "$ref": "#/definitions/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.", "readOnly": true }, "targetResource": { "$ref": "#/definitions/TargetResource", "description": "The target resource.", "readOnly": true }, "request": { "$ref": "#/definitions/HttpMessage", "description": "The HTTP request message.", "readOnly": true }, "response": { "$ref": "#/definitions/HttpMessage", "description": "The HTTP response message.", "readOnly": true } } }, "DeploymentOperationsListResult": { "type": "object", "description": "List of deployment operations.", "properties": { "value": { "type": "array", "description": "The DeploymentOperation items on this page", "items": { "$ref": "#/definitions/DeploymentOperation" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "DeploymentParameter": { "type": "object", "description": "Deployment parameter for the template.", "properties": { "value": { "description": "Input value to the parameter ." }, "reference": { "$ref": "#/definitions/KeyVaultParameterReference", "description": "Azure Key Vault parameter reference." }, "expression": { "type": "string", "description": "Input expression to the parameter.", "x-ms-mutability": [ "update", "create" ] } } }, "DeploymentProperties": { "type": "object", "description": "Deployment properties.", "properties": { "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." }, "templateLink": { "$ref": "#/definitions/TemplateLink", "description": "The URI of the template. Use either the templateLink property or the template property, but not both." }, "parameters": { "type": "object", "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.", "additionalProperties": { "$ref": "#/definitions/DeploymentParameter" } }, "externalInputs": { "type": "object", "description": "External input values, used by external tooling for parameter evaluation.", "additionalProperties": { "$ref": "#/definitions/DeploymentExternalInput" }, "x-ms-mutability": [ "update", "create" ] }, "externalInputDefinitions": { "type": "object", "description": "External input definitions, used by external tooling to define expected external input values.", "additionalProperties": { "$ref": "#/definitions/DeploymentExternalInputDefinition" }, "x-ms-mutability": [ "update", "create" ] }, "parametersLink": { "$ref": "#/definitions/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." }, "extensionConfigs": { "type": "object", "description": "The configurations to use for deployment extensions. The keys of this object are deployment extension aliases as defined in the deployment template.", "additionalProperties": { "additionalProperties": { "$ref": "#/definitions/DeploymentExtensionConfigItem" }, "type": "object" } }, "mode": { "$ref": "#/definitions/DeploymentMode", "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." }, "debugSetting": { "$ref": "#/definitions/DebugSetting", "description": "The debug setting of the deployment." }, "onErrorDeployment": { "$ref": "#/definitions/OnErrorDeployment", "description": "The deployment on error behavior." }, "expressionEvaluationOptions": { "$ref": "#/definitions/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." }, "validationLevel": { "$ref": "#/definitions/ValidationLevel", "description": "The validation level of the deployment" } }, "required": [ "mode" ] }, "DeploymentPropertiesExtended": { "type": "object", "description": "Deployment properties with additional details.", "properties": { "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "Denotes the state of provisioning.", "readOnly": true }, "correlationId": { "type": "string", "description": "The correlation ID of the deployment.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the template deployment.", "readOnly": true }, "duration": { "type": "string", "description": "The duration of the template deployment.", "readOnly": true }, "outputs": { "description": "Key/value pairs that represent deployment output.", "readOnly": true }, "providers": { "type": "array", "description": "The list of resource providers needed for the deployment.", "items": { "$ref": "#/definitions/Provider" }, "readOnly": true }, "dependencies": { "type": "array", "description": "The list of deployment dependencies.", "items": { "$ref": "#/definitions/Dependency" }, "readOnly": true }, "templateLink": { "$ref": "#/definitions/TemplateLink", "description": "The URI referencing the template.", "readOnly": true }, "parameters": { "description": "Deployment parameters.", "readOnly": true }, "parametersLink": { "$ref": "#/definitions/ParametersLink", "description": "The URI referencing the parameters.", "readOnly": true }, "extensions": { "type": "array", "description": "The extensions used in this deployment.", "items": { "$ref": "#/definitions/DeploymentExtensionDefinition" }, "readOnly": true }, "mode": { "$ref": "#/definitions/DeploymentMode", "description": "The deployment mode. Possible values are Incremental and Complete.", "readOnly": true }, "debugSetting": { "$ref": "#/definitions/DebugSetting", "description": "The debug setting of the deployment.", "readOnly": true }, "onErrorDeployment": { "$ref": "#/definitions/OnErrorDeploymentExtended", "description": "The deployment on error behavior.", "readOnly": true }, "templateHash": { "type": "string", "description": "The hash produced for the template.", "readOnly": true }, "outputResources": { "type": "array", "description": "Array of provisioned resources.", "items": { "$ref": "#/definitions/ResourceReference" }, "readOnly": true }, "validatedResources": { "type": "array", "description": "Array of validated resources.", "items": { "$ref": "#/definitions/ResourceReference" }, "readOnly": true }, "error": { "$ref": "#/definitions/ErrorResponse", "description": "The deployment error.", "readOnly": true }, "diagnostics": { "type": "array", "description": "Contains diagnostic information collected during validation process.", "items": { "$ref": "#/definitions/DeploymentDiagnosticsDefinition" }, "readOnly": true }, "validationLevel": { "$ref": "#/definitions/ValidationLevel", "description": "The validation level of the deployment" } } }, "DeploymentResourceWhatIfPrediction": { "type": "object", "description": "A prediction for a deployment resource by its symbolic name path.", "properties": { "symbolicNamePath": { "type": "array", "description": "The symbolic name path to the resource in the deployment template, including nested deployment(s) and extension if applicable.", "items": { "type": "string" } }, "resourceId": { "type": "string", "description": "The predicted fully-qualified Azure resource ID." }, "extension": { "$ref": "#/definitions/DeploymentExtensionDefinition", "description": "The predicted extension usage." }, "resourceType": { "type": "string", "description": "The predicted resource type." }, "identifiers": { "description": "The predicted extensible resource identifiers." }, "apiVersion": { "type": "string", "description": "The predicted API version." } }, "required": [ "symbolicNamePath" ] }, "DeploymentValidateResult": { "type": "object", "description": "Information from validate template deployment response.", "properties": { "error": { "$ref": "#/definitions/ErrorResponse", "description": "The deployment validation error.", "readOnly": true }, "id": { "type": "string", "description": "The ID of the deployment.", "readOnly": true }, "name": { "type": "string", "description": "The name of the deployment.", "readOnly": true }, "type": { "type": "string", "description": "The type of the deployment.", "readOnly": true }, "properties": { "$ref": "#/definitions/DeploymentPropertiesExtended", "description": "The template deployment properties." } } }, "DeploymentWhatIf": { "type": "object", "description": "Deployment What-if operation parameters.", "properties": { "location": { "type": "string", "description": "The location to store the deployment data." }, "properties": { "$ref": "#/definitions/DeploymentWhatIfProperties", "description": "The deployment properties." } }, "required": [ "properties" ] }, "DeploymentWhatIfProperties": { "type": "object", "description": "Deployment What-if properties.", "properties": { "whatIfSettings": { "$ref": "#/definitions/DeploymentWhatIfSettings", "description": "Optional What-If operation settings." }, "resourcePredictions": { "type": "array", "description": "Resource predictions that can be utilized by what-if to produce potential modification changes.", "items": { "$ref": "#/definitions/DeploymentResourceWhatIfPrediction" }, "x-ms-identifiers": [] } }, "allOf": [ { "$ref": "#/definitions/DeploymentProperties" } ] }, "DeploymentWhatIfSettings": { "type": "object", "description": "Deployment What-If operation settings.", "properties": { "resultFormat": { "$ref": "#/definitions/WhatIfResultFormat", "description": "The format of the What-If results" } } }, "ErrorResponse": { "type": "object", "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.)", "properties": { "code": { "type": "string", "description": "The error code.", "readOnly": true }, "message": { "type": "string", "description": "The error message.", "readOnly": true }, "target": { "type": "string", "description": "The error target.", "readOnly": true }, "details": { "type": "array", "description": "The error details.", "items": { "$ref": "#/definitions/ErrorResponse" }, "readOnly": true, "x-ms-identifiers": [ "message", "target" ] }, "additionalInfo": { "type": "array", "description": "The error additional info.", "items": { "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorAdditionalInfo" }, "readOnly": true, "x-ms-identifiers": [] } } }, "ExpressionEvaluationOptions": { "type": "object", "description": "Specifies whether template expressions are evaluated within the scope of the parent template or nested template.", "properties": { "scope": { "$ref": "#/definitions/ExpressionEvaluationOptionsScopeType", "description": "The scope to be used for evaluation of parameters, variables and functions in a nested template." } } }, "ExpressionEvaluationOptionsScopeType": { "type": "string", "description": "The scope to be used for evaluation of parameters, variables and functions in a nested template.", "enum": [ "NotSpecified", "Outer", "Inner" ], "x-ms-enum": { "name": "ExpressionEvaluationOptionsScopeType", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "Outer", "value": "Outer", "description": "Outer" }, { "name": "Inner", "value": "Inner", "description": "Inner" } ] } }, "HttpMessage": { "type": "object", "description": "HTTP message.", "properties": { "content": { "description": "HTTP message content." } } }, "KeyVaultParameterReference": { "type": "object", "description": "Azure Key Vault parameter reference.", "properties": { "keyVault": { "$ref": "#/definitions/KeyVaultReference", "description": "Azure Key Vault reference." }, "secretName": { "type": "string", "description": "Azure Key Vault secret name." }, "secretVersion": { "type": "string", "description": "Azure Key Vault secret version." } }, "required": [ "keyVault", "secretName" ] }, "KeyVaultReference": { "type": "object", "description": "Azure Key Vault reference.", "properties": { "id": { "type": "string", "description": "Azure Key Vault resource id." } }, "required": [ "id" ] }, "Level": { "type": "string", "description": "Denotes the additional response level.", "enum": [ "Warning", "Info", "Error" ], "x-ms-enum": { "name": "Level", "modelAsString": true, "values": [ { "name": "Warning", "value": "Warning", "description": "Warning" }, { "name": "Info", "value": "Info", "description": "Info" }, { "name": "Error", "value": "Error", "description": "Error" } ] } }, "OnErrorDeployment": { "type": "object", "description": "Deployment on error behavior.", "properties": { "type": { "$ref": "#/definitions/OnErrorDeploymentType", "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment." }, "deploymentName": { "type": "string", "description": "The deployment to be used on error case." } } }, "OnErrorDeploymentExtended": { "type": "object", "description": "Deployment on error behavior with additional details.", "properties": { "provisioningState": { "type": "string", "description": "The state of the provisioning for the on error deployment.", "readOnly": true }, "type": { "$ref": "#/definitions/OnErrorDeploymentType", "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment." }, "deploymentName": { "type": "string", "description": "The deployment to be used on error case." } } }, "OnErrorDeploymentType": { "type": "string", "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.", "enum": [ "LastSuccessful", "SpecificDeployment" ], "x-ms-enum": { "name": "OnErrorDeploymentType", "modelAsString": false, "values": [ { "name": "LastSuccessful", "value": "LastSuccessful", "description": "LastSuccessful" }, { "name": "SpecificDeployment", "value": "SpecificDeployment", "description": "SpecificDeployment" } ] } }, "ParametersLink": { "type": "object", "description": "Entity representing the reference to the deployment parameters.", "properties": { "uri": { "type": "string", "description": "The URI of the parameters file." }, "contentVersion": { "type": "string", "description": "If included, must match the ContentVersion in the template." } }, "required": [ "uri" ] }, "PropertyChangeType": { "type": "string", "description": "The type of property change.", "enum": [ "Create", "Delete", "Modify", "Array", "NoEffect" ], "x-ms-enum": { "name": "PropertyChangeType", "modelAsString": false, "values": [ { "name": "Create", "value": "Create", "description": "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." }, { "name": "Delete", "value": "Delete", "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed." }, { "name": "Modify", "value": "Modify", "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed." }, { "name": "Array", "value": "Array", "description": "The property is an array and contains nested changes." }, { "name": "NoEffect", "value": "NoEffect", "description": "The property will not be set or updated." } ] } }, "Provider": { "type": "object", "description": "Resource provider information.", "properties": { "id": { "type": "string", "description": "The provider ID.", "readOnly": true }, "namespace": { "type": "string", "description": "The namespace of the resource provider." }, "registrationState": { "type": "string", "description": "The registration state of the resource provider.", "readOnly": true }, "registrationPolicy": { "type": "string", "description": "The registration policy of the resource provider.", "readOnly": true }, "resourceTypes": { "type": "array", "description": "The collection of provider resource types.", "items": { "$ref": "#/definitions/ProviderResourceType" }, "readOnly": true, "x-ms-identifiers": [ "resourceType" ] }, "providerAuthorizationConsentState": { "$ref": "#/definitions/ProviderAuthorizationConsentState", "description": "The provider authorization consent state." } } }, "ProviderAuthorizationConsentState": { "type": "string", "description": "The provider authorization consent state.", "enum": [ "NotSpecified", "Required", "NotRequired", "Consented" ], "x-ms-enum": { "name": "ProviderAuthorizationConsentState", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "Required", "value": "Required", "description": "Required" }, { "name": "NotRequired", "value": "NotRequired", "description": "NotRequired" }, { "name": "Consented", "value": "Consented", "description": "Consented" } ] } }, "ProviderExtendedLocation": { "type": "object", "description": "The provider extended location.", "properties": { "location": { "type": "string", "description": "The azure location." }, "type": { "type": "string", "description": "The extended location type." }, "extendedLocations": { "type": "array", "description": "The extended locations for the azure location.", "items": { "type": "string" } } } }, "ProviderResourceType": { "type": "object", "description": "Resource type managed by the resource provider.", "properties": { "resourceType": { "type": "string", "description": "The resource type." }, "locations": { "type": "array", "description": "The collection of locations where this resource type can be created.", "items": { "type": "string" } }, "locationMappings": { "type": "array", "description": "The location mappings that are supported by this resource type.", "items": { "$ref": "#/definitions/ProviderExtendedLocation" }, "x-ms-identifiers": [ "location", "type" ] }, "aliases": { "type": "array", "description": "The aliases that are supported by this resource type.", "items": { "$ref": "#/definitions/Alias" }, "x-ms-identifiers": [ "name" ] }, "apiVersions": { "type": "array", "description": "The API version.", "items": { "type": "string" } }, "defaultApiVersion": { "type": "string", "description": "The default API version.", "readOnly": true }, "zoneMappings": { "type": "array", "items": { "$ref": "#/definitions/ZoneMapping" }, "x-ms-identifiers": [ "location" ] }, "apiProfiles": { "type": "array", "description": "The API profiles for the resource provider.", "items": { "$ref": "#/definitions/ApiProfile" }, "readOnly": true, "x-ms-identifiers": [ "apiVersion", "profileVersion" ] }, "capabilities": { "type": "string", "description": "The additional capabilities offered by this resource type." }, "properties": { "type": "object", "description": "The properties.", "additionalProperties": { "type": "string" } } } }, "ProvisioningOperation": { "type": "string", "description": "The name of the current provisioning operation.", "enum": [ "NotSpecified", "Create", "Delete", "Waiting", "AzureAsyncOperationWaiting", "ResourceCacheWaiting", "Action", "Read", "EvaluateDeploymentOutput", "DeploymentCleanup" ], "x-ms-enum": { "name": "ProvisioningOperation", "modelAsString": false, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "The provisioning operation is not specified." }, { "name": "Create", "value": "Create", "description": "The provisioning operation is create." }, { "name": "Delete", "value": "Delete", "description": "The provisioning operation is delete." }, { "name": "Waiting", "value": "Waiting", "description": "The provisioning operation is waiting." }, { "name": "AzureAsyncOperationWaiting", "value": "AzureAsyncOperationWaiting", "description": "The provisioning operation is waiting Azure async operation." }, { "name": "ResourceCacheWaiting", "value": "ResourceCacheWaiting", "description": "The provisioning operation is waiting for resource cache." }, { "name": "Action", "value": "Action", "description": "The provisioning operation is action." }, { "name": "Read", "value": "Read", "description": "The provisioning operation is read." }, { "name": "EvaluateDeploymentOutput", "value": "EvaluateDeploymentOutput", "description": "The provisioning operation is evaluate output." }, { "name": "DeploymentCleanup", "value": "DeploymentCleanup", "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment." } ] } }, "ProvisioningState": { "type": "string", "description": "Denotes the state of provisioning.", "enum": [ "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Updating" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "NotSpecified", "value": "NotSpecified", "description": "NotSpecified" }, { "name": "Accepted", "value": "Accepted", "description": "Accepted" }, { "name": "Running", "value": "Running", "description": "Running" }, { "name": "Ready", "value": "Ready", "description": "Ready" }, { "name": "Creating", "value": "Creating", "description": "Creating" }, { "name": "Created", "value": "Created", "description": "Created" }, { "name": "Deleting", "value": "Deleting", "description": "Deleting" }, { "name": "Deleted", "value": "Deleted", "description": "Deleted" }, { "name": "Canceled", "value": "Canceled", "description": "Canceled" }, { "name": "Failed", "value": "Failed", "description": "Failed" }, { "name": "Succeeded", "value": "Succeeded", "description": "Succeeded" }, { "name": "Updating", "value": "Updating", "description": "Updating" } ] } }, "ResourceReference": { "type": "object", "description": "The resource Id model.", "properties": { "id": { "type": "string", "description": "The fully qualified Azure resource ID.", "readOnly": true }, "extension": { "$ref": "#/definitions/DeploymentExtensionDefinition", "description": "The extension the resource was deployed with.", "readOnly": true }, "resourceType": { "type": "string", "description": "The resource type.", "readOnly": true }, "identifiers": { "description": "The extensible resource identifiers.", "readOnly": true }, "apiVersion": { "type": "string", "description": "The API version the resource was deployed with.", "readOnly": true }, "symbolicNamePath": { "type": "array", "description": "The symbolic name path to the resource in the deployment template, including nested deployment(s) and extension if applicable.", "items": { "type": "string" } } } }, "ScopedDeployment": { "type": "object", "description": "Deployment operation parameters.", "properties": { "location": { "type": "string", "description": "The location to store the deployment data." }, "properties": { "$ref": "#/definitions/DeploymentProperties", "description": "The deployment properties." }, "tags": { "type": "object", "description": "Deployment tags", "additionalProperties": { "type": "string" } } }, "required": [ "location", "properties" ] }, "ScopedDeploymentWhatIf": { "type": "object", "description": "Deployment What-if operation parameters.", "properties": { "location": { "type": "string", "description": "The location to store the deployment data." }, "properties": { "$ref": "#/definitions/DeploymentWhatIfProperties", "description": "The deployment properties." } }, "required": [ "location", "properties" ] }, "StatusMessage": { "type": "object", "description": "Operation status message object.", "properties": { "status": { "type": "string", "description": "Status of the deployment operation." }, "error": { "$ref": "#/definitions/ErrorResponse", "description": "The error reported by the operation." } } }, "TargetResource": { "type": "object", "description": "Target resource.", "properties": { "id": { "type": "string", "description": "The Azure resource ID of the resource." }, "resourceName": { "type": "string", "description": "The name of the resource." }, "resourceType": { "type": "string", "description": "The type of the resource." }, "extension": { "$ref": "#/definitions/DeploymentExtensionDefinition", "description": "The extension the resource was deployed with." }, "identifiers": { "description": "The extensible resource identifiers." }, "apiVersion": { "type": "string", "description": "The API version the resource was deployed with." }, "symbolicName": { "type": "string", "description": "The symbolic name of the resource as defined in the deployment template." }, "symbolicNamePath": { "type": "array", "description": "The symbolic name path to the resource in the deployment template, including nested deployment(s) and extension if applicable.", "items": { "type": "string" } } } }, "TemplateHashResult": { "type": "object", "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.", "properties": { "minifiedTemplate": { "type": "string", "description": "The minified template string." }, "templateHash": { "type": "string", "description": "The template hash." } } }, "TemplateLink": { "type": "object", "description": "Entity representing the reference to the template.", "properties": { "uri": { "type": "string", "description": "The URI of the template to deploy. Use either the uri or id property, but not both." }, "id": { "type": "string", "description": "The resource id of a Template Spec. Use either the id or uri property, but not both." }, "relativePath": { "type": "string", "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" }, "contentVersion": { "type": "string", "description": "If included, must match the ContentVersion in the template." }, "queryString": { "type": "string", "description": "The query string (for example, a SAS token) to be used with the templateLink URI." } } }, "ValidationLevel": { "type": "string", "description": "The level of validation performed on the deployment.", "enum": [ "Template", "Provider", "ProviderNoRbac" ], "x-ms-enum": { "name": "ValidationLevel", "modelAsString": true, "values": [ { "name": "Template", "value": "Template", "description": "Static analysis of the template is performed." }, { "name": "Provider", "value": "Provider", "description": "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." }, { "name": "ProviderNoRbac", "value": "ProviderNoRbac", "description": "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." } ] } }, "WhatIfChange": { "type": "object", "description": "Information about a single resource change predicted by What-If operation.", "properties": { "resourceId": { "type": "string", "description": "The fully-qualified ARM resource ID for this change." }, "deploymentId": { "type": "string", "description": "The resource id of the Deployment responsible for this change." }, "symbolicName": { "type": "string", "description": "The symbolic name of the resource responsible for this change." }, "resourceType": { "type": "string", "description": "The resource type of the resource." }, "identifiers": { "description": "A subset of properties that uniquely identify a Bicep extensible resource because it lacks a resource id like an Azure resource has." }, "extension": { "$ref": "#/definitions/DeploymentExtensionDefinition", "description": "The extension the resource was deployed with." }, "changeType": { "$ref": "#/definitions/ChangeType", "description": "Type of change that will be made to the resource when the deployment is executed." }, "unsupportedReason": { "type": "string", "description": "The explanation about why the resource is unsupported by What-If." }, "before": { "description": "The snapshot of the resource before the deployment is executed." }, "after": { "description": "The predicted snapshot of the resource after the deployment is executed." }, "delta": { "type": "array", "description": "The predicted changes to resource properties.", "items": { "$ref": "#/definitions/WhatIfPropertyChange" }, "x-ms-identifiers": [ "path" ] } }, "required": [ "changeType" ] }, "WhatIfOperationProperties": { "type": "object", "description": "Deployment operation properties.", "properties": { "changes": { "type": "array", "description": "List of resource changes predicted by What-If operation.", "items": { "$ref": "#/definitions/WhatIfChange" } }, "potentialChanges": { "type": "array", "description": "List of resource changes predicted by What-If operation.", "items": { "$ref": "#/definitions/WhatIfChange" } }, "diagnostics": { "type": "array", "description": "List of resource diagnostics detected by What-If operation.", "items": { "$ref": "#/definitions/DeploymentDiagnosticsDefinition" }, "readOnly": true } } }, "WhatIfOperationResult": { "type": "object", "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.", "properties": { "status": { "type": "string", "description": "Status of the What-If operation." }, "properties": { "$ref": "#/definitions/WhatIfOperationProperties", "description": "What-If operation properties.", "x-ms-client-flatten": true }, "error": { "$ref": "#/definitions/ErrorResponse", "description": "Error when What-If operation fails." } } }, "WhatIfPropertyChange": { "type": "object", "description": "The predicted change to the resource property.", "properties": { "path": { "type": "string", "description": "The path of the property." }, "propertyChangeType": { "$ref": "#/definitions/PropertyChangeType", "description": "The type of property change." }, "before": { "description": "The value of the property before the deployment is executed." }, "after": { "description": "The value of the property after the deployment is executed." }, "children": { "type": "array", "description": "Nested property changes.", "items": { "$ref": "#/definitions/WhatIfPropertyChange" }, "x-ms-identifiers": [ "path" ] } }, "required": [ "path", "propertyChangeType" ] }, "WhatIfResultFormat": { "type": "string", "description": "The format of the What-If results", "enum": [ "ResourceIdOnly", "FullResourcePayloads" ], "x-ms-enum": { "name": "WhatIfResultFormat", "modelAsString": false, "values": [ { "name": "ResourceIdOnly", "value": "ResourceIdOnly", "description": "ResourceIdOnly" }, { "name": "FullResourcePayloads", "value": "FullResourcePayloads", "description": "FullResourcePayloads" } ] } }, "ZoneMapping": { "type": "object", "properties": { "location": { "type": "string", "description": "The location of the zone mapping." }, "zones": { "type": "array", "items": { "type": "string" } } } } }, "parameters": {} }