你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Resources deploymentStacks 2024-03-01
Bicep 资源定义
deploymentStacks 资源类型可以使用面向以下对象的操作进行部署：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Resources/deploymentStacks 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Resources/deploymentStacks@2024-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actionOnUnmanage: {
managementGroups: 'string'
resourceGroups: 'string'
resources: 'string'
}
bypassStackOutOfSyncError: bool
debugSetting: {
detailLevel: 'string'
}
denySettings: {
applyToChildScopes: bool
excludedActions: [
'string'
]
excludedPrincipals: [
'string'
]
mode: 'string'
}
deploymentScope: 'string'
description: 'string'
error: {}
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
type: 'string'
value: any()
}
}
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any()
templateLink: {
contentVersion: 'string'
id: 'string'
queryString: 'string'
relativePath: 'string'
uri: 'string'
}
}
}
属性值
deploymentStacks
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 | 字符串 (必需) |
| location | 部署堆栈的位置。 创建后无法更改它。 它必须是受支持的 Azure 位置之一。 | 字符串 |
| 标记 | 部署堆栈资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| properties | 部署堆栈属性。 | DeploymentStackProperties |
DeploymentStackProperties
| 名称 | 说明 | 值 |
|---|---|---|
| actionOnUnmanage | 定义更新或删除部署堆栈后不再管理的资源的行为。 | 需要 ActionOnUnmanage () |
| bypassStackOutOfSyncError | 用于绕过指示堆栈资源列表未正确同步的服务错误的标志。 | bool |
| debugSetting | 部署的调试设置。 | DeploymentStacksDebugSetting |
| denySettings | 定义如何锁定堆栈部署的资源。 | DenySettings (必需) |
| deploymentScope | 初始部署的创建范围。 如果未指定范围，它将默认为部署堆栈的范围。 有效作用域为：管理组 (格式：“/providers/Microsoft.Management/managementGroups/{managementGroupId}”) ，订阅 (格式：“/subscriptions/{subscriptionId}”) ，资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”) 。 | 字符串 |
| description | 部署堆栈说明。 最大长度为 4096 个字符。 | 字符串 约束： 最大长度 = 4096 |
| error | 错误详细信息。 | ErrorDetail |
| parameters | 定义模板部署参数的名称和值对。 直接在请求中提供参数值时使用此元素，而不是链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStackPropertiesParameters |
| parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStacksParametersLink |
| template | 模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | 对于 Bicep，可以使用 任何 () 函数。 |
| templateLink | 模板的 URI。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | DeploymentStacksTemplateLink |
ActionOnUnmanage
| 名称 | 说明 | 值 |
|---|---|---|
| managementGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | 'delete' “detach” |
| resourceGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | 'delete' “detach” |
| resources | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | 'delete' 需要“分离” () |
DeploymentStacksDebugSetting
| 名称 | 说明 | 值 |
|---|---|---|
| detailLevel | 指定要记录用于调试的信息的类型。 允许的值为 none、requestContent、responseContent 或 requestContent 和 responseContent（用逗号分隔）。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的敏感数据。 | 字符串 |
DenySettings
| 名称 | 说明 | 值 |
|---|---|---|
| applyToChildScopes | DenySettings 将应用于具有拒绝分配的每个托管资源的子资源范围。 | bool |
| excludedActions | 从 denySettings 中排除的基于角色的管理操作的列表。 最多允许 200 次操作。 如果 denySetting 模式设置为“denyWriteAndDelete”，则以下操作会自动追加到“excludedActions”：“*/read”和“Microsoft.Authorization/locks/delete”。 如果 denySetting 模式设置为“denyDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从锁中排除的 AAD 主体 ID 的列表。 最多允许 5 个主体。 | string[] |
| mode | denySettings 模式，用于定义拒绝的操作。 | 'denyDelete' 'denyWriteAndDelete' “none” (必需) |
ErrorDetail
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DeploymentStackPropertiesParameters
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DeploymentParameterAutoGenerated |
DeploymentParameterAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| reference | Azure 密钥保管库 参数参考。 | KeyVaultParameterReferenceAutoGenerated |
| 类型 | 值的类型。 | string |
| value | 参数的输入值。 | 对于 Bicep，可以使用 任何 () 函数。 |
KeyVaultParameterReferenceAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| keyVault | Azure 密钥保管库参考。 | 需要 KeyVaultReferenceAutoGenerated () |
| secretName | Azure 密钥保管库机密名称。 | 字符串 (必需) |
| secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReferenceAutoGenerated
| 名称 | 说明 | Value |
|---|---|---|
| id | Azure 密钥保管库 resourceId。 | 字符串 (必需) |
DeploymentStacksParametersLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | 字符串 |
| uri | 参数文件的 URI。 | 字符串 (必需) |
DeploymentStacksTemplateLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | string |
| id | Template Spec 的 resourceId。请使用 id 或 uri 属性，但不能同时使用两者。 | 字符串 |
| queryString | 查询字符串 (例如，) 用于 templateLink URI 的 SAS 令牌。 | 字符串 |
| relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，这将引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合。 | 字符串 |
| uri | 要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。 | 字符串 |
ARM 模板资源定义
deploymentStacks 资源类型可以使用面向以下对象的操作进行部署：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Resources/deploymentStacks 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Resources/deploymentStacks",
"apiVersion": "2024-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actionOnUnmanage": {
"managementGroups": "string",
"resourceGroups": "string",
"resources": "string"
},
"bypassStackOutOfSyncError": "bool",
"debugSetting": {
"detailLevel": "string"
},
"denySettings": {
"applyToChildScopes": "bool",
"excludedActions": [ "string" ],
"excludedPrincipals": [ "string" ],
"mode": "string"
},
"deploymentScope": "string",
"description": "string",
"error": {},
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"type": "string",
"value": {}
}
},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"queryString": "string",
"relativePath": "string",
"uri": "string"
}
}
}
属性值
deploymentStacks
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.Resources/deploymentStacks' |
| apiVersion | 资源 API 版本 | '2024-03-01' |
| name | 资源名称 | 字符串 (必需) |
| location | 部署堆栈的位置。 创建后无法更改它。 它必须是受支持的 Azure 位置之一。 | 字符串 |
| 标记 | 部署堆栈资源标记。 | 标记名称和值的字典。 请参阅 模板中的标记 |
| properties | 部署堆栈属性。 | DeploymentStackProperties |
DeploymentStackProperties
| 名称 | 说明 | 值 |
|---|---|---|
| actionOnUnmanage | 定义更新或删除部署堆栈后不再管理的资源的行为。 | 需要 ActionOnUnmanage () |
| bypassStackOutOfSyncError | 用于绕过指示堆栈资源列表未正确同步的服务错误的标志。 | bool |
| debugSetting | 部署的调试设置。 | DeploymentStacksDebugSetting |
| denySettings | 定义如何锁定堆栈部署的资源。 | DenySettings (必需) |
| deploymentScope | 初始部署的创建范围。 如果未指定范围，它将默认为部署堆栈的范围。 有效作用域为：管理组 (格式：“/providers/Microsoft.Management/managementGroups/{managementGroupId}”) ，订阅 (格式：“/subscriptions/{subscriptionId}”) ，资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”) 。 | 字符串 |
| description | 部署堆栈说明。 最大长度为 4096 个字符。 | 字符串 约束： 最大长度 = 4096 |
| error | 错误详细信息。 | ErrorDetail |
| parameters | 定义模板部署参数的名称和值对。 直接在请求中提供参数值时使用此元素，而不是链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStackPropertiesParameters |
| parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStacksParametersLink |
| template | 模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | |
| templateLink | 模板的 URI。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | DeploymentStacksTemplateLink |
ActionOnUnmanage
| 名称 | 说明 | 值 |
|---|---|---|
| managementGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持其当前状态。 | “delete” “detach” |
| resourceGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持其当前状态。 | “delete” “detach” |
| resources | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持其当前状态。 | “delete” “detach” (必需的) |
DeploymentStacksDebugSetting
| 名称 | 说明 | 值 |
|---|---|---|
| detailLevel | 指定要记录用于调试的信息类型。 允许的值是 none、requestContent、responseContent，或者用逗号分隔的 requestContent 和 responseContent。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的敏感数据。 | 字符串 |
DenySettings
| 名称 | 说明 | 值 |
|---|---|---|
| applyToChildScopes | DenySettings 将应用于具有拒绝分配的每个托管资源的子资源范围。 | bool |
| excludedActions | 从 denySettings 中排除的基于角色的管理操作的列表。 最多允许 200 次操作。 如果 denySetting 模式设置为“denyWriteAndDelete”，则以下操作将自动追加到“excludedActions”：“*/read”和“Microsoft.Authorization/locks/delete”。 如果 denySetting 模式设置为“denyDelete”，则以下操作将自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从锁中排除的 AAD 主体 ID 列表。 最多允许 5 个主体。 | string[] |
| mode | denySettings 模式，用于定义拒绝的操作。 | “denyDelete” “denyWriteAndDelete” “none” (必需) |
ErrorDetail
此对象不包含在部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DeploymentStackPropertiesParameters
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DeploymentParameterAutoGenerated |
DeploymentParameterAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| reference | Azure 密钥保管库参数参考。 | KeyVaultParameterReferenceAutoGenerated |
| 类型 | 值的类型。 | string |
| value | 参数的输入值。 |
KeyVaultParameterReferenceAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| keyVault | Azure 密钥保管库参考。 | 需要 KeyVaultReferenceAutoGenerated () |
| secretName | Azure 密钥保管库机密名称。 | 字符串 (必需) |
| secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReferenceAutoGenerated
| 名称 | 说明 | Value |
|---|---|---|
| id | Azure 密钥保管库 resourceId。 | 字符串 (必需) |
DeploymentStacksParametersLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | 字符串 |
| uri | 参数文件的 URI。 | 字符串 (必需) |
DeploymentStacksTemplateLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | string |
| id | Template Spec 的 resourceId。请使用 id 或 uri 属性，但不能同时使用两者。 | 字符串 |
| queryString | 查询字符串 (例如，) 用于 templateLink URI 的 SAS 令牌。 | 字符串 |
| relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，这将引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合。 | 字符串 |
| uri | 要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
deploymentStacks 资源类型可以使用面向以下对象的操作进行部署：
- 管理组
- 订阅
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.Resources/deploymentStacks 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deploymentStacks@2024-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actionOnUnmanage = {
managementGroups = "string"
resourceGroups = "string"
resources = "string"
}
bypassStackOutOfSyncError = bool
debugSetting = {
detailLevel = "string"
}
denySettings = {
applyToChildScopes = bool
excludedActions = [
"string"
]
excludedPrincipals = [
"string"
]
mode = "string"
}
deploymentScope = "string"
description = "string"
error = {}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
type = "string"
}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
}
})
}
属性值
deploymentStacks
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.Resources/deploymentStacks@2024-03-01” |
| name | 资源名称 | 字符串 (必需) |
| location | 部署堆栈的位置。 创建后无法更改它。 它必须是受支持的 Azure 位置之一。 | 字符串 |
| parent_id | 若要部署到管理组，请使用该管理组的 ID。 若要部署到订阅，请使用该订阅的 ID。 若要部署到资源组，请使用该资源组的 ID。 | 字符串 (必需) |
| 标记 | 部署堆栈资源标记。 | 标记名称和值的字典。 |
| properties | 部署堆栈属性。 | DeploymentStackProperties |
DeploymentStackProperties
| 名称 | 说明 | 值 |
|---|---|---|
| actionOnUnmanage | 定义更新或删除部署堆栈后不再管理的资源的行为。 | 需要 ActionOnUnmanage () |
| bypassStackOutOfSyncError | 用于绕过指示堆栈资源列表未正确同步的服务错误的标志。 | bool |
| debugSetting | 部署的调试设置。 | DeploymentStacksDebugSetting |
| denySettings | 定义如何锁定堆栈部署的资源。 | DenySettings (必需) |
| deploymentScope | 初始部署的创建范围。 如果未指定范围，它将默认为部署堆栈的范围。 有效作用域为：管理组 (格式：“/providers/Microsoft.Management/managementGroups/{managementGroupId}”) ，订阅 (格式：“/subscriptions/{subscriptionId}”) ，资源组 (格式：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}”) 。 | 字符串 |
| description | 部署堆栈说明。 最大长度为 4096 个字符。 | 字符串 约束： 最大长度 = 4096 |
| error | 错误详细信息。 | ErrorDetail |
| parameters | 定义模板部署参数的名称和值对。 直接在请求中提供参数值时使用此元素，而不是链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStackPropertiesParameters |
| parametersLink | 参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 | DeploymentStacksParametersLink |
| template | 模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | |
| templateLink | 模板的 URI。 使用 templateLink 属性或 template 属性，但不能同时使用两者。 | DeploymentStacksTemplateLink |
ActionOnUnmanage
| 名称 | 说明 | 值 |
|---|---|---|
| managementGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | “delete” “detach” |
| resourceGroups | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | “delete” “detach” |
| resources | 指定新非托管资源的操作。 删除将尝试从 Azure 中删除资源。 分离将使资源保持当前状态。 | “delete” 需要“分离” () |
DeploymentStacksDebugSetting
| 名称 | 说明 | 值 |
|---|---|---|
| detailLevel | 指定要记录用于调试的信息的类型。 允许的值为 none、requestContent、responseContent 或 requestContent 和 responseContent（用逗号分隔）。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的敏感数据。 | 字符串 |
DenySettings
| 名称 | 说明 | 值 |
|---|---|---|
| applyToChildScopes | DenySettings 将应用于具有拒绝分配的每个托管资源的子资源范围。 | bool |
| excludedActions | 从 denySettings 中排除的基于角色的管理操作的列表。 最多允许 200 次操作。 如果 denySetting 模式设置为“denyWriteAndDelete”，则以下操作会自动追加到“excludedActions”：“*/read”和“Microsoft.Authorization/locks/delete”。 如果 denySetting 模式设置为“denyDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。 将删除重复的操作。 | string[] |
| excludedPrincipals | 从锁中排除的 AAD 主体 ID 的列表。 最多允许 5 个主体。 | string[] |
| mode | denySettings 模式，用于定义拒绝的操作。 | “denyDelete” “denyWriteAndDelete” “none” (必需) |
ErrorDetail
此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。
DeploymentStackPropertiesParameters
| 名称 | 说明 | 值 |
|---|---|---|
| {customized property} | DeploymentParameterAutoGenerated |
DeploymentParameterAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| reference | Azure 密钥保管库 参数参考。 | KeyVaultParameterReferenceAutoGenerated |
| 类型 | 值的类型。 | string |
| value | 参数的输入值。 |
KeyVaultParameterReferenceAutoGenerated
| 名称 | 说明 | 值 |
|---|---|---|
| keyVault | Azure 密钥保管库参考。 | 需要 KeyVaultReferenceAutoGenerated () |
| secretName | Azure 密钥保管库机密名称。 | 字符串 (必需) |
| secretVersion | Azure Key Vault 机密版本。 | 字符串 |
KeyVaultReferenceAutoGenerated
| 名称 | 说明 | Value |
|---|---|---|
| id | Azure 密钥保管库 resourceId。 | 字符串 (必需) |
DeploymentStacksParametersLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | 字符串 |
| uri | 参数文件的 URI。 | 字符串 (必需) |
DeploymentStacksTemplateLink
| 名称 | 说明 | 值 |
|---|---|---|
| contentVersion | 如果包含，则必须与模板中的 ContentVersion 匹配。 | string |
| id | 模板规格的 resourceId。使用 ID 或 uri 属性，但不能同时使用两者。 | 字符串 |
| queryString | 例如，查询字符串 (要与 templateLink URI 一起使用的 SAS 令牌) 。 | 字符串 |
| relativePath | relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父 URI 和 relativePath URI 的组合。 | 字符串 |
| uri | 要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。 | 字符串 |