Compartir a través de


az keyvault

Administrar claves, secretos y certificados de KeyVault.

Comandos

Nombre Description Tipo Estado
az keyvault backup

Administre la copia de seguridad completa de HSM.

Core GA
az keyvault backup start

Comience una copia de seguridad completa del HSM.

Core GA
az keyvault certificate

Administre certificados.

Core GA
az keyvault certificate backup

Realiza una copia de seguridad del certificado especificado.

Core GA
az keyvault certificate contact

Administrar contactos para la administración de certificados.

Core GA
az keyvault certificate contact add

Agregue un contacto al almacén especificado para recibir notificaciones de operaciones de certificado.

Core GA
az keyvault certificate contact delete

Quite un contacto de certificado del almacén especificado.

Core GA
az keyvault certificate contact list

Enumera los contactos de certificado de un almacén de claves especificado.

Core GA
az keyvault certificate create

Cree un certificado de Key Vault.

Core GA
az keyvault certificate delete

Elimina un certificado de un almacén de claves especificado.

Core En desuso
az keyvault certificate download

Descargue la parte pública de un certificado de Key Vault.

Core GA
az keyvault certificate get-default-policy

Obtenga la directiva predeterminada para los certificados autofirmados.

Core GA
az keyvault certificate import

Importe un certificado en KeyVault.

Core GA
az keyvault certificate issuer

Administrar la información del emisor de certificados.

Core GA
az keyvault certificate issuer admin

Administrar información de administrador para emisores de certificados.

Core GA
az keyvault certificate issuer admin add

Agregue detalles de administrador para un emisor de certificado especificado.

Core GA
az keyvault certificate issuer admin delete

Quite los detalles del administrador del emisor de certificados especificado.

Core GA
az keyvault certificate issuer admin list

Enumera los administradores de un emisor de certificado especificado.

Core GA
az keyvault certificate issuer create

Cree un registro de emisor de certificados.

Core GA
az keyvault certificate issuer delete

Elimina el emisor de certificado especificado.

Core GA
az keyvault certificate issuer list

Enumera las propiedades de los emisores de certificados para el almacén de claves.

Core GA
az keyvault certificate issuer show

Obtiene el emisor de certificado especificado.

Core GA
az keyvault certificate issuer update

Actualice un registro del emisor de certificados.

Core GA
az keyvault certificate list

Enumerar certificados en un almacén de claves especificado.

Core GA
az keyvault certificate list-deleted

Enumera los certificados eliminados recuperables actualmente.

Core GA
az keyvault certificate list-versions

Enumerar las versiones de un certificado.

Core GA
az keyvault certificate pending

Administrar las operaciones pendientes de creación de certificados.

Core GA
az keyvault certificate pending delete

Elimina la operación de creación de un certificado específico.

Core GA
az keyvault certificate pending merge

Combina un certificado o una cadena de certificados con un par de claves existente en el servidor.

Core GA
az keyvault certificate pending show

Obtiene la operación de creación de un certificado.

Core GA
az keyvault certificate purge

Elimina permanentemente el certificado eliminado especificado.

Core GA
az keyvault certificate recover

Recupere un certificado eliminado en su versión más reciente.

Core GA
az keyvault certificate restore

Restaura un certificado de copia de seguridad en un almacén.

Core GA
az keyvault certificate set-attributes

Actualiza los atributos especificados asociados con el certificado dado.

Core GA
az keyvault certificate show

Obtiene información sobre un certificado.

Core GA
az keyvault certificate show-deleted

Obtenga un certificado eliminado.

Core GA
az keyvault check-name

Compruebe que el nombre especificado es válido y que aún no está en uso.

Core GA
az keyvault create

Cree un almacén o un HSM.

Core GA
az keyvault delete

Elimine un almacén o HSM.

Core GA
az keyvault delete-policy

Elimine la configuración de directiva de seguridad de un almacén de claves.

Core GA
az keyvault key

Administrar claves.

Core GA
az keyvault key backup

Solicite que se descargue una copia de seguridad de la clave especificada en el cliente.

Core GA
az keyvault key create

Cree una nueva clave, almacénela y, a continuación, devuelva los parámetros de clave y los atributos al cliente.

Core GA
az keyvault key decrypt

Descifra un único bloque de datos cifrados.

