你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Deployment Stacks - Create Or Update At Subscription

创建或更新部署堆栈。

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deploymentStacks/{deploymentStackName}?api-version=2022-08-01-preview

URI 参数

名称 必需 类型 说明
deploymentStackName
path True

string

部署堆栈的名称。

正则表达式模式: ^[-\w\._\(\)]+$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
properties.actionOnUnmanage True

ActionOnUnmanage

定义在堆栈更新后未立即管理的资源的行为。

properties.denySettings True

DenySettings

定义如何锁定堆栈部署的资源。

location

string

部署堆栈的位置。 创建后无法更改它。 它必须是受支持的 Azure 位置之一。

properties.debugSetting

DeploymentStacksDebugSetting

部署的调试设置。

properties.deploymentScope

string

初始部署的创建范围。 如果未指定范围,它将默认为部署堆栈的范围。 有效作用域为:管理组 (格式:'/providers/Microsoft.Management/managementGroups/{managementGroupId}') ,订阅 (格式:'/subscriptions/{subscriptionId}') ,资源组 (格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') 。

properties.description

string

部署堆栈说明。

properties.error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

properties.parameters

object

定义模板部署参数的名称和值对。 在请求中直接提供参数值时使用此元素,而不是链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。

properties.parametersLink

DeploymentStacksParametersLink

参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。

properties.template

object

模板内容。 如果要直接在请求中传递模板语法,而不是链接到现有模板,请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性,但不能同时使用两者。

properties.templateLink

DeploymentStacksTemplateLink

模板的 URI。 使用 templateLink 属性或模板属性,但不能同时使用两者。

tags

object

部署堆栈资源标记。

响应

名称 类型 说明
200 OK

DeploymentStack

正常 - 部署堆栈更新请求已成功。

201 Created

DeploymentStack

已创建部署堆栈。

Other Status Codes

DeploymentStacksError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

DeploymentStacksCreateOrUpdate

示例请求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack?api-version=2022-08-01-preview

{
  "location": "eastus",
  "tags": {
    "tagkey": "tagVal"
  },
  "properties": {
    "actionOnUnmanage": {
      "resources": "delete",
      "resourceGroups": "delete",
      "managementGroups": "detach"
    },
    "denySettings": {
      "mode": "denyDelete",
      "excludedPrincipals": [
        "principal"
      ],
      "excludedActions": [
        "action"
      ],
      "applyToChildScopes": false
    },
    "parameters": {
      "parameter1": {
        "value": "a string"
      }
    }
  }
}

示例响应

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/deploymentStacksRG/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack",
  "type": "Microsoft.Resources/deploymentStacks",
  "name": "simpleDeploymentStack",
  "location": "eastus",
  "tags": {
    "tagkey": "tagVal"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  },
  "properties": {
    "description": "my Description",
    "actionOnUnmanage": {
      "resources": "delete",
      "resourceGroups": "delete",
      "managementGroups": "detach"
    },
    "denySettings": {
      "mode": "denyDelete",
      "excludedPrincipals": [
        "principal"
      ],
      "excludedActions": [
        "action"
      ],
      "applyToChildScopes": false
    },
    "parameters": {
      "parameter1": {
        "value": "a string"
      }
    },
    "provisioningState": "Creating"
  }
}
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/deploymentStacksRG/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack",
  "type": "Microsoft.Resources/deploymentStacks",
  "name": "simpleDeploymentStack",
  "location": "eastus",
  "tags": {
    "tagkey": "tagVal"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "Application",
    "createdAt": "2020-02-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "Application",
    "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
  },
  "properties": {
    "description": "my Description",
    "actionOnUnmanage": {
      "resources": "delete",
      "resourceGroups": "delete",
      "managementGroups": "detach"
    },
    "denySettings": {
      "mode": "denyDelete",
      "excludedPrincipals": [
        "principal"
      ],
      "excludedActions": [
        "action"
      ],
      "applyToChildScopes": false
    },
    "parameters": {
      "parameter1": {
        "value": "a string"
      }
    },
    "provisioningState": "Creating"
  }
}

