Compartilhar via


Blueprints do Microsoft.Blueprint

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o Bicep a seguir 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(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)
  }
}

Valores de propriedade

BlueprintProperties

Nome Descrição Valor
descrição Várias linhas explicam esse recurso. corda

Restrições:
Comprimento máximo =
displayName Uma cadeia de caracteres de linha explica esse recurso. corda

Restrições:
Comprimento máximo =
Parâmetros Parâmetros exigidos por essa definição de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaços reservados do grupo de recursos definidos por essa definição de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope O escopo em que essa definição de blueprint pode ser atribuída. 'managementGroup'
'assinatura'
Versões Versões publicadas dessa definição de blueprint. qualquer

Microsoft.Blueprint/blueprints

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades detalhadas para definição de blueprint. BlueprintProperties (obrigatório)
âmbito 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 .

ParameterDefinition

Nome Descrição Valor
allowedValues Matriz de valores permitidos para esse parâmetro. any[]
defaultValue Valor padrão para esse parâmetro. qualquer
metadados Propriedades amigáveis para esse parâmetro. ParameterDefinitionMetadata
tipo Tipos de dados permitidos para parâmetros de modelo do Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obrigatório)

ParameterDefinitionMetadata

Nome Descrição Valor
descrição Descrição desse parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
displayName DisplayName deste parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
strongType StrongType para interface do usuário para renderizar experiência avançada durante a atribuição de blueprint. Tipos fortes com suporte são resourceType, principalId e localização. corda

Restrições:
Comprimento máximo =

ResourceGroupDefinition

Nome Descrição Valor
dependsOn Artefatos que precisam ser implantados antes desse grupo de recursos. string[]
localização Local deste resourceGroup. Deixe vazio se o local do grupo de recursos for especificado durante a atribuição de blueprint. corda
metadados Propriedades amigáveis para esse grupo de recursos. ParameterDefinitionMetadata
nome Nome desse resourceGroup. Deixe vazio se o nome do grupo de recursos for especificado durante a atribuição de blueprint. corda
Tags Marcas a serem atribuídas a esse grupo de recursos. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nome Descrição Valor

SharedBlueprintPropertiesParameters

Nome Descrição Valor

SharedBlueprintPropertiesResourceGroups

Nome Descrição Valor

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o JSON a seguir ao 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

BlueprintProperties

Nome Descrição Valor
descrição Várias linhas explicam esse recurso. corda

Restrições:
Comprimento máximo =
displayName Uma cadeia de caracteres de linha explica esse recurso. corda

Restrições:
Comprimento máximo =
Parâmetros Parâmetros exigidos por essa definição de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaços reservados do grupo de recursos definidos por essa definição de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope O escopo em que essa definição de blueprint pode ser atribuída. 'managementGroup'
'assinatura'
Versões Versões publicadas dessa definição de blueprint. qualquer

Microsoft.Blueprint/blueprints

Nome Descrição Valor
apiVersion A versão da API '2018-11-01-preview'
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades detalhadas para definição de blueprint. BlueprintProperties (obrigatório)
tipo O tipo de recurso 'Microsoft.Blueprint/blueprints'

ParameterDefinition

Nome Descrição Valor
allowedValues Matriz de valores permitidos para esse parâmetro. any[]
defaultValue Valor padrão para esse parâmetro. qualquer
metadados Propriedades amigáveis para esse parâmetro. ParameterDefinitionMetadata
tipo Tipos de dados permitidos para parâmetros de modelo do Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obrigatório)

ParameterDefinitionMetadata

Nome Descrição Valor
descrição Descrição desse parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
displayName DisplayName deste parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
strongType StrongType para interface do usuário para renderizar experiência avançada durante a atribuição de blueprint. Tipos fortes com suporte são resourceType, principalId e localização. corda

Restrições:
Comprimento máximo =

ResourceGroupDefinition

Nome Descrição Valor
dependsOn Artefatos que precisam ser implantados antes desse grupo de recursos. string[]
localização Local deste resourceGroup. Deixe vazio se o local do grupo de recursos for especificado durante a atribuição de blueprint. corda
metadados Propriedades amigáveis para esse grupo de recursos. ParameterDefinitionMetadata
nome Nome desse resourceGroup. Deixe vazio se o nome do grupo de recursos for especificado durante a atribuição de blueprint. corda
Tags Marcas a serem atribuídas a esse grupo de recursos. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nome Descrição Valor

SharedBlueprintPropertiesParameters

Nome Descrição Valor

SharedBlueprintPropertiesResourceGroups

Nome Descrição Valor

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Blueprints – Criar uma nova definição de blueprint

Implantar no Azure
Esse modelo cria uma definição de blueprint do Azure Blueprint. A definição de blueprint inclui um artefato de atribuição de política e pode ser modificada e implantada em grupos de gerenciamento ou assinaturas para ambientes consistentes.

Definição de recurso do Terraform (provedor de AzAPI)

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

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

Formato de recurso

Para criar um recurso Microsoft.Blueprint/blueprints, adicione o Terraform a seguir 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

BlueprintProperties

Nome Descrição Valor
descrição Várias linhas explicam esse recurso. corda

Restrições:
Comprimento máximo =
displayName Uma cadeia de caracteres de linha explica esse recurso. corda

Restrições:
Comprimento máximo =
Parâmetros Parâmetros exigidos por essa definição de blueprint. SharedBlueprintPropertiesParameters
resourceGroups Espaços reservados do grupo de recursos definidos por essa definição de blueprint. SharedBlueprintPropertiesResourceGroups
targetScope O escopo em que essa definição de blueprint pode ser atribuída. 'managementGroup'
'assinatura'
Versões Versões publicadas dessa definição de blueprint. qualquer

Microsoft.Blueprint/blueprints

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (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"

ParameterDefinition

Nome Descrição Valor
allowedValues Matriz de valores permitidos para esse parâmetro. any[]
defaultValue Valor padrão para esse parâmetro. qualquer
metadados Propriedades amigáveis para esse parâmetro. ParameterDefinitionMetadata
tipo Tipos de dados permitidos para parâmetros de modelo do Resource Manager. 'array'
'bool'
'int'
'object'
'secureObject'
'secureString'
'string' (obrigatório)

ParameterDefinitionMetadata

Nome Descrição Valor
descrição Descrição desse parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
displayName DisplayName deste parâmetro/resourceGroup. corda

Restrições:
Comprimento máximo =
strongType StrongType para interface do usuário para renderizar experiência avançada durante a atribuição de blueprint. Tipos fortes com suporte são resourceType, principalId e localização. corda

Restrições:
Comprimento máximo =

ResourceGroupDefinition

Nome Descrição Valor
dependsOn Artefatos que precisam ser implantados antes desse grupo de recursos. string[]
localização Local deste resourceGroup. Deixe vazio se o local do grupo de recursos for especificado durante a atribuição de blueprint. corda
metadados Propriedades amigáveis para esse grupo de recursos. ParameterDefinitionMetadata
nome Nome desse resourceGroup. Deixe vazio se o nome do grupo de recursos for especificado durante a atribuição de blueprint. corda
Tags Marcas a serem atribuídas a esse grupo de recursos. ResourceGroupDefinitionTags

ResourceGroupDefinitionTags

Nome Descrição Valor

SharedBlueprintPropertiesParameters

Nome Descrição Valor

SharedBlueprintPropertiesResourceGroups

Nome Descrição Valor