Core Vista previa
az keyvault key delete

Elimine una clave de cualquier tipo de almacenamiento en Vault o HSM.

Core GA
az keyvault key download

Descargue la parte pública de una clave almacenada.

Core GA
az keyvault key encrypt

Cifre una secuencia arbitraria de bytes mediante una clave de cifrado almacenada en un almacén o HSM.

Core Vista previa
az keyvault key get-policy-template

Devuelve la plantilla de directiva como definición de directiva codificada en JSON.

Core Vista previa
az keyvault key import

Importe una clave privada.

Core GA
az keyvault key list

Enumera las claves en el almacén o HSM especificados.

Core GA
az keyvault key list-deleted

Enumere las claves eliminadas en el almacén o HSM especificados.

Core GA
az keyvault key list-versions

Enumere los identificadores y las propiedades de las versiones de una clave.

Core GA
az keyvault key purge

Elimine permanentemente la clave especificada.

Core GA
az keyvault key random

Obtenga el número solicitado de bytes aleatorios de un HSM administrado.

Core GA
az keyvault key recover

Recupere la clave eliminada a su versión más reciente.

Core GA
az keyvault key restore

Restaure una clave de copia de seguridad en un almacén o HSM.

Core GA
az keyvault key rotate

Gire la clave en función de la directiva de claves mediante la generación de una nueva versión de la clave.

Core GA
az keyvault key rotation-policy

Administrar la directiva de rotación de la clave.

Core GA
az keyvault key rotation-policy show

Obtenga la directiva de rotación de una clave de Key Vault.

Core GA
az keyvault key rotation-policy update

Actualice la directiva de rotación de una clave de Key Vault.

Core GA
az keyvault key set-attributes

La operación de actualización de clave cambia los atributos especificados de una clave almacenada y se puede aplicar a cualquier tipo de clave y versión de clave almacenada en Vault o HSM.

Core GA
az keyvault key show

Obtiene los atributos de una clave y, si es una clave asimétrica, su material público.

Core GA
az keyvault key show-deleted

Obtenga la parte pública de una clave eliminada.

Core GA
az keyvault key sign

Cree una firma a partir de un resumen mediante una clave almacenada en un almacén o HSM.

Core GA
az keyvault key verify

Compruebe una firma mediante la clave almacenada en un almacén o HSM.

Core GA
az keyvault list

Enumerar almacenes o HSM.

Core GA
az keyvault list-deleted

Obtenga información sobre los almacenes o HSM eliminados en una suscripción.

Core GA
az keyvault network-rule

Administrar las ACL de red del almacén.

Core GA
az keyvault network-rule add

Agregue una regla de red a las ACL de red de un almacén de claves.

Core GA
az keyvault network-rule list

Enumere las reglas de red de las ACL de red de un almacén de claves.

Core GA
az keyvault network-rule remove

Quite una regla de red de las ACL de red de un almacén de claves.

Core GA
az keyvault network-rule wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del almacén.

Core GA
az keyvault private-endpoint-connection

Administrar conexiones de punto de conexión privado de almacén o HSM.

Core GA
az keyvault private-endpoint-connection approve

Apruebe una solicitud de conexión de punto de conexión privado para una instancia de Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection delete

Elimine la conexión de punto de conexión privado especificada asociada a una instancia de Key Vault/HSM.

Core GA
az keyvault private-endpoint-connection list

Enumere todas las conexiones de punto de conexión privado asociadas a un HSM.

Core GA
az keyvault private-endpoint-connection reject

Rechace una solicitud de conexión de punto de conexión privado para un almacén de claves o HSM.

Core GA
az keyvault private-endpoint-connection show

Muestra los detalles de una conexión de punto de conexión privado asociada a un almacén de claves/HSM.

Core GA
az keyvault private-endpoint-connection wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición de la conexión del punto de conexión privado.

Core GA
az keyvault private-link-resource

Administre los recursos de private link de almacén o HSM.

Core GA
az keyvault private-link-resource list

Enumere los recursos de private link admitidos para key Vault/HSM.

Core GA
az keyvault purge

Elimine permanentemente el almacén o HSM especificados. También conocido como Purga el almacén eliminado o HSM.

Core GA
az keyvault recover

Recuperar un almacén o un HSM.

Core GA
az keyvault region

