Microsoft.Blueprint ブループリント

• 最新の を する
• 2018-11-01-プレビュー
• 2017-11-11-プレビュー

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(...)
        ]
        defaultValue: any(...)
        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(...)
  }
}

プロパティ値

Microsoft.Blueprint/blueprints

名前	形容	価値
名前	リソース名	string (必須)
プロパティ	ブループリント定義の詳細なプロパティ。	BlueprintProperties (必須)
スコープ	デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。	このプロパティをリソースのシンボリック名に設定して、拡張リソースを適用します。

ブループリントプロパティ

名前	形容	価値
形容	複数行でこのリソースについて説明します。	糸 制約： 最大長 = 500
ディスプレイ名	このリソースを説明する 1 行の文字列。	糸 制約： 最大長 = 256
パラメーター	このブループリント定義に必要なパラメーター。	SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)
リソースグループ	このブループリント定義で定義されているリソース グループ プレースホルダー。	SharedBlueprintPropertiesリソースグループ
ターゲットスコープ	このブループリント定義を割り当てることができるスコープ。	「マネジメントグループ」 'サブスクリプション'
バージョン	このブループリント定義の発行済みバージョン。	任意

パラメータ定義

名前	形容	価値
allowedValues (allowedValues)	このパラメーターに使用できる値の配列。	どれでも[]
デフォルト値	このパラメーターの既定値。	任意
メタデータ	このパラメーターのわかりやすいプロパティ。	ParameterDefinitionMetadata の
種類	Resource Manager テンプレート パラメーターに使用できるデータ型。	'配列' ブール 'int' 'オブジェクト' 'セキュアオブジェクト' 'secureString' 'string' (必須)

パラメータ定義メタデータ

名前	形容	価値
形容	このパラメーター/resourceGroup の説明。	糸 制約： 最大長 = 500
ディスプレイ名	このパラメーター/resourceGroup の DisplayName。	糸 制約： 最大長 = 256
ストロングタイプ	ブループリントの割り当て中に豊富なエクスペリエンスをレンダリングする UI 用の StrongType。 サポートされている厳密な種類は、resourceType、principalId、および場所です。	糸 制約： 最大長 = 64

リソースグループ定義

名前	形容	価値
dependsOn (依存する)	このリソース グループの前にデプロイする必要がある成果物。	文字列[]
場所	この resourceGroup の場所。 ブループリントの割り当て中にリソース グループの場所を指定する場合は、空のままにします。	糸
メタデータ	このリソース グループのわかりやすいプロパティ。	ParameterDefinitionMetadata の
名前	この resourceGroup の名前。 ブループリントの割り当て中にリソース グループ名を指定する場合は、空のままにします。	糸
タグ	このリソース グループに割り当てられるタグ。	ResourceGroupDefinitionタグ

ResourceGroupDefinitionタグ

名前	形容	価値

SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)

名前	形容	価値

SharedBlueprintPropertiesリソースグループ

名前	形容	価値

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": {}
  }
}

プロパティ値

Microsoft.Blueprint/blueprints

名前	形容	価値
apiVersion (英語)	API のバージョン	'2018-11-01-プレビュー'
名前	リソース名	string (必須)
プロパティ	ブループリント定義の詳細なプロパティ。	BlueprintProperties (必須)
種類	リソースの種類	'Microsoft.Blueprint/blueprints'

ブループリントプロパティ

名前	形容	価値
形容	複数行でこのリソースについて説明します。	糸 制約： 最大長 = 500
ディスプレイ名	このリソースを説明する 1 行の文字列。	糸 制約： 最大長 = 256
パラメーター	このブループリント定義に必要なパラメーター。	SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)
リソースグループ	このブループリント定義で定義されているリソース グループ プレースホルダー。	SharedBlueprintPropertiesリソースグループ
ターゲットスコープ	このブループリント定義を割り当てることができるスコープ。	「マネジメントグループ」 'サブスクリプション'
バージョン	このブループリント定義の発行済みバージョン。	任意

パラメータ定義

名前	形容	価値
allowedValues (allowedValues)	このパラメーターに使用できる値の配列。	どれでも[]
デフォルト値	このパラメーターの既定値。	任意
メタデータ	このパラメーターのわかりやすいプロパティ。	ParameterDefinitionMetadata の
種類	Resource Manager テンプレート パラメーターに使用できるデータ型。	'配列' ブール 'int' 'オブジェクト' 'セキュアオブジェクト' 'secureString' 'string' (必須)

パラメータ定義メタデータ

