Blueprints - Create Or Update

Criar ou atualizar uma definição de planta.

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

Parâmetros do URI

Name In Required Type Description
blueprintName
path True
  • string

Nome da definição de planta.

resourceScope
path True
  • string

O âmbito do recurso. Os âmbitos válidos são: grupo de gestão (formato: '/fornecedores/Microsoft.Management/managementGroup/{managementGroup}'), subscrição (formato: '/subscrições/{subscriçãoId}').

api-version
query True
  • string

Versão API do cliente.

Corpo do Pedido

Name Type Description
description
  • string

Multi-line explicar este recurso.

displayName
  • string

Uma corda de um liner explica este recurso.

properties.parameters

Parâmetros exigidos por esta definição de planta.

properties.resourceGroups

Espaços reservados do grupo de recursos definidos por esta definição de planta.

properties.targetScope

O âmbito onde esta definição de planta pode ser atribuída.

properties.versions
  • object

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

Respostas

Name Type Description
201 Created

Criada, definição de planta guardada.

Other Status Codes

Resposta de erro da planta.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ManagementGroupBlueprint
ResourceGroupWithTags
SubscriptionBlueprint

ManagementGroupBlueprint

Sample Request

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

Sample Response

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

Sample Request

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."
  }
}

Sample Response

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

Sample Request

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

Sample Response

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

Blueprint

Representa uma definição de Planta.

BlueprintStatus

O estado da planta. Este campo é lido apenas.

BlueprintTargetScope

O âmbito onde esta definição de planta pode ser atribuída.

CloudError
ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

ErrorResponse

Resposta a Erros

ParameterDefinition

Represente um parâmetro com constrangimentos e metadados.

ResourceGroupDefinition

Representa um grupo de recursos Azure numa definição de planta.

TemplateParameterType

Tipos de dados permitidos para parâmetros de modelo do Gestor de Recursos.

Blueprint

Representa uma definição de Planta.

Name Type Description
description
  • string

Multi-line explicar este recurso.

displayName
  • string

Uma corda de um liner explica este recurso.

id
  • string

O String ID usado para localizar qualquer recurso no Azure.

name
  • string

Nome deste recurso.

properties.layout
  • object

Vista de layout da definição de planta para referência uI.

properties.parameters

Parâmetros exigidos por esta definição de planta.

properties.resourceGroups

Espaços reservados do grupo de recursos definidos por esta definição de planta.

properties.status

Estado da planta. Este campo é lido apenas.

properties.targetScope

O âmbito onde esta definição de planta pode ser atribuída.

properties.versions
  • object

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

type
  • string

Tipo deste recurso.

BlueprintStatus

O estado da planta. Este campo é lido apenas.

Name Type Description
lastModified
  • string

Última hora modificada desta definição de planta.

timeCreated
  • string

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

BlueprintTargetScope

O âmbito onde esta definição de planta pode ser atribuída.

Name Type Description
managementGroup
  • string

O projeto visa um grupo de gestão durante a atribuição do projeto. Isto está reservado para uso futuro.

subscription
  • string

A planta visa uma subscrição durante a atribuição do projeto.

CloudError

Name Type Description
error

Resposta a Erros
Resposta de erro comum para todas as APIs do Gestor de Recursos Azure para devolver detalhes de erro para operações falhadas. (Isto também segue o formato de resposta a erros OData.)

ErrorAdditionalInfo

O erro de gestão de recursos informações adicionais.

Name Type Description
info
  • object

A informação adicional.

type
  • string

O tipo de informação adicional.

ErrorResponse

Resposta a Erros

Name Type Description
additionalInfo

O erro informação adicional.

code
  • string

O código de erro.

details

Os detalhes do erro.

message
  • string

A mensagem de erro.

target
  • string

O alvo do erro.

ParameterDefinition

Represente um parâmetro com constrangimentos e metadados.

Name Type Description
allowedValues
  • AllowedValues[]

Matriz de valores permitidos para este parâmetro.

defaultValue

Valor predefinido para este parâmetro.

metadata.description
  • string

Descrição deste parâmetro/grupo de recursos.

metadata.displayName
  • string

DisplayName deste parâmetro/grupo de recursos.

metadata.strongType
  • string

StrongType para a UI tornar experiência rica durante a atribuição de projeto. Os tipos fortes suportados são recursosType, principalId e localização.

type

Tipos de dados permitidos para parâmetros de modelo do Gestor de Recursos.

ResourceGroupDefinition

Representa um grupo de recursos Azure numa definição de planta.

Name Type Description
dependsOn
  • string[]

Artefactos que precisam de ser implantados antes deste grupo de recursos.

location
  • string

Localização deste grupo de recursos. Deixe vazio se a localização do grupo de recursos for especificada durante a atribuição da planta.

metadata.description
  • string

Descrição deste parâmetro/grupo de recursos.

metadata.displayName
  • string

DisplayName deste parâmetro/grupo de recursos.

metadata.strongType
  • string

StrongType para a UI tornar experiência rica durante a atribuição de projeto. Os tipos fortes suportados são recursosType, principalId e localização.

name
  • string

Nome deste grupo de recursos. Deixe vazio se o nome do grupo de recursos for especificado durante a atribuição da planta.

tags
  • object

Etiquetas a atribuir a este grupo de recursos.

TemplateParameterType

Tipos de dados permitidos para parâmetros de modelo do Gestor de Recursos.

Name Type Description
array
  • string
bool
  • string
int
  • string
object
  • string
secureObject
  • string
secureString
  • string
string
  • string