定义

名称 说明
ActionOnUnmanage

定义更新堆栈后未立即管理的资源的行为。

createdByType

创建资源的标识类型。

DenySettings

定义如何锁定部署堆栈部署的资源。

DenySettingsMode

denySettings 模式。

DenyStatusMode

denyAssignment 设置应用于资源。

DeploymentStack

部署堆栈对象。

DeploymentStackProvisioningState

部署堆栈的状态。

DeploymentStacksDebugSetting

调试设置。

DeploymentStacksDeleteDetachEnum

指定删除部署堆栈时应对资源执行的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持其当前状态。

DeploymentStacksError

部署堆栈错误响应。

DeploymentStacksParametersLink

表示对部署参数的引用的实体。

DeploymentStacksTemplateLink

表示对该模板的引用的实体。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

ManagedResourceReference

托管资源模型。

ResourceReference

资源 ID 模型。

ResourceReferenceExtended

资源 ID 扩展模型。

ResourceStatusMode

部署堆栈中资源的当前管理状态。

systemData

与资源的创建和上次修改相关的元数据。

ActionOnUnmanage

定义更新堆栈后未立即管理的资源的行为。

名称 类型 说明
managementGroups

DeploymentStacksDeleteDetachEnum

指定删除部署堆栈时应对资源执行的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。

resourceGroups

DeploymentStacksDeleteDetachEnum

指定删除部署堆栈时应对资源执行的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。

resources

DeploymentStacksDeleteDetachEnum

指定删除部署堆栈时应对资源执行的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DenySettings

定义如何锁定部署堆栈部署的资源。

名称 类型 说明
applyToChildScopes

boolean

DenySettings 将应用于子范围。

excludedActions

string[]

从 denySettings 中排除的基于角色的管理操作的列表。 最多允许 200 次操作。 如果 denySetting 模式设置为“denyWriteAndDelete”,则以下操作会自动追加到“excludedActions”:“*/read”和“Microsoft.Authorization/locks/delete”。 如果 denySetting 模式设置为“denyDelete”,则以下操作会自动追加到“excludedActions”:“Microsoft.Authorization/locks/delete”。 将删除重复的操作。

excludedPrincipals

string[]

从锁中排除的 AAD 主体 ID 的列表。 最多允许 5 个主体。

mode

DenySettingsMode

denySettings 模式。

DenySettingsMode

denySettings 模式。

名称 类型 说明
denyDelete

string

授权用户能够读取和修改资源,但无法删除。

denyWriteAndDelete

string

授权用户只能从资源进行读取,但不能修改或删除资源。

none

string

未应用 denyAssignments。

DenyStatusMode

denyAssignment 设置应用于资源。

名称 类型 说明
None

string

未应用 denyAssignments。

denyDelete

string

授权用户能够读取和修改资源,但无法删除。

denyWriteAndDelete

string

授权用户只能从资源进行读取,但不能修改或删除资源。

inapplicable

string

部署堆栈范围之外的资源不支持 denyAssignments。

notSupported

string

资源类型不支持 denyAssignments。

removedBySystem

string

由于资源管理更改 (管理组移动等原因,Azure 删除了拒绝分配 )

DeploymentStack

部署堆栈对象。

名称 类型 说明
id

string

用于在 Azure 上查找任何资源的字符串 ID。

location

string

部署堆栈的位置。 创建后无法更改它。 它必须是受支持的 Azure 位置之一。

name

string

此资源的名称。

properties.actionOnUnmanage

ActionOnUnmanage

定义更新堆栈后未立即管理的资源的行为。

properties.debugSetting

DeploymentStacksDebugSetting

部署的调试设置。

properties.deletedResources

ResourceReference[]

在最近更新期间删除的资源数组。

properties.denySettings

DenySettings

定义如何锁定堆栈部署的资源。

properties.deploymentId

string

部署堆栈创建的部署资源的 resourceId。

properties.deploymentScope

string

