az blueprint

  • Referencia

Nota:

Esta referencia forma parte de la extensión de plano técnico para la CLI de Azure (versión 2.50.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az blueprint . Obtenga más información sobre las extensiones.

Comandos para administrar el plano técnico.

Comandos

Nombre Description Tipo Estado
az blueprint artifact

Comandos para administrar el artefacto del plano técnico.

 Extensión GA
az blueprint artifact delete

Elimine un artefacto de plano técnico.

 Extensión Vista previa
az blueprint artifact list

Enumera los artefactos de una definición de plano técnico determinada.

 Extensión Vista previa
az blueprint artifact policy

Comandos para administrar el artefacto de asignación de directivas de plano técnico.

 Extensión GA
az blueprint artifact policy create

Cree un artefacto de directiva de plano técnico.

 Extensión GA
az blueprint artifact policy update

Actualice el artefacto de la directiva de plano técnico.

 Extensión GA
az blueprint artifact role

Comandos para administrar el artefacto de asignación de roles de plano técnico.

 Extensión GA
az blueprint artifact role create

Cree un artefacto de rol de plano técnico.

 Extensión GA
az blueprint artifact role update

Actualice el artefacto del rol de plano técnico.

 Extensión GA
az blueprint artifact show

Obtenga un artefacto de plano técnico.

 Extensión Vista previa
az blueprint artifact template

Comandos para administrar el artefacto de plantilla de ARM del plano técnico.

 Extensión GA
az blueprint artifact template create

Cree un artefacto de arm de plano técnico.

 Extensión GA
az blueprint artifact template update

Actualice el artefacto del arm del plano técnico.

 Extensión GA
az blueprint assignment

Comandos para administrar la asignación de plano técnico.

 Extensión GA
az blueprint assignment create

Cree una asignación de plano técnico.

 Extensión GA
az blueprint assignment delete

Elimine una asignación de plano técnico.

 Extensión Vista previa
az blueprint assignment list

Enumera las asignaciones de plano técnico dentro de una suscripción.

 Extensión Vista previa
az blueprint assignment show

Obtener una asignación de plano técnico.

 Extensión Vista previa
az blueprint assignment update

Actualice una asignación de plano técnico.

 Extensión GA
az blueprint assignment wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de asignación de plano técnico.

 Extensión GA
az blueprint assignment who

Obtenga blueprint Servie Principal Name objectId.

 Extensión Vista previa
az blueprint create

Cree una definición de plano técnico.

 Extensión Vista previa
az blueprint delete

Elimine una definición de plano técnico.

 Extensión Vista previa
az blueprint export

Exporte una definición de plano técnico y artefactos a archivos JSON.

 Extensión GA
az blueprint import

Importe una definición de plano técnico y artefactos desde un directoy de archivos JSON.

 Extensión GA
az blueprint list

Enumerar definiciones de plano técnico.

 Extensión Vista previa
az blueprint publish

Publique una nueva versión de la definición del plano técnico con los artefactos más recientes. Las definiciones de plano técnico publicadas son inmutables.

 Extensión Vista previa
az blueprint resource-group

Comandos para administrar el artefacto del grupo de recursos del plano técnico.

 Extensión GA
az blueprint resource-group add

Agregue un artefacto de grupo de recursos al plano técnico.

 Extensión GA
az blueprint resource-group list

Enumerar artefacto de grupo de recursos de plano técnico.

 Extensión GA
az blueprint resource-group remove

Quite un artefacto de grupo de recursos de plano técnico.

 Extensión GA
az blueprint resource-group show

Mostrar artefacto de grupo de recursos de plano técnico.

 Extensión GA
az blueprint resource-group update

Actualice el artefacto del grupo de recursos del plano técnico.

 Extensión GA
az blueprint show

Obtenga una definición de plano técnico.

 Extensión Vista previa
az blueprint update

Actualice una definición de plano técnico.

 Extensión Vista previa
az blueprint version

Comandos para administrar versiones de plano técnico publicadas.

 Extensión Vista previa
az blueprint version artifact

Comandos para administrar artefactos de plano técnico publicados.

 Extensión Vista previa
az blueprint version artifact list

Enumerar artefactos para una versión de un plano técnico publicado.

 Extensión Vista previa
az blueprint version artifact show

Mostrar un artefacto para un plano técnico publicado.

 Extensión Vista previa
az blueprint version delete

Elimine una versión publicada de un plano técnico.

 Extensión Vista previa
az blueprint version list

Enumerar las versiones publicadas de una definición de plano técnico determinada.

 Extensión Vista previa
az blueprint version show

Obtenga una versión publicada de un plano técnico.

 Extensión Vista previa

az blueprint create

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Cree una definición de plano técnico.

az blueprint create --name
                    --target-scope {managementGroup, subscription}
                    [--description]
                    [--display-name]
                    [--management-group]
                    [--parameters]
                    [--resource-groups]
                    [--subscription]

Ejemplos

Creación de un plano técnico de suscripción

az blueprint create --subscription MySubscription --name MyBlueprint --description "blueprint contains all artifacts" --target-scope subscription

Creación de un plano técnico de un grupo de administración

az blueprint create --management-group MyManagementGroup --name MyBlueprint --description "blueprint contains all artifact" --target-scope subscription

Parámetros requeridos

--name -n

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

--target-scope

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

valores aceptados: managementGroup, subscription

Parámetros opcionales

--description

En varias líneas se explica este recurso.

--display-name

Una cadena de línea explica este recurso.

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--parameters -p

Parámetros requeridos por esta definición de plano técnico. Puede ser una cadena JSON o una ruta de acceso del archivo JSON. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--resource-groups

Marcadores de posición del grupo de recursos definidos por esta definición de plano técnico. Valor esperado: json-string/@json-file. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint delete

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Elimine una definición de plano técnico.

az blueprint delete --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Ejemplos

Eliminación de un plano técnico de un grupo de administración

az blueprint delete --management-group MyManagementGroup --name MyBlueprint

Eliminación de un plano técnico de suscripción

az blueprint delete --subscription MySubscription --name MyBlueprint

Parámetros requeridos

--name -n

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

Parámetros opcionales

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint export

Exporte una definición de plano técnico y artefactos a archivos JSON.

az blueprint export --name
                    --output-path
                    [--management-group]
                    [--subscription]
                    [--yes]

Ejemplos

Exportación de una definición y artefactos de plano técnico

az blueprint export --name MyBlueprint \
--output-path "path/to/blueprint/directory"

Parámetros requeridos

--name -n

Nombre de la definición del plano técnico que se va a exportar.

--output-path

Ruta de acceso del directorio para las definiciones json del plano técnico y los artefactos. El archivo de definición del plano técnico se denominará blueprint.json. Los archivos JSON de artefactos estarán en un subdirectorio denominado artifacts.

Parámetros opcionales

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

--yes -y

Omita la confirmación del usuario. Cuando se establece, si el directorio no existe, se creará. Si el directorio existe y tiene contenido, se sobrescribirán. Si no se establece, se pedirá al usuario permiso para continuar.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint import

Importe una definición de plano técnico y artefactos desde un directoy de archivos JSON.

az blueprint import --input-path
                    --name
                    [--management-group]
                    [--subscription]
                    [--yes]

Ejemplos

Importación de una definición y artefactos de plano técnico

az blueprint import --name MyBlueprint \
--input-path "path/to/blueprint/directory"

Parámetros requeridos

--input-path

Ruta de acceso del directorio para las definiciones json del plano técnico y los artefactos. El archivo de definición del plano técnico debe denominarse blueprint.json. Los archivos JSON de artefactos deben estar en un subdirectorio denominado artifacts.

--name -n

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

Parámetros opcionales

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint list

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Enumerar definiciones de plano técnico.

az blueprint list [--management-group]
                  [--max-items]
                  [--next-token]
                  [--subscription]

Ejemplos

Enumeración de planos técnicos en un grupo de administración

az blueprint list --management-group MyManagementGroup

Enumeración de planos técnicos en una suscripción

az blueprint list --subscription MySubscription

Parámetros opcionales

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--max-items

Número total de elementos que se van a devolver en la salida del comando. Si el número total de elementos disponibles es mayor que el valor especificado, se proporciona un token en la salida del comando. Para reanudar la paginación, proporcione el valor del token en --next-token el argumento de un comando posterior.

--next-token

Token para especificar dónde iniciar la paginación. Este es el valor del token de una respuesta truncada anteriormente.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint publish

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Publique una nueva versión de la definición del plano técnico con los artefactos más recientes. Las definiciones de plano técnico publicadas son inmutables.

az blueprint publish --blueprint-name
                     --version
                     [--change-notes]
                     [--management-group]
                     [--subscription]

Ejemplos

Publicación de un plano técnico de un grupo de administración

az blueprint publish --management-group MyManagementGroup --blueprint-name MyBlueprint --version v2

Publicación de un plano técnico de suscripción

az blueprint publish --subscription MySubscription --blueprint-name MyBlueprint --version v2

Parámetros requeridos

--blueprint-name

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

--version

Versión de la definición del plano técnico publicado.

Parámetros opcionales

--change-notes

Notas de cambio específicas de la versión.

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint show

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Obtenga una definición de plano técnico.

az blueprint show --name
                  [--management-group]
                  [--subscription]

Ejemplos

Mostrar un plano técnico de un grupo de administración

az blueprint show --management-group MyManagementGroup --name MyBlueprint

Mostrar un plano técnico de suscripción

az blueprint show --subscription MySubscription --name MyBlueprint

Parámetros requeridos

--name -n

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

Parámetros opcionales

--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az blueprint update

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Actualice una definición de plano técnico.

az blueprint update --name
                    [--add]
                    [--description]
                    [--display-name]
                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                    [--management-group]
                    [--parameters]
                    [--remove]
                    [--resource-groups]
                    [--set]
                    [--subscription]
                    [--target-scope {managementGroup, subscription}]

Parámetros requeridos

--name -n

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

Parámetros opcionales

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string o JSON string>.

--description

En varias líneas se explica este recurso.

--display-name

Una cadena de línea explica este recurso.

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

valores aceptados: 0, 1, f, false, n, no, t, true, y, yes
--management-group -m

Use el grupo de administración para el ámbito del plano técnico.

--parameters -p

Parámetros requeridos por esta definición de plano técnico. Puede ser una cadena JSON o una ruta de acceso del archivo JSON. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list OR --remove propertyToRemove.

--resource-groups

Marcadores de posición del grupo de recursos definidos por esta definición de plano técnico. Admite la sintaxis abreviada, json-file y yaml-file. Intenta "??" para mostrar más.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=.

--subscription -s

Use la suscripción para el ámbito del plano técnico. Si no se especifica --management-group, el valor --subscription o la suscripción predeterminada se usarán como ámbito.

--target-scope

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

valores aceptados: managementGroup, subscription
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.