Esquemas do Microsoft.Blueprint

Artigo
01/28/2025

Definição de recursos do bíceps

O tipo de recurso blueprints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o seguinte Bicep ao seu modelo.

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(...)
  }
}

Valores de propriedade

BlueprintPropriedades

Designação	Descrição	Valor
Descrição	Multi-linha explicar este recurso.	string Restrições: Comprimento máximo = 500
displayName	Uma cadeia de caracteres de linha única explica este recurso.	string Restrições: Comprimento máximo = 256
Parâmetros	Parâmetros exigidos por esta definição de blueprint.	SharedBlueprintPropertiesParameters
resourceGroups	Espaços reservados para grupos de recursos definidos por esta definição de blueprint.	SharedBlueprintPropertiesResourceGroups
targetScope	O âmbito em que esta definição de modelo pode ser atribuída.	«Grupo de gestão» 'Subscrição'
Versões	Versões publicadas desta definição de modelo.	qualquer

Microsoft.Blueprint/blueprints

Designação	Descrição	Valor
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades detalhadas para definição de blueprint.	BlueprintProperties (obrigatório)
Âmbito de aplicação	Use ao criar um recurso em um escopo diferente do escopo de implantação.	Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

Definição de parâmetros

Designação	Descrição	Valor
allowedValues	Matriz de valores permitidos para este parâmetro.	qualquer[]
defaultValue	Valor padrão para este parâmetro.	qualquer
metadados	Propriedades fáceis de usar para este parâmetro.	ParameterDefinitionMetadata
tipo	Tipos de dados permitidos para parâmetros de modelo do Resource Manager.	'matriz' 'Bool' «int» 'objeto' 'secureObject' 'secureString' 'string' (obrigatório)

ParameterDefinitionMetadata

Designação	Descrição	Valor
Descrição	Descrição deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 500
displayName	DisplayName deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 256
strongType	StrongType para interface do usuário para renderizar uma experiência rica durante a atribuição do blueprint. Os tipos fortes suportados são resourceType, principalId e location.	string Restrições: Comprimento máximo = 64

ResourceGroupDefinition

Designação	Descrição	Valor
dependeDe	Artefatos que precisam ser implantados antes desse grupo de recursos.	string[]
Localização	Localização deste resourceGroup. Deixe em branco se o local do grupo de recursos for especificado durante a atribuição do blueprint.	string
metadados	Propriedades amigáveis para este grupo de recursos.	ParameterDefinitionMetadata
Designação	Nome deste resourceGroup. Deixe em branco se o nome do grupo de recursos for especificado durante a atribuição do blueprint.	string
Etiquetas	Tags a serem atribuídas a este grupo de recursos.	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Designação	Descrição	Valor

SharedBlueprintPropertiesParameters

Designação	Descrição	Valor

SharedBlueprintPropertiesResourceGroups

Designação	Descrição	Valor

Definição de recurso de modelo ARM

O tipo de recurso blueprints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o seguinte JSON ao seu modelo.

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

Valores de propriedade

BlueprintPropriedades

Designação	Descrição	Valor
Descrição	Multi-linha explicar este recurso.	string Restrições: Comprimento máximo = 500
displayName	Uma cadeia de caracteres de linha única explica este recurso.	string Restrições: Comprimento máximo = 256
Parâmetros	Parâmetros exigidos por esta definição de blueprint.	SharedBlueprintPropertiesParameters
resourceGroups	Espaços reservados para grupos de recursos definidos por esta definição de blueprint.	SharedBlueprintPropertiesResourceGroups
targetScope	O âmbito em que esta definição de modelo pode ser atribuída.	«Grupo de gestão» 'Subscrição'
Versões	Versões publicadas desta definição de modelo.	qualquer

Microsoft.Blueprint/blueprints

Designação	Descrição	Valor
apiVersion	A versão api	'2018-11-01-pré-visualização'
Designação	O nome do recurso	string (obrigatório)
propriedades	Propriedades detalhadas para definição de blueprint.	BlueprintProperties (obrigatório)
tipo	O tipo de recurso	'Microsoft.Blueprint/blueprints'

Definição de parâmetros

Designação	Descrição	Valor
allowedValues	Matriz de valores permitidos para este parâmetro.	qualquer[]
defaultValue	Valor padrão para este parâmetro.	qualquer
metadados	Propriedades fáceis de usar para este parâmetro.	ParameterDefinitionMetadata
tipo	Tipos de dados permitidos para parâmetros de modelo do Resource Manager.	'matriz' 'Bool' «int» 'objeto' 'secureObject' 'secureString' 'string' (obrigatório)

ParameterDefinitionMetadata

Designação	Descrição	Valor
Descrição	Descrição deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 500
displayName	DisplayName deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 256
strongType	StrongType para interface do usuário para renderizar uma experiência rica durante a atribuição do blueprint. Os tipos fortes suportados são resourceType, principalId e location.	string Restrições: Comprimento máximo = 64

ResourceGroupDefinition