初始部署的创建范围。 如果未指定范围,它将默认为部署堆栈的范围。 有效作用域为:管理组 (格式:“/providers/Microsoft.Management/managementGroups/{managementGroupId}”) ,订阅 (格式:“/subscriptions/{subscriptionId}”) ,资源组 (格式:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”) 。

properties.description

string

部署堆栈说明。

properties.detachedResources

ResourceReference[]

在最近更新期间分离的资源数组。

properties.duration

string

部署堆栈更新的持续时间。

properties.error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

properties.failedResources

ResourceReferenceExtended[]

在最近更新期间未能达到目标状态的资源数组。

properties.outputs

object

基础部署的输出。

properties.parameters

object

定义模板部署参数的名称和值对。 直接在请求中提供参数值时使用此元素,而不是链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。

properties.parametersLink

DeploymentStacksParametersLink

参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性,但不能同时使用两者。

properties.provisioningState

DeploymentStackProvisioningState

部署堆栈的状态。

properties.resources

ManagedResourceReference[]

当前由部署堆栈管理的资源数组。

properties.template

object

模板内容。 如果要直接在请求中传递模板语法,而不是链接到现有模板,请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或 template 属性,但不能同时使用两者。

properties.templateLink

DeploymentStacksTemplateLink

模板的 URI。 使用 templateLink 属性或 template 属性,但不能同时使用两者。

systemData

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。

tags

object

部署堆栈资源标记。

type

string

此资源的类型。

DeploymentStackProvisioningState

部署堆栈的状态。

名称 类型 说明
Canceled

string

Canceling

string

Creating

string

Deleting

string

DeletingResources

string

Deploying

string

Failed

string

Locking

string

Succeeded

string

Validating

string

Waiting

string

DeploymentStacksDebugSetting

调试设置。

名称 类型 说明
detailLevel

string

指定要记录用于调试的信息的类型。 允许的值为 none、requestContent、responseContent 或 requestContent 和 responseContent(用逗号分隔)。 默认值为 none。 设置此值时,请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息,可能会公开通过部署操作检索的敏感数据。

DeploymentStacksDeleteDetachEnum

指定删除部署堆栈时应对资源执行的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持其当前状态。

名称 类型 说明
delete

string

detach

string

DeploymentStacksError

部署堆栈错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

表示对部署参数的引用的实体。

名称 类型 说明
contentVersion

string

如果包含,则必须与模板中的 ContentVersion 匹配。

uri

string

参数文件的 URI。

表示对该模板的引用的实体。

名称 类型 说明
contentVersion

string

如果包含,则必须与模板中的 ContentVersion 匹配。

id

string

模板规格的资源 ID。请使用 id 或 uri 属性,但不能同时使用两者。

queryString

string

查询字符串 (例如,) 用于 templateLink URI 的 SAS 令牌。

relativePath

string

relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接,这将引用 TemplateSpec 中的项目。 如果父级与 URI 链接,则子部署将是父级和 relativePath URI 的组合

uri

string

要部署的模板的 URI。 使用 uri 或 id 属性,但不能同时使用两者。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

ManagedResourceReference

托管资源模型。

名称 类型 默认值 说明
denyStatus

DenyStatusMode

None

应用于资源的 denyAssignment 设置。

id

string

由部署堆栈管理的资源的 resourceId。

status

ResourceStatusMode

None

部署堆栈中资源的当前管理状态。

ResourceReference

资源 ID 模型。

名称 类型 说明
id

string

由部署堆栈管理的资源的 resourceId。

ResourceReferenceExtended

资源 ID 扩展模型。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

id

string

由部署堆栈管理的资源的 resourceId。

ResourceStatusMode

部署堆栈中资源的当前管理状态。

名称 类型 说明
Managed

string

此资源由部署堆栈管理。

None

string

未应用 denyAssignments。

deleteFailed

string

无法从 Azure 中删除资源。 将在下一个堆栈部署中重试删除,也可以手动删除。

removeDenyFailed

string

无法删除资源的拒绝分配。

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。