swagger: '2.0' info: title: Microsoft Azure DeploymentStacksClient description: >- The APIs listed in this specification can be used to manage deployment stack resources through the Azure Resource Manager. version: 2022-08-01-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow scopes: user_impersonation: impersonate user account paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks: get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksListatresourcegroup description: Lists all the Deployment Stacks within the specified resource group. x-ms-examples: DeploymentStacksList: $ref: ./examples/DeploymentStackResourceGroupList.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns an array of Deployment Stacks. schema: $ref: '#/definitions/DeploymentStackListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentstacks /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks: get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksListatsubscription description: Lists all the Deployment Stacks within the specified subscription. x-ms-examples: DeploymentStacksList: $ref: ./examples/DeploymentStackSubscriptionList.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns an array of Deployment Stacks. schema: $ref: '#/definitions/DeploymentStackListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deploymentstacks /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks: get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksListatmanagementgroup description: Lists all the Deployment Stacks within the specified management group. x-ms-examples: DeploymentStacksList: $ref: ./examples/DeploymentStackManagementGroupList.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns an array of Deployment Stacks. schema: $ref: '#/definitions/DeploymentStackListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' x-ms-pageable: nextLinkName: nextLink summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Resources Deploymentstacks ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName} : put: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksCreateorupdateatresourcegroup x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: Creates or updates a Deployment Stack. x-ms-examples: DeploymentStacksCreateOrUpdate: $ref: ./examples/DeploymentStackResourceGroupCreate.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: deploymentStack in: body required: true schema: $ref: '#/definitions/DeploymentStack' description: Deployment Stack supplied to the operation. responses: '200': description: OK - The Deployment Stack update request has succeeded. schema: $ref: '#/definitions/DeploymentStack' '201': description: Deployment Stack created. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentstacks Deploymentstackname get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksGetatresourcegroup description: Gets a Deployment Stack with a given name. x-ms-examples: DeploymentStacksGet: $ref: ./examples/DeploymentStackResourceGroupGet.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns information about the Deployment Stack. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentstacks Deploymentstackname delete: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksDeleteatresourcegroup description: >- Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: DeploymentStacksDelete: $ref: ./examples/DeploymentStackResourceGroupDelete.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: '#/parameters/DeleteResourceParameter' - $ref: '#/parameters/DeleteResourceGroupParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Deployment Stack deleted. '202': description: Accepted - Check location header for deletion status. headers: Location: type: string '204': description: Deployment Stack does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentstacks Deploymentstackname /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}: put: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksCreateorupdateatsubscription x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: Creates or updates a Deployment Stack. x-ms-examples: DeploymentStacksCreateOrUpdate: $ref: ./examples/DeploymentStackSubscriptionCreate.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: deploymentStack in: body required: true schema: $ref: '#/definitions/DeploymentStack' description: Deployment Stack supplied to the operation. responses: '200': description: OK - The Deployment Stack update request has succeeded. schema: $ref: '#/definitions/DeploymentStack' '201': description: Deployment Stack created. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Resources Deploymentstacks Deploymentstackname get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksGetatsubscription description: Gets a Deployment Stack with a given name. x-ms-examples: DeploymentStacksGet: $ref: ./examples/DeploymentStackSubscriptionGet.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns information about the Deployment Stack. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Resources Deploymentstacks Deploymentstackname delete: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksDeleteatsubscription description: >- Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: DeploymentStacksDelete: $ref: ./examples/DeploymentStackSubscriptionDelete.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: '#/parameters/DeleteResourceParameter' - $ref: '#/parameters/DeleteResourceGroupParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Deployment Stack deleted. '202': description: Accepted - Check location header for deletion status. headers: Location: type: string '204': description: Deployment Stack does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Resources Deploymentstacks Deploymentstackname ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName} : put: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksCreateorupdateatmanagementgroup x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation description: Creates or updates a Deployment Stack. x-ms-examples: DeploymentStacksCreateOrUpdate: $ref: ./examples/DeploymentStackManagementGroupCreate.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: deploymentStack in: body required: true schema: $ref: '#/definitions/DeploymentStack' description: Deployment Stack supplied to the operation. responses: '200': description: OK - The Deployment Stack update request has succeeded. schema: $ref: '#/definitions/DeploymentStack' '201': description: Deployment Stack created. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Put Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Resources Deploymentstacks Deploymentstackname get: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksGetatmanagementgroup description: Gets a Deployment Stack with a given name. x-ms-examples: DeploymentStacksGet: $ref: ./examples/DeploymentStackManagementGroupGet.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Returns information about the Deployment Stack. schema: $ref: '#/definitions/DeploymentStack' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Resources Deploymentstacks Deploymentstackname delete: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksDeleteatmanagementgroup description: >- Deletes a Deployment Stack by name. When operation completes, status code 200 returned without content. x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location x-ms-examples: DeploymentStacksDelete: $ref: ./examples/DeploymentStackManagementGroupDelete.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: '#/parameters/DeleteResourceParameter' - $ref: '#/parameters/DeleteResourceGroupParameter' - $ref: '#/parameters/DeleteManagementGroupParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK - Deployment Stack deleted. '202': description: Accepted - Check location header for deletion status. headers: Location: type: string '204': description: Deployment Stack does not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Delete Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Resources Deploymentstacks Deploymentstackname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate : post: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksExporttemplateatresourcegroup description: Exports the template used to create the deployment stack. x-ms-examples: DeploymentStacksExportTemplate: $ref: ./examples/DeploymentStackExportTemplate.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: >- OK - Returns the Template or TemplateLink payload of the deployment stack. schema: $ref: '#/definitions/DeploymentStackTemplateDefinition' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Resources Deploymentstacks Deploymentstackname Exporttemplate /subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate: post: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksExporttemplateatsubscription description: Exports the template used to create the deployment stack. x-ms-examples: DeploymentStacksExportTemplate: $ref: ./examples/DeploymentStackSubscriptionExportTemplate.json parameters: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: >- OK - Returns the Template or TemplateLink payload of the deployment stack. schema: $ref: '#/definitions/DeploymentStackTemplateDefinition' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Resources Deploymentstacks Deploymentstackname Exporttemplate ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}/exportTemplate : post: tags: - DeploymentStacks operationId: microsoftAzureDeploymentstacksExporttemplateatmanagementgroup description: Exports the template used to create the deployment stack. x-ms-examples: DeploymentStacksExportTemplate: $ref: ./examples/DeploymentStackManagementGroupExportTemplate.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/DeploymentStackNameParameter' - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: >- OK - Returns the Template or TemplateLink payload of the deployment stack. schema: $ref: '#/definitions/DeploymentStackTemplateDefinition' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/DeploymentStacksError' summary: >- Microsoft Azure Post Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Resources Deploymentstacks Deploymentstackname Exporttemplate definitions: DeploymentStack: type: object description: Deployment stack object. allOf: - $ref: '#/definitions/AzureResourceBase' properties: location: type: string x-ms-mutability: - read - create description: >- The location of the deployment stack. It cannot be changed after creation. It must be one of the supported Azure locations. tags: type: object description: Deployment stack resource tags. additionalProperties: type: string properties: description: Deployment stack properties. x-ms-client-flatten: true $ref: '#/definitions/DeploymentStackProperties' DeploymentStackProperties: type: object required: - actionOnUnmanage - denySettings description: Deployment stack properties. allOf: - $ref: '#/definitions/DeploymentStacksError' properties: template: type: object 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. x-ms-mutability: - create - update templateLink: type: object $ref: '#/definitions/DeploymentStacksTemplateLink' description: >- The URI of the template. Use either the templateLink property or the template property, but not both. x-ms-mutability: - create - update parameters: type: object description: >- Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking 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. parametersLink: type: object $ref: '#/definitions/DeploymentStacksParametersLink' description: >- The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. actionOnUnmanage: type: object description: >- Defines the behavior of resources that are not managed immediately after the stack is updated. required: - resources properties: resources: type: string $ref: '#/definitions/DeploymentStacksDeleteDetachEnum' resourceGroups: type: string $ref: '#/definitions/DeploymentStacksDeleteDetachEnum' managementGroups: type: string $ref: '#/definitions/DeploymentStacksDeleteDetachEnum' debugSetting: type: object $ref: '#/definitions/DeploymentStacksDebugSetting' description: The debug setting of the deployment. deploymentScope: type: string description: >- The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). description: type: string maxLength: 4096 description: Deployment stack description. denySettings: type: object description: Defines how resources deployed by the stack are locked. $ref: '#/definitions/DenySettings' provisioningState: type: string readOnly: true description: State of the deployment stack. enum: - Creating - Validating - Waiting - Deploying - Canceling - Locking - DeletingResources - Succeeded - Failed - Canceled - Deleting x-ms-enum: name: DeploymentStackProvisioningState modelAsString: true detachedResources: type: array readOnly: true items: $ref: '#/definitions/ResourceReference' description: >- An array of resources that were detached during the most recent update. deletedResources: type: array readOnly: true items: $ref: '#/definitions/ResourceReference' description: An array of resources that were deleted during the most recent update. failedResources: type: array readOnly: true items: $ref: '#/definitions/ResourceReferenceExtended' description: >- An array of resources that failed to reach goal state during the most recent update. resources: type: array readOnly: true items: $ref: '#/definitions/ManagedResourceReference' description: An array of resources currently managed by the deployment stack. deploymentId: type: string readOnly: true description: >- The resourceId of the deployment resource created by the deployment stack. outputs: type: object readOnly: true description: The outputs of the underlying deployment. duration: type: string readOnly: true description: The duration of the deployment stack update. DeploymentStackListResult: description: List of deployment stacks. type: object properties: value: type: array items: $ref: '#/definitions/DeploymentStack' description: An array of deployment stacks. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. ResourceReference: type: object description: The resource Id model. properties: id: readOnly: true type: string description: The resourceId of a resource managed by the deployment stack. ManagedResourceReference: type: object description: The managed resource model. allOf: - $ref: '#/definitions/ResourceReference' properties: status: type: string default: None description: Current management state of the resource in the deployment stack. enum: - Managed - removeDenyFailed - deleteFailed - None x-ms-enum: name: ResourceStatusMode modelAsString: true values: - value: Managed description: This resource is managed by the deployment stack. - value: removeDenyFailed description: Unable to remove the deny assignment on resource. - value: deleteFailed description: >- Unable to delete the resource from Azure. The delete will be retried on the next stack deployment, or can be deleted manually. - value: None description: No denyAssignments have been applied. denyStatus: type: string default: None description: denyAssignment settings applied to the resource. enum: - denyDelete - notSupported - inapplicable - denyWriteAndDelete - removedBySystem - None x-ms-enum: name: DenyStatusMode modelAsString: true values: - value: denyDelete description: >- Authorized users are able to read and modify the resources, but cannot delete. - value: notSupported description: Resource type does not support denyAssignments. - value: inapplicable description: >- denyAssignments are not supported on resources outside the scope of the deployment stack. - value: denyWriteAndDelete description: >- Authorized users can only read from a resource, but cannot modify or delete it. - value: removedBySystem description: >- Deny assignment has been removed by Azure due to a resource management change (management group move, etc.) - value: None description: No denyAssignments have been applied. ResourceReferenceExtended: type: object allOf: - $ref: '#/definitions/ResourceReference' - $ref: '#/definitions/DeploymentStacksError' description: The resource Id extended model. DenySettings: description: Defines how resources deployed by the deployment stack are locked. type: object required: - mode properties: mode: type: string description: denySettings Mode. enum: - denyDelete - denyWriteAndDelete - none x-ms-enum: name: DenySettingsMode modelAsString: true values: - value: denyDelete description: >- Authorized users are able to read and modify the resources, but cannot delete. - value: denyWriteAndDelete description: >- Authorized users can only read from a resource, but cannot modify or delete it. - value: none description: No denyAssignments have been applied. excludedPrincipals: type: array description: >- List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. items: type: string excludedActions: type: array description: >- List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. items: type: string applyToChildScopes: type: boolean description: DenySettings will be applied to child scopes. AzureResourceBase: x-ms-azure-resource: true type: object description: Common properties for all Azure resources. properties: id: readOnly: true type: string description: String Id used to locate any resource on Azure. name: readOnly: true type: string description: Name of this resource. type: readOnly: true type: string description: Type of this resource. systemData: readOnly: true type: object description: >- Azure Resource Manager metadata containing createdBy and modifiedBy information. $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData DeploymentStacksError: type: object properties: error: $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse description: Deployment Stacks error response. DeploymentStackTemplateDefinition: type: object description: Export Template specific properties of the Stack. properties: template: type: object description: >- The template content. Use this element 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: type: object $ref: '#/definitions/DeploymentStacksTemplateLink' description: >- The URI of the template. Use either the templateLink property or the template property, but not both. DeploymentStacksTemplateLink: type: object 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 queryString: type: string description: >- The query string (for example, a SAS token) to be used with the templateLink URI. contentVersion: type: string description: If included, must match the ContentVersion in the template. description: Entity representing the reference to the template. DeploymentStacksParametersLink: type: object 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 description: Entity representing the reference to the deployment parameters. DeploymentStacksDebugSetting: type: object 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 that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. description: The debug setting. DeploymentStacksDeleteDetachEnum: type: string enum: - delete - detach description: >- Specifies the action that should be taken on the resource when the deployment stack is deleted. Delete will attempt to delete the resource from Azure. Detach will leave the resource in it's current state. x-ms-enum: name: DeploymentStacksDeleteDetachEnum modelAsString: true parameters: ManagementGroupIdParameter: name: managementGroupId in: path required: true type: string pattern: ^[-\w\._\(\)]+$ description: Management Group. minLength: 1 maxLength: 90 x-ms-parameter-location: method DeploymentStackNameParameter: name: deploymentStackName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ description: Name of the deployment stack. minLength: 1 maxLength: 90 x-ms-parameter-location: method DeleteResourceParameter: name: unmanageAction.Resources in: query required: false type: string enum: - delete - detach x-ms-enum: name: UnmanageActionResourceMode modelAsString: true x-ms-parameter-location: method description: Flag to indicate delete rather than detach for the resources. DeleteResourceGroupParameter: name: unmanageAction.ResourceGroups in: query required: false type: string enum: - delete - detach x-ms-enum: name: UnmanageActionResourceGroupMode modelAsString: true x-ms-parameter-location: method description: Flag to indicate delete rather than detach for the resource groups. DeleteManagementGroupParameter: name: unmanageAction.ManagementGroups in: query required: false type: string enum: - delete - detach x-ms-enum: name: UnmanageActionManagementGroupMode modelAsString: true x-ms-parameter-location: method description: Flag to indicate delete rather than detach for the management groups. tags: - name: DeploymentStacks