Designação	Descrição	Valor
dependeDe	Artefatos que precisam ser implantados antes desse grupo de recursos.	string[]
Localização	Localização deste resourceGroup. Deixe em branco se o local do grupo de recursos for especificado durante a atribuição do blueprint.	string
metadados	Propriedades amigáveis para este grupo de recursos.	ParameterDefinitionMetadata
Designação	Nome deste resourceGroup. Deixe em branco se o nome do grupo de recursos for especificado durante a atribuição do blueprint.	string
Etiquetas	Tags a serem atribuídas a este grupo de recursos.	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Designação	Descrição	Valor

SharedBlueprintPropertiesParameters

Designação	Descrição	Valor

SharedBlueprintPropertiesResourceGroups

Designação	Descrição	Valor

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.

Modelo	Descrição
Blueprints - Crie uma nova definição de blueprint	Este modelo cria uma definição de blueprint do Azure Blueprint. A definição do blueprint inclui um artefato de atribuição de política e pode ser modificada e, em seguida, implantada em grupos de gerenciamento ou assinaturas para ambientes consistentes.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso blueprints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o seguinte Terraform ao seu modelo.

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

Valores de propriedade

BlueprintPropriedades

Designação	Descrição	Valor
Descrição	Multi-linha explicar este recurso.	string Restrições: Comprimento máximo = 500
displayName	Uma cadeia de caracteres de linha única explica este recurso.	string Restrições: Comprimento máximo = 256
Parâmetros	Parâmetros exigidos por esta definição de blueprint.	SharedBlueprintPropertiesParameters
resourceGroups	Espaços reservados para grupos de recursos definidos por esta definição de blueprint.	SharedBlueprintPropertiesResourceGroups
targetScope	O âmbito em que esta definição de modelo pode ser atribuída.	«Grupo de gestão» 'Subscrição'
Versões	Versões publicadas desta definição de modelo.	qualquer

Microsoft.Blueprint/blueprints

Designação	Descrição	Valor
Designação	O nome do recurso	string (obrigatório)
parent_id	A ID do recurso ao qual aplicar esse recurso de extensão.	string (obrigatório)
propriedades	Propriedades detalhadas para definição de blueprint.	BlueprintProperties (obrigatório)
tipo	O tipo de recurso	"Microsoft.Blueprint/blueprints@2018-11-01-preview"

Definição de parâmetros

Designação	Descrição	Valor
allowedValues	Matriz de valores permitidos para este parâmetro.	qualquer[]
defaultValue	Valor padrão para este parâmetro.	qualquer
metadados	Propriedades fáceis de usar para este parâmetro.	ParameterDefinitionMetadata
tipo	Tipos de dados permitidos para parâmetros de modelo do Resource Manager.	'matriz' 'Bool' «int» 'objeto' 'secureObject' 'secureString' 'string' (obrigatório)

ParameterDefinitionMetadata

Designação	Descrição	Valor
Descrição	Descrição deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 500
displayName	DisplayName deste parâmetro/resourceGroup.	string Restrições: Comprimento máximo = 256
strongType	StrongType para interface do usuário para renderizar uma experiência rica durante a atribuição do blueprint. Os tipos fortes suportados são resourceType, principalId e location.	string Restrições: Comprimento máximo = 64

ResourceGroupDefinition

Designação	Descrição	Valor
dependeDe	Artefatos que precisam ser implantados antes desse grupo de recursos.	string[]
Localização	Localização deste resourceGroup. Deixe em branco se o local do grupo de recursos for especificado durante a atribuição do blueprint.	string
metadados	Propriedades amigáveis para este grupo de recursos.	ParameterDefinitionMetadata
Designação	Nome deste resourceGroup. Deixe em branco se o nome do grupo de recursos for especificado durante a atribuição do blueprint.	string
Etiquetas	Tags a serem atribuídas a este grupo de recursos.	ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Designação	Descrição	Valor

SharedBlueprintPropertiesParameters

Designação	Descrição	Valor

SharedBlueprintPropertiesResourceGroups

Designação	Descrição	Valor

Partilhar via

Esquemas do Microsoft.Blueprint

Definição de recursos do bíceps

Formato do recurso

Valores de propriedade

BlueprintPropriedades

Microsoft.Blueprint/blueprints

Definição de parâmetros

ParameterDefinitionMetadata

ResourceGroupDefinition

ResourceGroupDefinitionTags

SharedBlueprintPropertiesParameters

SharedBlueprintPropertiesResourceGroups

Definição de recurso de modelo ARM

Formato do recurso

Valores de propriedade

BlueprintPropriedades

Microsoft.Blueprint/blueprints

Definição de parâmetros

ParameterDefinitionMetadata

ResourceGroupDefinition

ResourceGroupDefinitionTags

SharedBlueprintPropertiesParameters

SharedBlueprintPropertiesResourceGroups

Exemplos de uso

Modelos de início rápido do Azure

Definição de recursos Terraform (provedor AzAPI)

Formato do recurso

Valores de propriedade

BlueprintPropriedades

Microsoft.Blueprint/blueprints

Definição de parâmetros

ParameterDefinitionMetadata

ResourceGroupDefinition

ResourceGroupDefinitionTags

SharedBlueprintPropertiesParameters

SharedBlueprintPropertiesResourceGroups

Comentários

Recursos adicionais