Administrar varias regiones de MHSM.

Core GA
az keyvault region add

Agregue regiones para el grupo de HSM administrado.

Core GA
az keyvault region list

Obtenga información de regiones asociada al grupo de HSM administrado.

Core GA
az keyvault region remove

Quite las regiones del grupo de HSM administrado.

Core GA
az keyvault region wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del HSM.

Core GA
az keyvault restore

Administrar la restauración completa de HSM.

Core GA
az keyvault restore start

Restaure una copia de seguridad completa de un HSM.

Core GA
az keyvault role

Administrar roles de usuario para el control de acceso.

Core GA
az keyvault role assignment

Administrar asignaciones de roles.

Core GA
az keyvault role assignment create

Crea una nueva asignación de roles para un usuario, grupo o entidad de servicio.

Core GA
az keyvault role assignment delete

Elimine una asignación de roles.

Core GA
az keyvault role assignment list

Lista de asignaciones de roles.

Core GA
az keyvault role definition

Administrar definiciones de roles.

Core GA
az keyvault role definition create

Cree una definición de rol personalizada.

Core GA
az keyvault role definition delete

Elimine una definición de rol.

Core GA
az keyvault role definition list

Lista de definiciones de roles.

Core GA
az keyvault role definition show

Muestra los detalles de una definición de rol.

Core GA
az keyvault role definition update

Actualice una definición de rol.

Core GA
az keyvault secret

Administre los secretos.

Core GA
az keyvault secret backup

Realiza una copia de seguridad del secreto especificado.

Core GA
az keyvault secret delete

Elimine todas las versiones de un secreto.

Core En desuso
az keyvault secret download

Descargue un secreto de KeyVault.

Core GA
az keyvault secret list

Enumeración de secretos en un almacén de claves especificado.

Core GA
az keyvault secret list-deleted

Enumera los secretos eliminados del almacén especificado.

Core GA
az keyvault secret list-versions

Enumera todas las versiones del secreto especificado.

Core GA
az keyvault secret purge

Elimina permanentemente el secreto especificado.

Core GA
az keyvault secret recover

Recupera el secreto eliminado a la versión más reciente.

Core GA
az keyvault secret restore

Restaura un secreto de copia de seguridad en un almacén.

Core GA
az keyvault secret set

Cree un secreto (si no existe) o actualice un secreto en keyVault.

Core GA
az keyvault secret set-attributes

Actualiza los atributos asociados a un secreto especificado en un almacén de claves determinado.

Core GA
az keyvault secret show

Obtenga un secreto especificado de un almacén de claves determinado.

Core GA
az keyvault secret show-deleted

Obtiene el secreto eliminado especificado.

Core GA
az keyvault security-domain

Administrar operaciones de dominio de seguridad.

Core GA
az keyvault security-domain download

Descargue el archivo de dominio de seguridad del HSM.

Core GA
az keyvault security-domain init-recovery

Recupere la clave de intercambio del HSM.

Core GA
az keyvault security-domain restore-blob

Habilite para descifrar y cifrar el archivo de dominio de seguridad como blob. Se puede ejecutar en un entorno sin conexión, antes de cargar el archivo en HSM mediante la carga de dominio de seguridad.

Core GA
az keyvault security-domain upload

Comience a restaurar el HSM.

Core GA
az keyvault security-domain wait

Coloque la CLI en un estado de espera hasta que finalice la operación del dominio de seguridad de HSM.

Core GA
az keyvault set-policy

Actualice la configuración de la directiva de seguridad de un almacén de claves.

Core GA
az keyvault setting

Administrar la configuración de MHSM.

Core GA
az keyvault setting list

Obtenga toda la configuración asociada al HSM administrado.

Core GA
az keyvault setting show

Obtenga una configuración específica asociada al HSM administrado.

Core GA
az keyvault setting update

Actualice la configuración específica asociada al HSM administrado.

Core GA
az keyvault show

Mostrar detalles de un almacén o un HSM.

Core GA
az keyvault show-deleted

Mostrar detalles de un almacén o HSM eliminados.

Core GA
az keyvault update

Actualice las propiedades de un almacén.

Core GA
az keyvault update-hsm

Actualice las propiedades de un HSM.

Core GA
az keyvault wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del almacén.

Core GA
az keyvault wait-hsm

