Partilhar 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 do URI

Name Em Necessá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 do Pedido

Name Necessário Tipo Description
properties.targetScope True

BlueprintTargetScope

O âmbito em que esta definição de modelo pode ser atribuída.
description

string

maxLength: 500

Multi-linha explicar este recurso.
displayName

string

maxLength: 256

Uma cadeia de caracteres de linha única explica este recurso.
properties.parameters

<string,  ParameterDefinition>

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

<string,  ResourceGroupDefinition>

Espaços reservados para grupos de recursos definidos por esta definição de blueprint.
properties.versions

object

Versões publicadas desta definição de modelo.

Respostas

Name Tipo Description
201 Created

Blueprint

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

CloudError

Blueprints resposta de erro.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ManagementGroupBlueprint
ResourceGroupWithTags
SubscriptionBlueprint

ManagementGroupBlueprint

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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 da amostra

Código de estado:
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

Name Description
Blueprint

Representa uma definição de Blueprint.
BlueprintStatus

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

O âmbito em que esta definição de modelo pode ser atribuída.
CloudError
ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.
ErrorResponse

Resposta de erro
ParameterDefinition

Representar 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

Object

Representa uma definição de Blueprint.

Name Tipo Description
description

string

maxLength: 500

Multi-linha explicar este recurso.
displayName

string

maxLength: 256

Uma cadeia de caracteres de linha única explica este recurso.
id

string

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

string

Nome deste recurso.
properties.layout

object

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

<string,  ParameterDefinition>

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

<string,  ResourceGroupDefinition>

Espaços reservados para grupos de recursos definidos por esta definição de blueprint.
properties.status

BlueprintStatus

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

BlueprintTargetScope

O âmbito em que esta definição de modelo pode ser atribuída.
properties.versions

object

Versões publicadas desta definição de modelo.
type

string

Tipo deste recurso.

BlueprintStatus

Object

O status do plano. Este campo é somente leitura.

Name Tipo Description
lastModified

string (date-time)

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

string (date-time)

Tempo de criação desta definição de blueprint.

BlueprintTargetScope

Enumeração

O âmbito em que esta definição de modelo pode ser atribuída.

Valor Description
subscription

O blueprint tem como alvo uma assinatura durante a atribuição do blueprint.
managementGroup

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

CloudError

Object
Name Tipo Description
error

ErrorResponse

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

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorResponse

Object

Resposta de erro

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.
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

Object

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

Name Tipo Description
allowedValues

AllowedValues[]

Matriz de valores permitidos para este parâmetro.
defaultValue

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

string

maxLength: 500

Descrição deste 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 uma experiência rica durante a atribuição do blueprint. Os tipos fortes suportados são resourceType, principalId e location.
type

TemplateParameterType

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

ResourceGroupDefinition

Object

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

Name Tipo Description
dependsOn

string[]

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

string

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

string

maxLength: 500

Descrição deste 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 uma experiência rica durante a atribuição do blueprint. Os tipos fortes suportados são resourceType, principalId e location.
name

string

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

object

Tags a serem atribuídas a este 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