Microsoft.Blueprint 藍圖
Bicep 資源定義
藍圖資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Blueprint/blueprints@2018-11-01-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
description: 'string'
displayName: 'string'
parameters: {
{customized property}: {
allowedValues: [
any(Azure.Bicep.Types.Concrete.AnyType)
]
defaultValue: any(Azure.Bicep.Types.Concrete.AnyType)
metadata: {
description: 'string'
displayName: 'string'
strongType: 'string'
}
type: 'string'
}
}
resourceGroups: {
{customized property}: {
dependsOn: [
'string'
]
location: 'string'
metadata: {
description: 'string'
displayName: 'string'
strongType: 'string'
}
name: 'string'
tags: {
{customized property}: 'string'
}
}
}
targetScope: 'string'
versions: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
屬性值
BlueprintProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 多行說明此資源。 | 字串 約束： 最大長度 = |
| displayName | 單行字串說明此資源。 | 字串 約束： 最大長度 = |
| 參數 | 此藍圖定義所需的參數。 | SharedBlueprintPropertiesParameters |
| resourceGroups | 此藍圖定義所定義的資源群組佔位元。 | SharedBlueprintPropertiesResourceGroups |
| targetScope | 可以指派此藍圖定義的範圍。 | 'managementGroup' 'subscription' |
| 版本 | 此藍圖定義的已發佈版本。 | 任何 |
Microsoft.Blueprint/blueprints
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 藍圖定義的詳細屬性。 | BlueprintProperties （必要） |
| 範圍 | 在與部署範圍不同的範圍內建立資源時，請使用 。 | 將此屬性設定為資源的符號名稱，以套用 擴充資源。 |
ParameterDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 此參數允許值的陣列。 | any[] |
| defaultValue | 此參數的預設值。 | 任何 |
| 元數據 | 此參數的用戶易記屬性。 | ParameterDefinitionMetadata |
| 類型 | Resource Manager 樣本參數允許的數據類型。 | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要） |
ParameterDefinitionMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 此參數/resourceGroup 的描述。 | 字串 約束： 最大長度 = |
| displayName | 此參數/resourceGroup 的 DisplayName。 | 字串 約束： 最大長度 = |
| strongType | 要讓UI在藍圖指派期間呈現豐富體驗的 StrongType。 支援的強類型為 resourceType、principalId 和 location。 | 字串 約束： 最大長度 = |
ResourceGroupDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| dependsOn | 需要在此資源群組之前部署的成品。 | string[] |
| 位置 | 此 resourceGroup 的位置。 如果在藍圖指派期間指定資源群組位置，則保留空白。 | 字串 |
| 元數據 | 此資源群組的用戶易記屬性。 | ParameterDefinitionMetadata |
| 名字 | 此 resourceGroup 的名稱。 如果在藍圖指派期間指定資源組名，則保留空白。 | 字串 |
| 標籤 | 要指派給此資源群組的標記。 | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesResourceGroups
| 名字 | 描述 | 價值 |
|---|
ARM 樣本資源定義
藍圖資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Blueprint/blueprints",
"apiVersion": "2018-11-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"parameters": {
"{customized property}": {
"allowedValues": [ {} ],
"defaultValue": {},
"metadata": {
"description": "string",
"displayName": "string",
"strongType": "string"
},
"type": "string"
}
},
"resourceGroups": {
"{customized property}": {
"dependsOn": [ "string" ],
"location": "string",
"metadata": {
"description": "string",
"displayName": "string",
"strongType": "string"
},
"name": "string",
"tags": {
"{customized property}": "string"
}
}
},
"targetScope": "string",
"versions": {}
}
}
屬性值
BlueprintProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 多行說明此資源。 | 字串 約束： 最大長度 = |
| displayName | 單行字串說明此資源。 | 字串 約束： 最大長度 = |
| 參數 | 此藍圖定義所需的參數。 | SharedBlueprintPropertiesParameters |
| resourceGroups | 此藍圖定義所定義的資源群組佔位元。 | SharedBlueprintPropertiesResourceGroups |
| targetScope | 可以指派此藍圖定義的範圍。 | 'managementGroup' 'subscription' |
| 版本 | 此藍圖定義的已發佈版本。 | 任何 |
Microsoft.Blueprint/blueprints
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2018-11-01-preview' |
| 名字 | 資源名稱 | 字串 （必要） |
| 性能 | 藍圖定義的詳細屬性。 | BlueprintProperties （必要） |
| 類型 | 資源類型 | 'Microsoft.Blueprint/blueprints' |
ParameterDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 此參數允許值的陣列。 | any[] |
| defaultValue | 此參數的預設值。 | 任何 |
| 元數據 | 此參數的用戶易記屬性。 | ParameterDefinitionMetadata |
| 類型 | Resource Manager 樣本參數允許的數據類型。 | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要） |
ParameterDefinitionMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 此參數/resourceGroup 的描述。 | 字串 約束： 最大長度 = |
| displayName | 此參數/resourceGroup 的 DisplayName。 | 字串 約束： 最大長度 = |
| strongType | 要讓UI在藍圖指派期間呈現豐富體驗的 StrongType。 支援的強類型為 resourceType、principalId 和 location。 | 字串 約束： 最大長度 = |
ResourceGroupDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| dependsOn | 需要在此資源群組之前部署的成品。 | string[] |
| 位置 | 此 resourceGroup 的位置。 如果在藍圖指派期間指定資源群組位置，則保留空白。 | 字串 |
| 元數據 | 此資源群組的用戶易記屬性。 | ParameterDefinitionMetadata |
| 名字 | 此 resourceGroup 的名稱。 如果在藍圖指派期間指定資源組名，則保留空白。 | 字串 |
| 標籤 | 要指派給此資源群組的標記。 | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesResourceGroups
| 名字 | 描述 | 價值 |
|---|
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
藍圖 - 建立新的藍圖定義
|
此範本會建立 Azure 藍圖藍圖定義。 藍圖定義包含原則指派成品，可以修改，然後部署到管理群組或訂用帳戶，以取得一致的環境。 |
Terraform （AzAPI 提供者） 資源定義
藍圖資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Blueprint/blueprints@2018-11-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
displayName = "string"
parameters = {
{customized property} = {
allowedValues = [
?
]
defaultValue = ?
metadata = {
description = "string"
displayName = "string"
strongType = "string"
}
type = "string"
}
}
resourceGroups = {
{customized property} = {
dependsOn = [
"string"
]
location = "string"
metadata = {
description = "string"
displayName = "string"
strongType = "string"
}
name = "string"
tags = {
{customized property} = "string"
}
}
}
targetScope = "string"
versions = ?
}
})
}
屬性值
BlueprintProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 多行說明此資源。 | 字串 約束： 最大長度 = |
| displayName | 單行字串說明此資源。 | 字串 約束： 最大長度 = |
| 參數 | 此藍圖定義所需的參數。 | SharedBlueprintPropertiesParameters |
| resourceGroups | 此藍圖定義所定義的資源群組佔位元。 | SharedBlueprintPropertiesResourceGroups |
| targetScope | 可以指派此藍圖定義的範圍。 | 'managementGroup' 'subscription' |
| 版本 | 此藍圖定義的已發佈版本。 | 任何 |
Microsoft.Blueprint/blueprints
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 （必要） |
| parent_id | 要套用此延伸模組資源之資源的標識碼。 | 字串 （必要） |
| 性能 | 藍圖定義的詳細屬性。 | BlueprintProperties （必要） |
| 類型 | 資源類型 | “Microsoft.Blueprint/blueprints@2018-11-01-preview” |
ParameterDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| allowedValues | 此參數允許值的陣列。 | any[] |
| defaultValue | 此參數的預設值。 | 任何 |
| 元數據 | 此參數的用戶易記屬性。 | ParameterDefinitionMetadata |
| 類型 | Resource Manager 樣本參數允許的數據類型。 | 'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要） |
ParameterDefinitionMetadata
| 名字 | 描述 | 價值 |
|---|---|---|
| 描述 | 此參數/resourceGroup 的描述。 | 字串 約束： 最大長度 = |
| displayName | 此參數/resourceGroup 的 DisplayName。 | 字串 約束： 最大長度 = |
| strongType | 要讓UI在藍圖指派期間呈現豐富體驗的 StrongType。 支援的強類型為 resourceType、principalId 和 location。 | 字串 約束： 最大長度 = |
ResourceGroupDefinition
| 名字 | 描述 | 價值 |
|---|---|---|
| dependsOn | 需要在此資源群組之前部署的成品。 | string[] |
| 位置 | 此 resourceGroup 的位置。 如果在藍圖指派期間指定資源群組位置，則保留空白。 | 字串 |
| 元數據 | 此資源群組的用戶易記屬性。 | ParameterDefinitionMetadata |
| 名字 | 此 resourceGroup 的名稱。 如果在藍圖指派期間指定資源組名，則保留空白。 | 字串 |
| 標籤 | 要指派給此資源群組的標記。 | ResourceGroupDefinitionTags |
ResourceGroupDefinitionTags
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesParameters
| 名字 | 描述 | 價值 |
|---|
SharedBlueprintPropertiesResourceGroups
| 名字 | 描述 | 價值 |
|---|