Blueprints - Create Or Update

Servicio:
Blueprints
Versión de la API:
2018-11-01-preview

Cree o actualice una definición de plano técnico.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
blueprintName
 path True

string

Nombre de la definición del plano técnico.
resourceScope
 path True

string

Ámbito del recurso. Los ámbitos válidos son: grupo de administración (formato: '/providers/Microsoft.Management/managementGroups/{managementGroup}'), suscripción (formato: '/subscriptions/{subscriptionId}').
api-version
 query True

string

Versión de la API de cliente.

Cuerpo de la solicitud

Nombre Requerido Tipo Description
properties.targetScope True

BlueprintTargetScope

Ámbito en el que se puede asignar esta definición de plano técnico.
description

string

maxLength: 500

En varias líneas se explica este recurso.
displayName

string

maxLength: 256

Una cadena de línea explica este recurso.
properties.parameters

<string,  ParameterDefinition>

Parámetros requeridos por esta definición de plano técnico.
properties.resourceGroups

<string,  ResourceGroupDefinition>

Marcadores de posición del grupo de recursos definidos por esta definición de plano técnico.
properties.versions

object

Versiones publicadas de esta definición de plano técnico.

Respuestas

Nombre Tipo Description
201 Created

Blueprint

Creado: definición de plano técnico guardada.
Other Status Codes

CloudError

Respuesta de error de planos técnicos.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

ManagementGroupBlueprint
ResourceGroupWithTags
SubscriptionBlueprint

ManagementGroupBlueprint

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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"
}

Definiciones

Nombre Description
Blueprint

Representa una definición de plano técnico.
BlueprintStatus

Estado del plano técnico. Este campo es de solo lectura.
BlueprintTargetScope

Ámbito en el que se puede asignar esta definición de plano técnico.
CloudError
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorResponse

Respuesta de error
ParameterDefinition

Representa un parámetro con restricciones y metadatos.
ResourceGroupDefinition

Representa un grupo de recursos de Azure en una definición de plano técnico.
TemplateParameterType

Tipos de datos permitidos para los parámetros de plantilla de Resource Manager.

Blueprint

Object

Representa una definición de plano técnico.

Nombre Tipo Description
description

string

maxLength: 500

En varias líneas se explica este recurso.
displayName

string

maxLength: 256

Una cadena de línea explica este recurso.
id

string

Identificador de cadena usado para buscar cualquier recurso en Azure.
name

string

Nombre de este recurso.
properties.layout

object

Vista de diseño de la definición del plano técnico para la referencia de la interfaz de usuario.
properties.parameters

<string,  ParameterDefinition>

Parámetros requeridos por esta definición de plano técnico.
properties.resourceGroups

<string,  ResourceGroupDefinition>

Marcadores de posición del grupo de recursos definidos por esta definición de plano técnico.
properties.status

BlueprintStatus

Estado del plano técnico. Este campo es de solo lectura.
properties.targetScope

BlueprintTargetScope

Ámbito en el que se puede asignar esta definición de plano técnico.
properties.versions

object

Versiones publicadas de esta definición de plano técnico.
type

string

Tipo de este recurso.

BlueprintStatus

Object

Estado del plano técnico. Este campo es de solo lectura.

Nombre Tipo Description
lastModified

string (date-time)

Hora de última modificación de esta definición de plano técnico.
timeCreated

string (date-time)

Hora de creación de esta definición de plano técnico.

BlueprintTargetScope

Enumeración

Ámbito en el que se puede asignar esta definición de plano técnico.

Valor Description
subscription

El plano técnico tiene como destino una suscripción durante la asignación del plano técnico.
managementGroup

El plano técnico tiene como destino un grupo de administración durante la asignación del plano técnico. Esto está reservado para uso futuro.

CloudError

Object
Nombre Tipo Description
error

ErrorResponse

Respuesta de error
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorResponse[]

Detalles del error.
message

string

Mensaje de error.
target

string

Destino del error.

ParameterDefinition

Object

Representa un parámetro con restricciones y metadatos.

Nombre Tipo Description
allowedValues

AllowedValues[]

Matriz de valores permitidos para este parámetro.
defaultValue

Valor predeterminado para este parámetro.
metadata.description

string

maxLength: 500

Descripción de este parámetro o resourceGroup.
metadata.displayName

string

maxLength: 256

DisplayName de este parámetro o resourceGroup.
metadata.strongType

string

maxLength: 64

StrongType para que la interfaz de usuario represente una experiencia enriquecida durante la asignación del plano técnico. Los tipos seguros admitidos son resourceType, principalId y location.
type

TemplateParameterType

Tipos de datos permitidos para los parámetros de plantilla de Resource Manager.

ResourceGroupDefinition

Object

Representa un grupo de recursos de Azure en una definición de plano técnico.

Nombre Tipo Description
dependsOn

string[]

Artefactos que deben implementarse antes de este grupo de recursos.
location

string

Ubicación de este resourceGroup. Deje vacío si la ubicación del grupo de recursos se especificará durante la asignación del plano técnico.
metadata.description

string

maxLength: 500

Descripción de este parámetro o resourceGroup.
metadata.displayName

string

maxLength: 256

DisplayName de este parámetro o resourceGroup.
metadata.strongType

string

maxLength: 64

StrongType para que la interfaz de usuario represente una experiencia enriquecida durante la asignación del plano técnico. Los tipos seguros admitidos son resourceType, principalId y location.
name

string

Nombre de este resourceGroup. Deje vacío si el nombre del grupo de recursos se especificará durante la asignación del plano técnico.
tags

object

Etiquetas que se asignarán a este grupo de recursos.

TemplateParameterType

Enumeración

Tipos de datos permitidos para los parámetros de plantilla de Resource Manager.

Valor Description
string
array
bool
int
object
secureObject
secureString