Compartilhar via

Blueprints - Create Or Update

Serviço:
Blueprints
Versão da API:
2018-11-01-preview

Crie ou atualize uma definição de blueprint.

PUT https://management.azure.com/{resourceScope}/providers/Microsoft.Blueprint/blueprints/{blueprintName}?api-version=2018-11-01-preview

Parâmetros de URI

Nome Em Obrigatório Tipo Description
blueprintName
 path True

string

Nome da definição do blueprint.
resourceScope
 path True

string

O escopo do recurso. Os escopos válidos são: grupo de gerenciamento (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), assinatura (formato: '/subscriptions/{subscriptionId}').
api-version
 query True

string

Versão da API do cliente.

Corpo da solicitação

Nome Obrigatório Tipo Description
properties.targetScope True

BlueprintTargetScope

O escopo em que essa definição de blueprint pode ser atribuída.
description

string

maxLength: 500

Várias linhas explicam esse recurso.
displayName

string

maxLength: 256

Uma cadeia de caracteres de linha explica esse recurso.
properties.parameters

<string,  ParameterDefinition>

Parâmetros exigidos por essa definição de blueprint.
properties.resourceGroups

<string,  ResourceGroupDefinition>

Espaços reservados do grupo de recursos definidos por essa definição de blueprint.
properties.versions

object

Versões publicadas dessa definição de blueprint.

Respostas

Nome Tipo Description
201 Created

Blueprint

Criado – definição de blueprint salva.
Other Status Codes

CloudError

Resposta de erro de blueprints.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ManagementGroupBlueprint
ResourceGroupWithTags
SubscriptionBlueprint

ManagementGroupBlueprint

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  }
}

Resposta de exemplo

Código de status:
201 
{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

ResourceGroupWithTags

Solicitação de exemplo

PUT https://management.azure.com/providers/Microsoft.Management/managementGroups/{ManagementGroupId}/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "targetScope": "subscription",
    "resourceGroups": {
      "myRGName": {
        "name": "myRGName",
        "location": "westus",
        "metadata": {
          "displayName": "My Resource Group"
        },
        "tags": {
          "costcenter": "123456",
          "nameOnlyTag": ""
        }
      }
    },
    "description": "An example blueprint containing an RG with two tags."
  }
}

Resposta de exemplo

Código de status:
201 
{
  "properties": {
    "parameters": {},
    "resourceGroups": {
      "myRGName": {
        "name": "myRGName",
        "location": "westus",
        "metadata": {
          "displayName": "My Resource Group"
        },
        "dependsOn": [],
        "tags": {
          "costcenter": "123456",
          "tagWithNoValue": ""
        }
      }
    },
    "targetScope": "subscription",
    "status": {
      "timeCreated": "2019-04-29T20:52:56+00:00",
      "lastModified": "2019-04-29T20:52:56+00:00"
    },
    "description": "An example blueprint containing an RG with two tags."
  },
  "id": "/providers/Microsoft.Management/managementGroups/{ManagementGroupId}/providers/Microsoft.Blueprint/blueprints/RGTaggingExample",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "RGTaggingExample"
}

SubscriptionBlueprint

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint?api-version=2018-11-01-preview

{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type."
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription."
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment."
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  }
}

Resposta de exemplo