名前	形容	価値
形容	このパラメーター/resourceGroup の説明。	糸 制約： 最大長 = 500
ディスプレイ名	このパラメーター/resourceGroup の DisplayName。	糸 制約： 最大長 = 256
ストロングタイプ	ブループリントの割り当て中に豊富なエクスペリエンスをレンダリングする UI 用の StrongType。 サポートされている厳密な種類は、resourceType、principalId、および場所です。	糸 制約： 最大長 = 64

リソースグループ定義

名前	形容	価値
dependsOn (依存する)	このリソース グループの前にデプロイする必要がある成果物。	文字列[]
場所	この resourceGroup の場所。 ブループリントの割り当て中にリソース グループの場所を指定する場合は、空のままにします。	糸
メタデータ	このリソース グループのわかりやすいプロパティ。	ParameterDefinitionMetadata の
名前	この resourceGroup の名前。 ブループリントの割り当て中にリソース グループ名を指定する場合は、空のままにします。	糸
タグ	このリソース グループに割り当てられるタグ。	ResourceGroupDefinitionタグ

ResourceGroupDefinitionタグ

名前	形容	価値

SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)

名前	形容	価値

SharedBlueprintPropertiesリソースグループ

名前	形容	価値

使用例

Azure のクイック スタート テンプレート

このリソースの種類 デプロイする Azure クイック スタート テンプレート 次に示します。

テンプレート	形容
ブループリントの - 新しいブループリント定義 を作成する Azure にデプロイする	このテンプレートは、Azure Blueprint ブループリント定義を作成します。 ブループリント定義にはポリシー割り当て成果物が含まれており、一貫性のある環境のために変更してから管理グループまたはサブスクリプションにデプロイできます。

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 = {
    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 = ?
    }
  }
}

プロパティ値

Microsoft.Blueprint/blueprints

名前	形容	価値
名前	リソース名	string (必須)
parent_id	この拡張リソースを適用するリソースの ID。	string (必須)
プロパティ	ブループリント定義の詳細なプロパティ。	BlueprintProperties (必須)
種類	リソースの種類	"Microsoft.Blueprint/blueprints@2018-11-01-preview" (英語)

ブループリントプロパティ

名前	形容	価値
形容	複数行でこのリソースについて説明します。	糸 制約： 最大長 = 500
ディスプレイ名	このリソースを説明する 1 行の文字列。	糸 制約： 最大長 = 256
パラメーター	このブループリント定義に必要なパラメーター。	SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)
リソースグループ	このブループリント定義で定義されているリソース グループ プレースホルダー。	SharedBlueprintPropertiesリソースグループ
ターゲットスコープ	このブループリント定義を割り当てることができるスコープ。	「マネジメントグループ」 'サブスクリプション'
バージョン	このブループリント定義の発行済みバージョン。	任意

パラメータ定義

名前	形容	価値
allowedValues (allowedValues)	このパラメーターに使用できる値の配列。	どれでも[]
デフォルト値	このパラメーターの既定値。	任意
メタデータ	このパラメーターのわかりやすいプロパティ。	ParameterDefinitionMetadata の
種類	Resource Manager テンプレート パラメーターに使用できるデータ型。	'配列' ブール 'int' 'オブジェクト' 'セキュアオブジェクト' 'secureString' 'string' (必須)

パラメータ定義メタデータ

名前	形容	価値
形容	このパラメーター/resourceGroup の説明。	糸 制約： 最大長 = 500
ディスプレイ名	このパラメーター/resourceGroup の DisplayName。	糸 制約： 最大長 = 256
ストロングタイプ	ブループリントの割り当て中に豊富なエクスペリエンスをレンダリングする UI 用の StrongType。 サポートされている厳密な種類は、resourceType、principalId、および場所です。	糸 制約： 最大長 = 64

リソースグループ定義

名前	形容	価値
dependsOn (依存する)	このリソース グループの前にデプロイする必要がある成果物。	文字列[]
場所	この resourceGroup の場所。 ブループリントの割り当て中にリソース グループの場所を指定する場合は、空のままにします。	糸
メタデータ	このリソース グループのわかりやすいプロパティ。	ParameterDefinitionMetadata の
名前	この resourceGroup の名前。 ブループリントの割り当て中にリソース グループ名を指定する場合は、空のままにします。	糸
タグ	このリソース グループに割り当てられるタグ。	ResourceGroupDefinitionタグ

ResourceGroupDefinitionタグ

名前	形容	価値

SharedBlueprintPropertiesParameters (共有BlueprintPropertiesパラメータ)

名前	形容	価値

SharedBlueprintPropertiesリソースグループ

名前	形容	価値