Microsoft.Resources 部署
言論
針對 Bicep，請考慮使用模組 而非此資源類型
Bicep 資源定義
部署資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deployments 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Resources/deployments@2024-11-01' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
debugSetting: {
detailLevel: 'string'
}
expressionEvaluationOptions: {
scope: 'string'
}
mode: 'string'
onErrorDeployment: {
deploymentName: 'string'
type: 'string'
}
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: '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'
}
validationLevel: 'string'
}
tags: {
{customized property}: 'string'
}
}
屬性值
DebugSetting
| 名字 | 描述 | 價值 |
|---|---|---|
| detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent，或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時，請仔細考慮您在部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息，您可能會公開透過部署作業擷取的敏感數據。 | 字串 |
DeploymentParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReference |
| 價值 | 參數的輸入值。 | 任何 |
DeploymentPropertiesOrDeploymentPropertiesExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| debugSetting | 部署的偵錯設定。 | DebugSetting |
| expressionEvaluationOptions | 指定在父範本或巢狀範本的範圍內評估範本表達式。 僅適用於巢狀範本。 如果未指定，預設值為外部值。 | ExpressionEvaluationOptions |
| 模式 | 用來部署資源的模式。 此值可以是累加式或完成。 在累加模式中，會部署資源，而不刪除範本中未包含的現有資源。 在 [完成] 模式中，會部署資源，且不會包含在範本中的資源群組中現有的資源會遭到刪除。 當您不小心刪除資源時，請小心使用 [完成] 模式。 | 'Complete' 'Incremental' （必要） |
| onErrorDeployment | 錯誤行為的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
| 參數 | 定義範本部署參數的名稱和值組。 當您想要直接在要求中提供參數值，而不是連結至現有的參數檔案時，請使用這個專案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 它可以是 JObject 或格式正確的 JSON 字串。 | DeploymentPropertiesParameters |
| parametersLink | 參數檔案的 URI。 您可以使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 | ParametersLink |
| 範本 | 範本內容。 當您想要直接在要求中傳遞範本語法，而不是連結至現有的範本時，請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | 任何 |
| templateLink | 範本的 URI。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | TemplateLink |
| validationLevel | 部署的驗證層級 | 'Provider' 'ProviderNoRbac' 'Template' |
DeploymentPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
DeploymentTags
| 名字 | 描述 | 價值 |
|---|
ExpressionEvaluationOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| 範圍 | 要用於評估巢狀範本中參數、變數和函式的範圍。 | 'Inner' 'NotSpecified' 'Outer' |
KeyVaultParameterReference
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVault | Azure Key Vault 參考。 | KeyVaultReference （必要） |
| secretName | Azure Key Vault 秘密名稱。 | 字串 （必要） |
| secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | Azure Key Vault 資源標識符。 | 字串 （必要） |
Microsoft.Resources/deployments
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 要儲存部署數據的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[-\w\._\(\)]+$ （必要） |
| 性能 | 部署屬性。 | DeploymentPropertiesOrDeploymentPropertiesExtended （必要） |
| 範圍 | 在與部署範圍不同的範圍內建立資源時，請使用 。 | 將此屬性設定為資源的符號名稱，以套用 擴充資源。 |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
OnErrorDeploymentOrOnErrorDeploymentExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| deploymentName | 要用於錯誤案例的部署。 | 字串 |
| 類型 | 錯誤行為類型的部署。 可能的值為 LastSuccessful 和 SpecificDeployment。 | 'LastSuccessful' 'SpecificDeployment' |
ParametersLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| uri | 參數檔案的 URI。 | 字串 （必要） |
TemplateLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| id | 範本規格的資源識別碼。請使用標識符或 uri 屬性，但不能同時使用兩者。 | 字串 |
| queryString | 要與 templateLink URI 搭配使用的查詢字串（例如 SAS 令牌）。 | 字串 |
| relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結，這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結，子部署將會是父系和 relativePath URI 的組合 | 字串 |
| uri | 要部署之範本的 URI。 使用 uri 或 id 屬性，但不能同時使用兩者。 | 字串 |
ARM 樣本資源定義
部署資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deployments 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2024-11-01",
"name": "string",
"location": "string",
"properties": {
"debugSetting": {
"detailLevel": "string"
},
"expressionEvaluationOptions": {
"scope": "string"
},
"mode": "string",
"onErrorDeployment": {
"deploymentName": "string",
"type": "string"
},
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"queryString": "string",
"relativePath": "string",
"uri": "string"
},
"validationLevel": "string"
},
"tags": {
"{customized property}": "string"
}
}
屬性值
DebugSetting
| 名字 | 描述 | 價值 |
|---|---|---|
| detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent，或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時，請仔細考慮您在部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息，您可能會公開透過部署作業擷取的敏感數據。 | 字串 |
DeploymentParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReference |
| 價值 | 參數的輸入值。 | 任何 |
DeploymentPropertiesOrDeploymentPropertiesExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| debugSetting | 部署的偵錯設定。 | DebugSetting |
| expressionEvaluationOptions | 指定在父範本或巢狀範本的範圍內評估範本表達式。 僅適用於巢狀範本。 如果未指定，預設值為外部值。 | ExpressionEvaluationOptions |
| 模式 | 用來部署資源的模式。 此值可以是累加式或完成。 在累加模式中，會部署資源，而不刪除範本中未包含的現有資源。 在 [完成] 模式中，會部署資源，且不會包含在範本中的資源群組中現有的資源會遭到刪除。 當您不小心刪除資源時，請小心使用 [完成] 模式。 | 'Complete' 'Incremental' （必要） |
| onErrorDeployment | 錯誤行為的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
| 參數 | 定義範本部署參數的名稱和值組。 當您想要直接在要求中提供參數值，而不是連結至現有的參數檔案時，請使用這個專案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 它可以是 JObject 或格式正確的 JSON 字串。 | DeploymentPropertiesParameters |
| parametersLink | 參數檔案的 URI。 您可以使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 | ParametersLink |
| 範本 | 範本內容。 當您想要直接在要求中傳遞範本語法，而不是連結至現有的範本時，請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | 任何 |
| templateLink | 範本的 URI。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | TemplateLink |
| validationLevel | 部署的驗證層級 | 'Provider' 'ProviderNoRbac' 'Template' |
DeploymentPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
DeploymentTags
| 名字 | 描述 | 價值 |
|---|
ExpressionEvaluationOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| 範圍 | 要用於評估巢狀範本中參數、變數和函式的範圍。 | 'Inner' 'NotSpecified' 'Outer' |
KeyVaultParameterReference
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVault | Azure Key Vault 參考。 | KeyVaultReference （必要） |
| secretName | Azure Key Vault 秘密名稱。 | 字串 （必要） |
| secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | Azure Key Vault 資源標識符。 | 字串 （必要） |
Microsoft.Resources/deployments
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2024-11-01' |
| 位置 | 要儲存部署數據的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[-\w\._\(\)]+$ （必要） |
| 性能 | 部署屬性。 | DeploymentPropertiesOrDeploymentPropertiesExtended （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
| 類型 | 資源類型 | 'Microsoft.Resources/deployments' |
OnErrorDeploymentOrOnErrorDeploymentExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| deploymentName | 要用於錯誤案例的部署。 | 字串 |
| 類型 | 錯誤行為類型的部署。 可能的值為 LastSuccessful 和 SpecificDeployment。 | 'LastSuccessful' 'SpecificDeployment' |
ParametersLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| uri | 參數檔案的 URI。 | 字串 （必要） |
TemplateLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| id | 範本規格的資源識別碼。請使用標識符或 uri 屬性，但不能同時使用兩者。 | 字串 |
| queryString | 要與 templateLink URI 搭配使用的查詢字串（例如 SAS 令牌）。 | 字串 |
| relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結，這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結，子部署將會是父系和 relativePath URI 的組合 | 字串 |
| uri | 要部署之範本的 URI。 使用 uri 或 id 屬性，但不能同時使用兩者。 | 字串 |
Terraform （AzAPI 提供者） 資源定義
部署資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Resources/deployments 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deployments@2024-11-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
debugSetting = {
detailLevel = "string"
}
expressionEvaluationOptions = {
scope = "string"
}
mode = "string"
onErrorDeployment = {
deploymentName = "string"
type = "string"
}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
template = ?
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
validationLevel = "string"
}
})
}
屬性值
DebugSetting
| 名字 | 描述 | 價值 |
|---|---|---|
| detailLevel | 指定要記錄以進行偵錯的資訊類型。 允許的值為 none、requestContent、responseContent，或以逗號分隔的 requestContent 和 responseContent。 預設值為 none。 設定此值時，請仔細考慮您在部署期間傳入的信息類型。 藉由記錄要求或回應的相關信息，您可能會公開透過部署作業擷取的敏感數據。 | 字串 |
DeploymentParameter
| 名字 | 描述 | 價值 |
|---|---|---|
| 參考 | Azure Key Vault 參數參考。 | KeyVaultParameterReference |
| 價值 | 參數的輸入值。 | 任何 |
DeploymentPropertiesOrDeploymentPropertiesExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| debugSetting | 部署的偵錯設定。 | DebugSetting |
| expressionEvaluationOptions | 指定在父範本或巢狀範本的範圍內評估範本表達式。 僅適用於巢狀範本。 如果未指定，預設值為外部值。 | ExpressionEvaluationOptions |
| 模式 | 用來部署資源的模式。 此值可以是累加式或完成。 在累加模式中，會部署資源，而不刪除範本中未包含的現有資源。 在 [完成] 模式中，會部署資源，且不會包含在範本中的資源群組中現有的資源會遭到刪除。 當您不小心刪除資源時，請小心使用 [完成] 模式。 | 'Complete' 'Incremental' （必要） |
| onErrorDeployment | 錯誤行為的部署。 | OnErrorDeploymentOrOnErrorDeploymentExtended |
| 參數 | 定義範本部署參數的名稱和值組。 當您想要直接在要求中提供參數值，而不是連結至現有的參數檔案時，請使用這個專案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 它可以是 JObject 或格式正確的 JSON 字串。 | DeploymentPropertiesParameters |
| parametersLink | 參數檔案的 URI。 您可以使用這個項目連結至現有的參數檔案。 使用parametersLink屬性或parameters屬性，但不能同時使用兩者。 | ParametersLink |
| 範本 | 範本內容。 當您想要直接在要求中傳遞範本語法，而不是連結至現有的範本時，請使用這個專案。 它可以是 JObject 或格式正確的 JSON 字串。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | 任何 |
| templateLink | 範本的 URI。 使用templateLink屬性或範本屬性，但不能同時使用兩者。 | TemplateLink |
| validationLevel | 部署的驗證層級 | 'Provider' 'ProviderNoRbac' 'Template' |
DeploymentPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
DeploymentTags
| 名字 | 描述 | 價值 |
|---|
ExpressionEvaluationOptions
| 名字 | 描述 | 價值 |
|---|---|---|
| 範圍 | 要用於評估巢狀範本中參數、變數和函式的範圍。 | 'Inner' 'NotSpecified' 'Outer' |
KeyVaultParameterReference
| 名字 | 描述 | 價值 |
|---|---|---|
| keyVault | Azure Key Vault 參考。 | KeyVaultReference （必要） |
| secretName | Azure Key Vault 秘密名稱。 | 字串 （必要） |
| secretVersion | Azure Key Vault 秘密版本。 | 字串 |
KeyVaultReference
| 名字 | 描述 | 價值 |
|---|---|---|
| id | Azure Key Vault 資源標識符。 | 字串 （必要） |
Microsoft.Resources/deployments
| 名字 | 描述 | 價值 |
|---|---|---|
| 位置 | 要儲存部署數據的位置。 | 字串 |
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[-\w\._\(\)]+$ （必要） |
| parent_id | 要套用此延伸模組資源之資源的標識碼。 | 字串 （必要） |
| 性能 | 部署屬性。 | DeploymentPropertiesOrDeploymentPropertiesExtended （必要） |
| 標籤 | 資源標籤 | 標記名稱和值的字典。 |
| 類型 | 資源類型 | “Microsoft.Resources/deployments@2024-11-01” |
OnErrorDeploymentOrOnErrorDeploymentExtended
| 名字 | 描述 | 價值 |
|---|---|---|
| deploymentName | 要用於錯誤案例的部署。 | 字串 |
| 類型 | 錯誤行為類型的部署。 可能的值為 LastSuccessful 和 SpecificDeployment。 | 'LastSuccessful' 'SpecificDeployment' |
ParametersLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| uri | 參數檔案的 URI。 | 字串 （必要） |
TemplateLink
| 名字 | 描述 | 價值 |
|---|---|---|
| contentVersion | 如果包含，則必須符合範本中的 ContentVersion。 | 字串 |
| id | 範本規格的資源識別碼。請使用標識符或 uri 屬性，但不能同時使用兩者。 | 字串 |
| queryString | 要與 templateLink URI 搭配使用的查詢字串（例如 SAS 令牌）。 | 字串 |
| relativePath | relativePath 屬性可用來在相對於父代的位置部署連結的範本。 如果父範本與 TemplateSpec 連結，這會參考 TemplateSpec 中的成品。 如果父系與 URI 連結，子部署將會是父系和 relativePath URI 的組合 | 字串 |
| uri | 要部署之範本的 URI。 使用 uri 或 id 屬性，但不能同時使用兩者。 | 字串 |