Поделиться через


Схемы Microsoft.Blueprints 2017-11-11-preview

Определение ресурсов Bicep

Тип ресурса схемы можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Blueprint/blueprints, добавьте следующий Bicep в шаблон.

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

Значения свойств

Microsoft.Blueprint/blueprints/blueprints

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
свойства Подробные свойства схемы BlueprintProperties (обязательно)
scope Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.

BlueprintProperties

Имя Описание Ценность
описание В нескольких строках объясняется этот ресурс. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя Строка однострочный поясняет этот ресурс. струна

Ограничения целостности:
Максимальная длина = 256
схема Представление макета схемы для ссылки на пользовательский интерфейс. любой
Параметры Параметры, необходимые для определения схемы. ParameterDefinitionCollection (Набор параметров)
resourceGroups Заполнители групп ресурсов, определенные этим определением схемы. ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)
targetScope Область применения этой схемы. "managementGroup"
"подписка"
Версии Опубликованные версии этой схемы. любой

Определение параметра

Имя Описание Ценность
допустимые значения Массив допустимых значений для этого параметра. любой[]
значение по умолчанию Значение по умолчанию для этого параметра. любой
метаданные Понятные свойства для этого параметра. ParameterDefinitionMetadata
тип Допустимые типы данных для параметров шаблона Azure Resource Manager. Массив
'bool'
'int'
"object"
SecureObject
SecureString
"string" (обязательный)

ParameterDefinitionCollection (Набор параметров)

Имя Описание Ценность

ParameterDefinitionMetadata

Имя Описание Ценность
описание Описание этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя DisplayName этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 256
strongType StrongType для пользовательского интерфейса для отображения расширенных возможностей во время назначения. струна

Ограничения целостности:
Максимальная длина = 64

ResourceGroupDefinition

Имя Описание Ценность
Свойство dependsOn Артефакты, которые необходимо развернуть перед этой группой ресурсов. строка[]
местоположение Расположение этой группы ресурсов оставьте пустым, если расположение группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Максимальная длина = 90
метаданные Понятные свойства для этой группы ресурсов. ParameterDefinitionMetadata
имя Имя этой группы ресурсов оставьте пустым, если имя группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90

ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)

Имя Описание Ценность

Определение ресурса шаблона 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": {}
  }
}

Значения свойств

Microsoft.Blueprint/blueprints/blueprints

Имя Описание Ценность
apiVersion Версия API '2017-11-11-превью'
имя Имя ресурса строка (обязательно)
свойства Подробные свойства схемы BlueprintProperties (обязательно)
тип Тип ресурса "Microsoft.Blueprint/blueprints"

BlueprintProperties

Имя Описание Ценность
описание В нескольких строках объясняется этот ресурс. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя Строка однострочный поясняет этот ресурс. струна

Ограничения целостности:
Максимальная длина = 256
схема Представление макета схемы для ссылки на пользовательский интерфейс. любой
Параметры Параметры, необходимые для определения схемы. ParameterDefinitionCollection (Набор параметров)
resourceGroups Заполнители групп ресурсов, определенные этим определением схемы. ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)
targetScope Область применения этой схемы. "managementGroup"
"подписка"
Версии Опубликованные версии этой схемы. любой

Определение параметра

Имя Описание Ценность
допустимые значения Массив допустимых значений для этого параметра. любой[]
значение по умолчанию Значение по умолчанию для этого параметра. любой
метаданные Понятные свойства для этого параметра. ParameterDefinitionMetadata
тип Допустимые типы данных для параметров шаблона Azure Resource Manager. Массив
'bool'
'int'
"object"
SecureObject
SecureString
"string" (обязательный)

ParameterDefinitionCollection (Набор параметров)

Имя Описание Ценность

ParameterDefinitionMetadata

Имя Описание Ценность
описание Описание этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя DisplayName этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 256
strongType StrongType для пользовательского интерфейса для отображения расширенных возможностей во время назначения. струна

Ограничения целостности:
Максимальная длина = 64

ResourceGroupDefinition

Имя Описание Ценность
Свойство dependsOn Артефакты, которые необходимо развернуть перед этой группой ресурсов. строка[]
местоположение Расположение этой группы ресурсов оставьте пустым, если расположение группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Максимальная длина = 90
метаданные Понятные свойства для этой группы ресурсов. ParameterDefinitionMetadata
имя Имя этой группы ресурсов оставьте пустым, если имя группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90

ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)

Имя Описание Ценность

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
схемы. Создание нового определения схемы

развертывание в Azure
Этот шаблон создает определение схемы схемы Azure Blueprint. Определение схемы включает артефакт назначения политики и может быть изменен, а затем развертываться в группах управления или подписках для согласованных сред.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса схемы можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.Blueprint/blueprints, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Blueprint/blueprints@2017-11-11-preview"
  name = "string"
  parent_id = "string"
  body = {
    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 = ?
    }
  }
}

Значения свойств

Microsoft.Blueprint/blueprints/blueprints

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
свойства Подробные свойства схемы BlueprintProperties (обязательно)
тип Тип ресурса "Microsoft.Blueprint/blueprints@2017-11-11-preview"

BlueprintProperties

Имя Описание Ценность
описание В нескольких строках объясняется этот ресурс. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя Строка однострочный поясняет этот ресурс. струна

Ограничения целостности:
Максимальная длина = 256
схема Представление макета схемы для ссылки на пользовательский интерфейс. любой
Параметры Параметры, необходимые для определения схемы. ParameterDefinitionCollection (Набор параметров)
resourceGroups Заполнители групп ресурсов, определенные этим определением схемы. ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)
targetScope Область применения этой схемы. "managementGroup"
"подписка"
Версии Опубликованные версии этой схемы. любой

Определение параметра

Имя Описание Ценность
допустимые значения Массив допустимых значений для этого параметра. любой[]
значение по умолчанию Значение по умолчанию для этого параметра. любой
метаданные Понятные свойства для этого параметра. ParameterDefinitionMetadata
тип Допустимые типы данных для параметров шаблона Azure Resource Manager. Массив
'bool'
'int'
"object"
SecureObject
SecureString
"string" (обязательный)

ParameterDefinitionCollection (Набор параметров)

Имя Описание Ценность

ParameterDefinitionMetadata

Имя Описание Ценность
описание Описание этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 500
отображаемое имя DisplayName этого параметра или resourceGroup. струна

Ограничения целостности:
Максимальная длина = 256
strongType StrongType для пользовательского интерфейса для отображения расширенных возможностей во время назначения. струна

Ограничения целостности:
Максимальная длина = 64

ResourceGroupDefinition

Имя Описание Ценность
Свойство dependsOn Артефакты, которые необходимо развернуть перед этой группой ресурсов. строка[]
местоположение Расположение этой группы ресурсов оставьте пустым, если расположение группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Максимальная длина = 90
метаданные Понятные свойства для этой группы ресурсов. ParameterDefinitionMetadata
имя Имя этой группы ресурсов оставьте пустым, если имя группы ресурсов будет указано во время назначения схемы. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90

ResourceGroupDefinitionCollection (РесурсгруппаDefinitionCollection)

Имя Описание Ценность