Coloque la CLI en un estado de espera hasta que se cumpla una condición del HSM.

Core GA

az keyvault check-name

Compruebe que el nombre especificado es válido y que aún no está en uso.

az keyvault check-name --name
                       [--resource-type {hsm}]

Parámetros requeridos

--name -n

Nombre del HSM dentro del grupo de recursos especificado.

Parámetros opcionales

--resource-type

Tipo de recurso.

Valores aceptados: hsm
Valor predeterminado: hsm
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 keyvault create

Cree un almacén o un HSM.

Si --enable-rbac-authorization no se especifica, los permisos predeterminados se crean para el usuario o la entidad de servicio actuales a menos que se especifique la --no-self-perms marca.

az keyvault create --resource-group
                   [--administrators]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--hsm-name]
                   [--location]
                   [--mi-user-assigned]
                   [--name]
                   [--network-acls]
                   [--network-acls-ips]
                   [--network-acls-vnets]
                   [--no-self-perms {false, true}]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--retention-days]
                   [--sku]
                   [--tags]

Ejemplos

Cree un almacén de claves con ACL de red especificados (use --network-acls para especificar reglas ip y de red virtual mediante una cadena JSON).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\", \"/subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVNet/subnets/MySubnet\"]}"

Cree un almacén de claves con ACL de red especificados (use --network-acls para especificar reglas ip y de red virtual mediante un archivo JSON).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls network-acls-example.json

Cree un almacén de claves con ACL de red especificadas (use --network-acls-ips para especificar reglas ip).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-ips 3.4.5.0/24 4.5.6.0/24

Cree un almacén de claves con ACL de red especificadas (use --network-acls-vnets para especificar reglas de red virtual).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Cree un almacén de claves con ACL de red especificados (use --network-acls, --network-acls-ips y --network-acls-vnets juntos, se quitarán las reglas redundantes; por último, habrá 4 reglas ip y 3 reglas de red virtual).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\"]}" --network-acls-ips 3.4.5.0/24 4.5.6.0/24 --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Cree un almacén de claves. (generado automáticamente)

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup

Parámetros requeridos

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--administrators

[Solo HSM] Rol de administrador para las operaciones del plano de datos para HSM administrado. Acepta una lista separada por espacios de identificadores de usuario que se asignarán.

--bypass

Omitir el tráfico para usos separados por espacios.

Valores aceptados: AzureServices, None
--default-action

Acción predeterminada que se aplicará cuando no coincida ninguna regla.

Valores aceptados: Allow, Deny
--enable-purge-protection

Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado o almacén. Al establecer esta propiedad en true, se activa la protección contra la purga de este grupo de HSM administrado o almacén y su contenido; solo el servicio Key Vault/Managed HSM puede iniciar una eliminación difícil e irrecuperable. La configuración solo es efectiva si la eliminación temporal también está habilitada. Habilitar esta funcionalidad es irreversible.

Valores aceptados: false, true
--enable-rbac-authorization

Propiedad que controla cómo se autorizan las acciones de datos. Cuando es true, el almacén de claves usará el Control de acceso basado en rol (RBAC) para la autorización de acciones de datos y se omitirán las directivas de acceso especificadas en las propiedades del almacén. Cuando es false, el almacén de claves usará las directivas de acceso especificadas en las propiedades del almacén y se omitirá cualquier directiva almacenada en Azure Resource Manager. Si se especifica null o no, el almacén se crea con el valor predeterminado true. Tenga en cuenta que las acciones de administración siempre están autorizadas con RBAC.

Valores aceptados: false, true
Valor predeterminado: True
--enabled-for-deployment

[Solo almacén] Propiedad para especificar si Azure Virtual Machines puede recuperar certificados almacenados como secretos del almacén de claves.

Valores aceptados: false, true
--enabled-for-disk-encryption

[Solo almacén] Propiedad para especificar si Azure Disk Encryption puede recuperar secretos del almacén y desencapsular claves.

Valores aceptados: false, true
--enabled-for-template-deployment

[Solo almacén] Propiedad para especificar si Azure Resource Manager puede recuperar secretos del almacén de claves.

Valores aceptados: false, true
--hsm-name

Nombre del HSM. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--mi-user-assigned