Código de status:
201 
{
  "properties": {
    "description": "blueprint contains all artifact kinds {'template', 'rbac', 'policy'}",
    "parameters": {
      "storageAccountType": {
        "type": "string",
        "metadata": {
          "displayName": "storage account type.",
          "description": null
        }
      },
      "costCenter": {
        "type": "string",
        "metadata": {
          "displayName": "force cost center tag for all resources under given subscription.",
          "description": null
        }
      },
      "owners": {
        "type": "array",
        "metadata": {
          "displayName": "assign owners to subscription along with blueprint assignment.",
          "description": null
        }
      }
    },
    "resourceGroups": {
      "storageRG": {
        "metadata": {
          "displayName": "storage resource group",
          "description": "Contains storageAccounts that collect all shoebox logs."
        }
      }
    },
    "targetScope": "subscription"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprints/simpleBlueprint",
  "type": "Microsoft.Blueprint/blueprints",
  "name": "simpleBlueprint"
}

Definições

Nome Description
Blueprint

Representa uma definição de Blueprint.
BlueprintStatus

O status do blueprint. Este campo é somente leitura.
BlueprintTargetScope

O escopo em que essa definição de blueprint pode ser atribuída.
CloudError
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorResponse

Resposta de erro
ParameterDefinition

Represente um parâmetro com restrições e metadados.
ResourceGroupDefinition

Representa um grupo de recursos do Azure em uma definição de blueprint.
TemplateParameterType

Tipos de dados permitidos para parâmetros de modelo do Resource Manager.

Blueprint

Objeto

Representa uma definição de Blueprint.

Nome Tipo Description
description

string

maxLength: 500

Várias linhas explicam esse recurso.
displayName

string

maxLength: 256

Uma cadeia de caracteres de linha explica esse recurso.
id

string

ID da cadeia de caracteres usada para localizar qualquer recurso no Azure.
name

string

Nome desse recurso.
properties.layout

object

Modo de exibição de layout da definição de blueprint para referência de interface do usuário.
properties.parameters

<string,  ParameterDefinition>

Parâmetros exigidos por essa definição de blueprint.
properties.resourceGroups

<string,  ResourceGroupDefinition>

Espaços reservados do grupo de recursos definidos por essa definição de blueprint.
properties.status

BlueprintStatus

Status do blueprint. Este campo é somente leitura.
properties.targetScope

BlueprintTargetScope

O escopo em que essa definição de blueprint pode ser atribuída.
properties.versions

object

Versões publicadas dessa definição de blueprint.
type

string

Tipo desse recurso.

BlueprintStatus

Objeto

O status do blueprint. Este campo é somente leitura.

Nome Tipo Description
lastModified

string (date-time)

Hora da última modificação dessa definição de blueprint.
timeCreated

string (date-time)

Hora de criação dessa definição de blueprint.

BlueprintTargetScope

Enumeração

O escopo em que essa definição de blueprint pode ser atribuída.

Valor Description
subscription

O blueprint destina-se a uma assinatura durante a atribuição de blueprint.
managementGroup

O blueprint tem como destino um grupo de gerenciamento durante a atribuição de blueprint. Isso é reservado para uso futuro.

CloudError

Objeto
Nome Tipo Description
error

ErrorResponse

Resposta de erro
Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorResponse[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ParameterDefinition

Objeto

Represente um parâmetro com restrições e metadados.

Nome Tipo Description
allowedValues

AllowedValues[]

Matriz de valores permitidos para esse parâmetro.
defaultValue

Valor padrão para esse parâmetro.
metadata.description

string

maxLength: 500

Descrição desse parâmetro/resourceGroup.
metadata.displayName

string

maxLength: 256

DisplayName deste parâmetro/resourceGroup.
metadata.strongType

string

maxLength: 64

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.
type

TemplateParameterType

Tipos de dados permitidos para parâmetros de modelo do Resource Manager.

ResourceGroupDefinition

Objeto

Representa um grupo de recursos do Azure em uma definição de blueprint.

Nome Tipo Description
dependsOn

string[]

Artefatos que precisam ser implantados antes desse grupo de recursos.
location

string

Local deste resourceGroup. Deixe vazio se o local do grupo de recursos for especificado durante a atribuição de blueprint.
metadata.description

string

maxLength: 500

Descrição desse parâmetro/resourceGroup.
metadata.displayName

string

maxLength: 256

DisplayName deste parâmetro/resourceGroup.
metadata.strongType

string

maxLength: 64

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.
name

string

Nome desse resourceGroup. Deixe vazio se o nome do grupo de recursos for especificado durante a atribuição de blueprint.
tags

object

Marcas a serem atribuídas a esse grupo de recursos.

TemplateParameterType

Enumeração

Tipos de dados permitidos para parâmetros de modelo do Resource Manager.

Valor Description
string
array
bool
int
object
secureObject
secureString