Microsoft.藍圖藍圖 2017-11-11-preview

• 最新
• 2018-11-01-preview
• 2017-11-11-preview

Bicep 資源定義

藍圖資源類型可以使用目標作業來部署：

• 管理群組 - 請參閱 管理群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.Blueprint/blueprints@2017-11-11-preview' = {
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    layout: any(Azure.Bicep.Types.Concrete.AnyType)
    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'
      }
    }
    targetScope: 'string'
    versions: any(Azure.Bicep.Types.Concrete.AnyType)
  }
}

屬性值

BlueprintProperties

名字	描述	價值
描述	多行說明此資源。	字串 約束： 最大長度 =
displayName	單行字串說明此資源。	字串 約束： 最大長度 =
佈局	藍圖的版面配置檢視，以供UI參考。	任何
參數	此藍圖定義所需的參數。	ParameterDefinitionCollection
resourceGroups	此藍圖定義所定義的資源群組佔位元。	ResourceGroupDefinitionCollection
targetScope	可以套用此藍圖的範圍。	'managementGroup' 'subscription'
版本	此藍圖的已發佈版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	價值
名字	資源名稱	字串 （必要）
性能	藍圖的詳細屬性	BlueprintProperties （必要）

ParameterDefinition

名字	描述	價值
allowedValues	此參數允許值的陣列。	any[]
defaultValue	此參數的預設值。	任何
元數據	此參數的用戶易記屬性。	ParameterDefinitionMetadata
類型	Azure Resource Manager 樣本參數允許的數據類型。	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要）

ParameterDefinitionCollection

名字	描述	價值

ParameterDefinitionMetadata

名字	描述	價值
描述	此參數/resourceGroup 的描述。	字串 約束： 最大長度 =
displayName	此參數/resourceGroup 的 DisplayName。	字串 約束： 最大長度 =
strongType	要讓UI在指派期間呈現豐富體驗的 StrongType。	字串 約束： 最大長度 =

ResourceGroupDefinition

名字	描述	價值
dependsOn	需要在此資源群組之前部署的成品。	string[]
位置	此 resourceGroup 的位置，如果在藍圖指派期間指定資源群組位置，則保留空白。	字串 約束： 最大長度 =
元數據	此資源群組的用戶易記屬性。	ParameterDefinitionMetadata
名字	如果將在藍圖指派期間指定資源組名，則此 resourceGroup 的名稱會保留空白。	字串 約束： 最小長度 = 1 最大長度 = 1

ResourceGroupDefinitionCollection

名字	描述	價值

ARM 樣本資源定義

藍圖資源類型可以使用目標作業來部署：

• 管理群組 - 請參閱 管理群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Blueprint/blueprints",
  "apiVersion": "2017-11-11-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "layout": {},
    "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"
      }
    },
    "targetScope": "string",
    "versions": {}
  }
}

屬性值

BlueprintProperties

名字	描述	價值
描述	多行說明此資源。	字串 約束： 最大長度 =
displayName	單行字串說明此資源。	字串 約束： 最大長度 =
佈局	藍圖的版面配置檢視，以供UI參考。	任何
參數	此藍圖定義所需的參數。	ParameterDefinitionCollection
resourceGroups	此藍圖定義所定義的資源群組佔位元。	ResourceGroupDefinitionCollection
targetScope	可以套用此藍圖的範圍。	'managementGroup' 'subscription'
版本	此藍圖的已發佈版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	價值
apiVersion	API 版本	'2017-11-11-preview'
名字	資源名稱	字串 （必要）
性能	藍圖的詳細屬性	BlueprintProperties （必要）
類型	資源類型	'Microsoft.Blueprint/blueprints'

ParameterDefinition

名字	描述	價值
allowedValues	此參數允許值的陣列。	any[]
defaultValue	此參數的預設值。	任何
元數據	此參數的用戶易記屬性。	ParameterDefinitionMetadata
類型	Azure Resource Manager 樣本參數允許的數據類型。	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要）

ParameterDefinitionCollection

名字	描述	價值

ParameterDefinitionMetadata

名字	描述	價值
描述	此參數/resourceGroup 的描述。	字串 約束： 最大長度 =
displayName	此參數/resourceGroup 的 DisplayName。	字串 約束： 最大長度 =
strongType	要讓UI在指派期間呈現豐富體驗的 StrongType。	字串 約束： 最大長度 =

ResourceGroupDefinition

名字	描述	價值
dependsOn	需要在此資源群組之前部署的成品。	string[]
位置	此 resourceGroup 的位置，如果在藍圖指派期間指定資源群組位置，則保留空白。	字串 約束： 最大長度 =
元數據	此資源群組的用戶易記屬性。	ParameterDefinitionMetadata
名字	如果將在藍圖指派期間指定資源組名，則此 resourceGroup 的名稱會保留空白。	字串 約束： 最小長度 = 1 最大長度 = 1

ResourceGroupDefinitionCollection

名字	描述	價值

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
藍圖 - 建立新的藍圖定義	此範本會建立 Azure 藍圖藍圖定義。 藍圖定義包含原則指派成品，可以修改，然後部署到管理群組或訂用帳戶，以取得一致的環境。

Terraform （AzAPI 提供者） 資源定義

藍圖資源類型可以使用目標作業來部署：

• 管理群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Blueprint/blueprints 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints@2017-11-11-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      layout = ?
      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"
        }
      }
      targetScope = "string"
      versions = ?
    }
  })
}

屬性值

BlueprintProperties

名字	描述	價值
描述	多行說明此資源。	字串 約束： 最大長度 =
displayName	單行字串說明此資源。	字串 約束： 最大長度 =
佈局	藍圖的版面配置檢視，以供UI參考。	任何
參數	此藍圖定義所需的參數。	ParameterDefinitionCollection
resourceGroups	此藍圖定義所定義的資源群組佔位元。	ResourceGroupDefinitionCollection
targetScope	可以套用此藍圖的範圍。	'managementGroup' 'subscription'
版本	此藍圖的已發佈版本。	任何

Microsoft.Blueprint/blueprints

名字	描述	價值
名字	資源名稱	字串 （必要）
性能	藍圖的詳細屬性	BlueprintProperties （必要）
類型	資源類型	“Microsoft.Blueprint/blueprints@2017-11-11-preview”

ParameterDefinition

名字	描述	價值
allowedValues	此參數允許值的陣列。	any[]
defaultValue	此參數的預設值。	任何
元數據	此參數的用戶易記屬性。	ParameterDefinitionMetadata
類型	Azure Resource Manager 樣本參數允許的數據類型。	'array' 'bool' 'int' 'object' 'secureObject' 'secureString' 'string' （必要）

ParameterDefinitionCollection

名字	描述	價值

ParameterDefinitionMetadata

名字	描述	價值
描述	此參數/resourceGroup 的描述。	字串 約束： 最大長度 =
displayName	此參數/resourceGroup 的 DisplayName。	字串 約束： 最大長度 =
strongType	要讓UI在指派期間呈現豐富體驗的 StrongType。	字串 約束： 最大長度 =

ResourceGroupDefinition

名字	描述	價值
dependsOn	需要在此資源群組之前部署的成品。	string[]
位置	此 resourceGroup 的位置，如果在藍圖指派期間指定資源群組位置，則保留空白。	字串 約束： 最大長度 =
元數據	此資源群組的用戶易記屬性。	ParameterDefinitionMetadata
名字	如果將在藍圖指派期間指定資源組名，則此 resourceGroup 的名稱會保留空白。	字串 約束： 最小長度 = 1 最大長度 = 1

ResourceGroupDefinitionCollection

名字	描述	價值