[Solo HSM] Habilite las identidades administradas asignadas por el usuario para HSM administrado. Acepte la lista separada por espacios de identificadores de recursos de identidad.

--name -n

Nombre del almacén.

--network-acls

ACL de red. Acepta un nombre de archivo JSON o una cadena JSON. Formato JSON: {\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}.

--network-acls-ips

Reglas ip de ACL de red. Lista separada por espacios de direcciones IP.

--network-acls-vnets

Reglas de red de red virtual de ACLS. Lista separada por espacios de pares de redes virtuales o subredes o identificadores de recursos de subred.

--no-self-perms

[Solo almacén] No agregue permisos para el usuario o la entidad de servicio actual en el nuevo almacén.

Valores aceptados: false, true
--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--public-network-access

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valores aceptados: Disabled, Enabled
--retention-days

Días de retención de datos de eliminación temporal. Acepta >=7 y <=90. El valor predeterminado es 90 para la creación del almacén de claves. Necesario para la creación de MHSM.

--sku

Necesario. Detalles de la SKU. Valores permitidos para Vault: Premium, estándar. Valor predeterminado: estándar. Valores permitidos para HSM: Standard_B1, Custom_B32. Valor predeterminado: Standard_B1.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

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 keyvault delete

Elimine un almacén o HSM.

az keyvault delete [--hsm-name]
                   [--name]
                   [--no-wait]
                   [--resource-group]

Ejemplos

Elimine un almacén de claves. (generado automáticamente)

az keyvault delete --name MyKeyVault --resource-group MyResourceGroup

Parámetros opcionales

--hsm-name

Nombre del HSM. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--name -n

Nombre del almacén.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

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 keyvault delete-policy

Elimine la configuración de directiva de seguridad de un almacén de claves.

az keyvault delete-policy --name
                          [--application-id]
                          [--no-wait]
                          [--object-id]
                          [--resource-group]
                          [--spn]
                          [--upn]

Parámetros requeridos

--name -n

Nombre del almacén.

Parámetros opcionales

--application-id

Identificador de aplicación del cliente que realiza la solicitud en nombre de una entidad de seguridad. Se expone para la identidad compuesta mediante el flujo de autenticación en nombre de .

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--object-id

GUID que identifica la entidad de seguridad que recibirá permisos.

--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

--spn

Nombre de una entidad de servicio que recibirá permisos.

--upn

Nombre de una entidad de seguridad de usuario que recibirá permisos.

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 keyvault list

Enumerar almacenes o HSM.

az keyvault list [--resource-group]
                 [--resource-type]

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--resource-type

Cuando --resource-type no está presente, el comando enumerará todos los almacenes y HSM. Los valores posibles para --resource-type son vault y hsm.

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 keyvault list-deleted

Obtenga información sobre los almacenes o HSM eliminados en una suscripción.

az keyvault list-deleted [--resource-type]

Parámetros opcionales

--resource-type

Cuando --resource-type no está presente, el comando enumerará todos los almacenes y HSM eliminados. Los valores posibles para --resource-type son vault y hsm.

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 keyvault purge

Elimine permanentemente el almacén o HSM especificados. También conocido como Purga el almacén eliminado o HSM.

az keyvault purge [--hsm-name]
                  [--location]
                  [--name]
                  [--no-wait]

Parámetros opcionales

--hsm-name

Nombre del HSM eliminado. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--location -l

Ubicación del almacén o HSM eliminados.

--name -n

Nombre del almacén eliminado.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

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 keyvault recover

Recuperar un almacén o un HSM.

Recupere un almacén o HSM eliminado anteriormente para el que se ha habilitado la eliminación temporal.

az keyvault recover [--hsm-name]
                    [--location]
                    [--name]
                    [--no-wait]
                    [--resource-group]

Ejemplos

Recuperar un almacén de claves. (generado automáticamente)

az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup

Parámetros opcionales

--hsm-name

Nombre del HSM eliminado. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--location -l

Ubicación del almacén o HSM eliminados.

--name -n

Nombre del almacén eliminado.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--resource-group -g

Grupo de recursos del almacén o HSM eliminados.

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 keyvault set-policy

Actualice la configuración de la directiva de seguridad de un almacén de claves.

