Blueprints - Create Or Update

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

Name In Required Type 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

Name Type Description
description
  • string

Explicar este recurso en varias líneas.

displayName
  • string

Una cadena de línea explica este recurso.

properties.parameters

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

properties.resourceGroups

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

properties.targetScope

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

Respuestas

Name Type Description
201 Created

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

Other Status Codes

Respuesta de error de blueprints.

Seguridad

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation suplantar la cuenta de usuario

Ejemplos

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

Definiciones

Blueprint

Representa una definición de plano técnico.

BlueprintStatus

El 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 del 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 Resource Manager parámetros de plantilla.

Blueprint

Representa una definición de plano técnico.

Name Type Description
description
  • string

Explicar este recurso en varias líneas.

displayName
  • string

Una cadena de línea explica este recurso.

id
  • string

Identificador de cadena que se usa 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

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

properties.resourceGroups

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

properties.status

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

properties.targetScope

Á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

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

Name Type Description
lastModified
  • string

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

timeCreated
  • string

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

BlueprintTargetScope

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

Name Type Description
managementGroup
  • string

El plano técnico tiene como destino un grupo de administración durante la asignación del plano técnico. Se reserva para su uso futuro.

subscription
  • string

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

CloudError

Name Type Description
error

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

ErrorAdditionalInfo

Información adicional del error de administración de recursos.

Name Type Description
info
  • object

Información adicional.

type
  • string

Tipo de información adicional.

ErrorResponse

Respuesta de error

Name Type Description
additionalInfo

Información adicional del error.

code
  • string

Código de error.

details

Los detalles del error.

message
  • string

El mensaje de error.

target
  • string

Destino del error.

ParameterDefinition

Representa un parámetro con restricciones y metadatos.

Name Type Description
allowedValues
  • AllowedValues[]

Matriz de valores permitidos para este parámetro.

defaultValue

Valor predeterminado para este parámetro.

metadata.description
  • string

Descripción de este parámetro o resourceGroup.

metadata.displayName
  • string

DisplayName de este parámetro o resourceGroup.

metadata.strongType
  • string

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

type

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

ResourceGroupDefinition

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

Name Type Description
dependsOn
  • string[]

Artifacts deben implementarse antes de este grupo de recursos.

location
  • string

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

metadata.description
  • string

Descripción de este parámetro o resourceGroup.

metadata.displayName
  • string

DisplayName de este parámetro o resourceGroup.

metadata.strongType
  • string

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

name
  • string

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

tags
  • object

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

TemplateParameterType

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

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