Microsoft.Resources deploymentStacks
Bicep 資源定義
deploymentStacks 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deploymentStacks 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Resources/deploymentStacks@2024-03-01' = {
location: 'string'
name: 'string'
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(Azure.Bicep.Types.Concrete.AnyType)
}
}
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any(Azure.Bicep.Types.Concrete.AnyType)
templateLink: {
contentVersion: 'string'
id: 'string'
queryString: 'string'
relativePath: 'string'
uri: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
屬性值
ActionOnUnmanage
名字 | 描述 | 價值 |
---|---|---|
managementGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
resourceGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
資源 | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' (必要) |
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 主體標識碼清單。 最多允許5個主體。 | string[] |
模式 | denySettings 模式,定義拒絕的動作。 | 'denyDelete' 'denyWriteAndDelete' 'none' (必要) |
DeploymentParameterAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReferenceAutoGenerated |
類型 | 值的型別。 | 字串 |
價值 | 參數的輸入值。 | 任何 |
DeploymentStackProperties
名字 | 描述 | 價值 |
---|---|---|
actionOnUnmanage | 定義部署堆疊更新或刪除之後不再管理的資源行為。 | ActionOnUnmanage (必要) |
bypassStackOutOfSyncError | 旗標以略過指出堆疊資源清單未正確同步處理的服務錯誤。 | bool |
debugSetting | 部署的偵錯設定。 | DeploymentStacksDebugSetting |
denySettings | 定義堆疊所部署的資源鎖定方式。 | DenySettings (必要) |
deploymentScope | 應建立初始部署的範圍。 如果未指定範圍,則會預設為部署堆疊的範圍。 有效範圍包括:管理群組(格式:'/providers/Microsoft.Management/managementGroups/{managementGroupId}')、訂用帳戶(格式:'/subscriptions/{subscriptionId}')、資源群組(格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')。 | 字串 |
描述 | 部署堆棧描述。 最大長度為 4096 個字元。 | 字串 約束: 最大長度 = 4096 |
錯誤 | 錯誤詳細數據。 | ErrorDetail |
參數 | 定義範本部署參數的名稱和值組。 直接在要求中提供參數值時,請使用這個專案,而不是連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStackPropertiesParameters |
parametersLink | 參數檔案的 URI。 使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStacksParametersLink |
範本 | 範本內容。 當您想要直接在要求中傳遞範本語法,而不是連結至現有的範本時,請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | 任何 |
templateLink | 範本的 URI。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesParameters
名字 | 描述 | 價值 |
---|
DeploymentStacksDebugSetting
名字 | 描述 | 價值 |
---|---|---|
detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent,或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時,請仔細考慮部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息,透過部署作業擷取的敏感數據可能會公開。 | 字串 |
DeploymentStacksParametersLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
uri | 參數檔案的 URI。 | 字串 (必要) |
DeploymentStacksTemplateLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
id | 範本規格的 resourceId。請使用識別碼或 uri 屬性,但不能同時使用兩者。 | 字串 |
queryString | 要與 templateLink URI 搭配使用的查詢字串(例如 SAS 令牌)。 | 字串 |
relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結,這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結,子部署將會是父系和 relativePath URI 的組合。 | 字串 |
uri | 要部署之範本的 URI。 使用 uri 或 id 屬性,但不能同時使用兩者。 | 字串 |
DeploymentStackTags
名字 | 描述 | 價值 |
---|
ErrorDetail
名字 | 描述 | 價值 |
---|
KeyVaultParameterReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
keyVault | Azure Key Vault 參考。 | KeyVaultReferenceAutoGenerated (必要) |
secretName | Azure Key Vault 秘密名稱。 | 字串 (必要) |
secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
id | Azure Key Vault resourceId。 | 字串 (必要) |
Microsoft.Resources/deploymentStacks
名字 | 描述 | 價值 |
---|---|---|
位置 | 部署堆疊的位置。 建立之後就無法變更。 它必須是其中一個支援的 Azure 位置。 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 90 模式 = ^[-\w\._\(\)]+$ (必要) |
性能 | 部署堆疊屬性。 | DeploymentStackProperties |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
ARM 樣本資源定義
deploymentStacks 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deploymentStacks 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Resources/deploymentStacks",
"apiVersion": "2024-03-01",
"name": "string",
"location": "string",
"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"
}
},
"tags": {
"{customized property}": "string"
}
}
屬性值
ActionOnUnmanage
名字 | 描述 | 價值 |
---|---|---|
managementGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
resourceGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
資源 | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' (必要) |
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 主體標識碼清單。 最多允許5個主體。 | string[] |
模式 | denySettings 模式,定義拒絕的動作。 | 'denyDelete' 'denyWriteAndDelete' 'none' (必要) |
DeploymentParameterAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReferenceAutoGenerated |
類型 | 值的型別。 | 字串 |
價值 | 參數的輸入值。 | 任何 |
DeploymentStackProperties
名字 | 描述 | 價值 |
---|---|---|
actionOnUnmanage | 定義部署堆疊更新或刪除之後不再管理的資源行為。 | ActionOnUnmanage (必要) |
bypassStackOutOfSyncError | 旗標以略過指出堆疊資源清單未正確同步處理的服務錯誤。 | bool |
debugSetting | 部署的偵錯設定。 | DeploymentStacksDebugSetting |
denySettings | 定義堆疊所部署的資源鎖定方式。 | DenySettings (必要) |
deploymentScope | 應建立初始部署的範圍。 如果未指定範圍,則會預設為部署堆疊的範圍。 有效範圍包括:管理群組(格式:'/providers/Microsoft.Management/managementGroups/{managementGroupId}')、訂用帳戶(格式:'/subscriptions/{subscriptionId}')、資源群組(格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')。 | 字串 |
描述 | 部署堆棧描述。 最大長度為 4096 個字元。 | 字串 約束: 最大長度 = 4096 |
錯誤 | 錯誤詳細數據。 | ErrorDetail |
參數 | 定義範本部署參數的名稱和值組。 直接在要求中提供參數值時,請使用這個專案,而不是連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStackPropertiesParameters |
parametersLink | 參數檔案的 URI。 使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStacksParametersLink |
範本 | 範本內容。 當您想要直接在要求中傳遞範本語法,而不是連結至現有的範本時,請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | 任何 |
templateLink | 範本的 URI。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesParameters
名字 | 描述 | 價值 |
---|
DeploymentStacksDebugSetting
名字 | 描述 | 價值 |
---|---|---|
detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent,或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時,請仔細考慮部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息,透過部署作業擷取的敏感數據可能會公開。 | 字串 |
DeploymentStacksParametersLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
uri | 參數檔案的 URI。 | 字串 (必要) |
DeploymentStacksTemplateLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
id | 範本規格的 resourceId。請使用識別碼或 uri 屬性,但不能同時使用兩者。 | 字串 |
queryString | 要與 templateLink URI 搭配使用的查詢字串(例如 SAS 令牌)。 | 字串 |
relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結,這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結,子部署將會是父系和 relativePath URI 的組合。 | 字串 |
uri | 要部署之範本的 URI。 使用 uri 或 id 屬性,但不能同時使用兩者。 | 字串 |
DeploymentStackTags
名字 | 描述 | 價值 |
---|
ErrorDetail
名字 | 描述 | 價值 |
---|
KeyVaultParameterReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
keyVault | Azure Key Vault 參考。 | KeyVaultReferenceAutoGenerated (必要) |
secretName | Azure Key Vault 秘密名稱。 | 字串 (必要) |
secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
id | Azure Key Vault resourceId。 | 字串 (必要) |
Microsoft.Resources/deploymentStacks
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2024-03-01' |
位置 | 部署堆疊的位置。 建立之後就無法變更。 它必須是其中一個支援的 Azure 位置。 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 90 模式 = ^[-\w\._\(\)]+$ (必要) |
性能 | 部署堆疊屬性。 | DeploymentStackProperties |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 | 資源類型 | 'Microsoft.Resources/deploymentStacks' |
Terraform (AzAPI 提供者) 資源定義
deploymentStacks 資源類型可以使用目標作業來部署:
- 管理群組* 訂用帳戶* 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deploymentStacks 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deploymentStacks@2024-03-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
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"
value = ?
}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
template = ?
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
}
})
}
屬性值
ActionOnUnmanage
名字 | 描述 | 價值 |
---|---|---|
managementGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
resourceGroups | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' |
資源 | 指定新 Unmanaged 資源的動作。 刪除會嘗試從 Azure 刪除資源。 卸離會將資源保留為目前狀態。 | 'delete' 'detach' (必要) |
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 主體標識碼清單。 最多允許5個主體。 | string[] |
模式 | denySettings 模式,定義拒絕的動作。 | 'denyDelete' 'denyWriteAndDelete' 'none' (必要) |
DeploymentParameterAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReferenceAutoGenerated |
類型 | 值的型別。 | 字串 |
價值 | 參數的輸入值。 | 任何 |
DeploymentStackProperties
名字 | 描述 | 價值 |
---|---|---|
actionOnUnmanage | 定義部署堆疊更新或刪除之後不再管理的資源行為。 | ActionOnUnmanage (必要) |
bypassStackOutOfSyncError | 旗標以略過指出堆疊資源清單未正確同步處理的服務錯誤。 | bool |
debugSetting | 部署的偵錯設定。 | DeploymentStacksDebugSetting |
denySettings | 定義堆疊所部署的資源鎖定方式。 | DenySettings (必要) |
deploymentScope | 應建立初始部署的範圍。 如果未指定範圍,則會預設為部署堆疊的範圍。 有效範圍包括:管理群組(格式:'/providers/Microsoft.Management/managementGroups/{managementGroupId}')、訂用帳戶(格式:'/subscriptions/{subscriptionId}')、資源群組(格式:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}')。 | 字串 |
描述 | 部署堆棧描述。 最大長度為 4096 個字元。 | 字串 約束: 最大長度 = 4096 |
錯誤 | 錯誤詳細數據。 | ErrorDetail |
參數 | 定義範本部署參數的名稱和值組。 直接在要求中提供參數值時,請使用這個專案,而不是連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStackPropertiesParameters |
parametersLink | 參數檔案的 URI。 使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性,但不能同時使用兩者。 | DeploymentStacksParametersLink |
範本 | 範本內容。 當您想要直接在要求中傳遞範本語法,而不是連結至現有的範本時,請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | 任何 |
templateLink | 範本的 URI。 使用templateLink屬性或範本屬性,但不能同時使用兩者。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesParameters
名字 | 描述 | 價值 |
---|
DeploymentStacksDebugSetting
名字 | 描述 | 價值 |
---|---|---|
detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent,或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時,請仔細考慮部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息,透過部署作業擷取的敏感數據可能會公開。 | 字串 |
DeploymentStacksParametersLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
uri | 參數檔案的 URI。 | 字串 (必要) |
DeploymentStacksTemplateLink
名字 | 描述 | 價值 |
---|---|---|
contentVersion | 如果包含,則必須符合範本中的 ContentVersion。 | 字串 |
id | 範本規格的 resourceId。請使用識別碼或 uri 屬性,但不能同時使用兩者。 | 字串 |
queryString | 要與 templateLink URI 搭配使用的查詢字串(例如 SAS 令牌)。 | 字串 |
relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結,這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結,子部署將會是父系和 relativePath URI 的組合。 | 字串 |
uri | 要部署之範本的 URI。 使用 uri 或 id 屬性,但不能同時使用兩者。 | 字串 |
DeploymentStackTags
名字 | 描述 | 價值 |
---|
ErrorDetail
名字 | 描述 | 價值 |
---|
KeyVaultParameterReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
keyVault | Azure Key Vault 參考。 | KeyVaultReferenceAutoGenerated (必要) |
secretName | Azure Key Vault 秘密名稱。 | 字串 (必要) |
secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReferenceAutoGenerated
名字 | 描述 | 價值 |
---|---|---|
id | Azure Key Vault resourceId。 | 字串 (必要) |
Microsoft.Resources/deploymentStacks
名字 | 描述 | 價值 |
---|---|---|
位置 | 部署堆疊的位置。 建立之後就無法變更。 它必須是其中一個支援的 Azure 位置。 | 字串 |
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 90 模式 = ^[-\w\._\(\)]+$ (必要) |
性能 | 部署堆疊屬性。 | DeploymentStackProperties |
標籤 | 資源標籤 | 標記名稱和值的字典。 |
類型 | 資源類型 | “Microsoft.Resources/deploymentStacks@2024-03-01” |