az keyvault set-policy --name
                       [--application-id]
                       [--certificate-permissions {all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update}]
                       [--key-permissions {all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey}]
                       [--no-wait]
                       [--object-id]
                       [--resource-group]
                       [--secret-permissions {all, backup, delete, get, list, purge, recover, restore, set}]
                       [--spn]
                       [--storage-permissions {all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update}]
                       [--upn]

Ejemplos

Asigne permisos de clave "get", "list", "import" y permisos secretos "backup", "restore" a un identificador de objeto.

az keyvault set-policy -n MyVault --key-permissions get list import --secret-permissions backup restore --object-id {GUID}

Asigne permisos de clave "get", "list" a un UPN (nombre principal de usuario).

az keyvault set-policy -n MyVault --key-permissions get list --upn {UPN}

Asigne permisos de clave "get", "list" a un SPN (nombre de entidad de seguridad de servicio).

az keyvault set-policy -n MyVault --key-permissions get list --spn {SPN}

Parámetros requeridos

--name -n

Nombre del almacén.

Parámetros opcionales

--application-id

Identificador de aplicación del cliente que realiza la solicitud en nombre de una entidad de seguridad. Se expone para la identidad compuesta mediante el flujo de autenticación en nombre de .

--certificate-permissions

Lista separada por espacios de permisos de certificado que se van a asignar.

Valores aceptados: all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update
--key-permissions

Lista separada por espacios de permisos de clave que se van a asignar.

Valores aceptados: all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey
--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--object-id

GUID que identifica la entidad de seguridad que recibirá permisos.

--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

--secret-permissions

Lista separada por espacios de permisos secretos que se van a asignar.

Valores aceptados: all, backup, delete, get, list, purge, recover, restore, set
--spn

Nombre de una entidad de servicio que recibirá permisos.

--storage-permissions

Lista separada por espacios de permisos de almacenamiento que se van a asignar.

Valores aceptados: all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update
--upn

Nombre de una entidad de seguridad de usuario que recibirá permisos.

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 keyvault show

Mostrar detalles de un almacén o un HSM.

az keyvault show [--hsm-name]
                 [--name]
                 [--resource-group]

Ejemplos

Mostrar detalles de un almacén de claves. (generado automáticamente)

az keyvault show --name MyKeyVault

Parámetros opcionales

--hsm-name

Nombre del HSM. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--name -n

Nombre del almacén.

--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

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 keyvault show-deleted

Mostrar detalles de un almacén o HSM eliminados.

az keyvault show-deleted [--hsm-name]
                         [--location]
                         [--name]

Ejemplos

Mostrar detalles de un almacén de claves eliminado.

az keyvault show-deleted --name MyKeyVault

Parámetros opcionales

--hsm-name

Nombre del HSM eliminado. (--hsm-name y --name/-n son mutuamente excluyentes, especifique solo uno de ellos).

--location -l

Ubicación del almacén o HSM eliminados.

--name -n

Nombre del almacén eliminado.

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 keyvault update

Actualice las propiedades de un almacén.

az keyvault update --name
                   [--add]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--force-string]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--remove]
                   [--resource-group]
                   [--retention-days]
                   [--set]

Ejemplos

Actualice las propiedades de un almacén. (generado automáticamente)

az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup

Parámetros requeridos

--name -n

Nombre del almacén.

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 or JSON string>.

Valor predeterminado: []
--bypass

Omitir el tráfico para usos separados por espacios.

Valores aceptados: AzureServices, None
--default-action

Acción predeterminada que se aplicará cuando no coincida ninguna regla.

Valores aceptados: Allow, Deny
--enable-purge-protection

Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado o almacén. Al establecer esta propiedad en true, se activa la protección contra la purga de este grupo de HSM administrado o almacén y su contenido; solo el servicio Key Vault/Managed HSM puede iniciar una eliminación difícil e irrecuperable. La configuración solo es efectiva si la eliminación temporal también está habilitada. Habilitar esta funcionalidad es irreversible.

Valores aceptados: false, true
--enable-rbac-authorization

Propiedad que controla cómo se autorizan las acciones de datos. Cuando es true, el almacén de claves usará el Control de acceso basado en rol (RBAC) para la autorización de acciones de datos y se omitirán las directivas de acceso especificadas en las propiedades del almacén. Cuando es false, el almacén de claves usará las directivas de acceso especificadas en las propiedades del almacén y se omitirá cualquier directiva almacenada en Azure Resource Manager. Si se especifica null o no, el almacén se crea con el valor predeterminado true. Tenga en cuenta que las acciones de administración siempre están autorizadas con RBAC.

Valores aceptados: false, true
--enabled-for-deployment

[Solo almacén] Propiedad para especificar si Azure Virtual Machines puede recuperar certificados almacenados como secretos del almacén de claves.

Valores aceptados: false, true
--enabled-for-disk-encryption

[Solo almacén] Propiedad para especificar si Azure Disk Encryption puede recuperar secretos del almacén y desencapsular claves.

Valores aceptados: false, true
--enabled-for-template-deployment

[Solo almacén] Propiedad para especificar si Azure Resource Manager puede recuperar secretos del almacén de claves.

Valores aceptados: false, true
--force-string

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

Valor predeterminado: False
--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--public-network-access

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valores aceptados: Disabled, Enabled
--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []
--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

--retention-days

Días de retención de datos de eliminación temporal. Acepta >=7 y <=90.

--set

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

Valor predeterminado: []
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 keyvault update-hsm

Actualice las propiedades de un HSM.

az keyvault update-hsm --hsm-name
                       [--add]
                       [--bypass {AzureServices, None}]
                       [--default-action {Allow, Deny}]
                       [--enable-purge-protection {false, true}]
                       [--force-string]
                       [--mi-user-assigned]
                       [--no-wait]
                       [--public-network-access {Disabled, Enabled}]
                       [--remove]
                       [--resource-group]
                       [--secondary-locations]
                       [--set]

Ejemplos

Actualice las propiedades de un HSM.

az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup

Parámetros requeridos

--hsm-name

Nombre del HSM.

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 or JSON string>.

Valor predeterminado: []
--bypass

Omitir el tráfico para usos separados por espacios.

Valores aceptados: AzureServices, None
--default-action

Acción predeterminada que se aplicará cuando no coincida ninguna regla.

Valores aceptados: Allow, Deny
--enable-purge-protection -e

Propiedad que especifica si la protección contra purga está habilitada para este grupo de HSM administrado o almacén. Al establecer esta propiedad en true, se activa la protección contra la purga de este grupo de HSM administrado o almacén y su contenido; solo el servicio Key Vault/Managed HSM puede iniciar una eliminación difícil e irrecuperable. La configuración solo es efectiva si la eliminación temporal también está habilitada. Habilitar esta funcionalidad es irreversible.

Valores aceptados: false, true
--force-string

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

Valor predeterminado: False
--mi-user-assigned

Habilite las identidades administradas asignadas por el usuario para HSM administrado. Acepte la lista separada por espacios de identificadores de recursos de identidad.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

Valor predeterminado: False
--public-network-access

Permiso de control para el tráfico del plano de datos procedente de redes públicas mientras el punto de conexión privado está habilitado.

Valores aceptados: Disabled, Enabled
--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []
--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

--secondary-locations

--secondary-locations extiende o contrae un grupo de HSM a las regiones enumeradas. La ubicación principal donde se creó originalmente el recurso no se puede quitar.

--set

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

Valor predeterminado: []
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 keyvault wait

Coloque la CLI en un estado de espera hasta que se cumpla una condición del almacén.

az keyvault wait --name
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--resource-group]
                 [--timeout]
                 [--updated]

Ejemplos

Pause la CLI hasta que se cree el almacén.

az keyvault wait --name MyVault --created

Parámetros requeridos

--name -n

Nombre del almacén.

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30
--resource-group -g

Continúe solo si Key Vault pertenece al grupo de recursos especificado.

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

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 keyvault wait-hsm

Coloque la CLI en un estado de espera hasta que se cumpla una condición del HSM.

az keyvault wait-hsm --hsm-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--resource-group]
                     [--timeout]
                     [--updated]

Ejemplos

Pause la CLI hasta que se cree el HSM.

az keyvault wait-hsm --hsm-name MyHSM --created

Parámetros requeridos

--hsm-name

Nombre del HSM.

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

Valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

Valor predeterminado: False
--exists

Espere hasta que exista el recurso.

Valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

Valor predeterminado: 30
--resource-group -g

Continúe solo si HSM pertenece al grupo de recursos especificado.

--timeout

Espera máxima en segundos.

Valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

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.