az keyvault secret

  • Referencia

Administre los secretos.

Comandos

Nombre Description Tipo Estado
az keyvault secret backup

Realiza una copia de seguridad del secreto especificado.

 Principal GA
az keyvault secret delete

Elimine todas las versiones de un secreto.

 Principal Obsoleto
az keyvault secret download

Descargue un secreto de KeyVault.

 Principal GA
az keyvault secret list

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

 Principal GA
az keyvault secret list-deleted

Enumera los secretos eliminados del almacén especificado.

 Principal GA
az keyvault secret list-versions

Enumera todas las versiones del secreto especificado.

 Principal GA
az keyvault secret purge

Elimina permanentemente el secreto especificado.

 Principal GA
az keyvault secret recover

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

 Principal GA
az keyvault secret restore

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

 Principal GA
az keyvault secret set

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

 Principal GA
az keyvault secret set-attributes

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

 Principal GA
az keyvault secret show

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

 Principal GA
az keyvault secret show-deleted

Obtiene el secreto eliminado especificado.

 Principal GA

az keyvault secret backup

Editar

Realiza una copia de seguridad del secreto especificado.

Solicita que se descargue una copia de seguridad del secreto especificado en el cliente. Se descargarán todas las versiones del secreto. Esta operación requiere el permiso secretos o copia de seguridad.

az keyvault secret backup --file
                          [--id]
                          [--name]
                          [--vault-name]

Parámetros requeridos

--file -f

Archivo para recibir el contenido del secreto.

Parámetros opcionales

--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

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

Editar
Obsoleto

Advertencia. Si tiene habilitada la protección de eliminación temporal en este almacén de claves, este secreto se moverá al estado de eliminación temporal. No podrá crear un secreto con el mismo nombre dentro de este almacén de claves hasta que el secreto se haya purgado del estado eliminado temporalmente. Consulte la siguiente documentación para obtener instrucciones adicionales. https://docs.microsoft.com/azure/key-vault/general/soft-delete-overview

Elimine todas las versiones de un secreto.

Requiere el permiso secrets/delete. Cuando este método devuelve Key Vault ha comenzado a eliminar el secreto. La eliminación puede tardar varios segundos en un almacén con la eliminación temporal habilitada. Por lo tanto, este método devuelve un sondeo que le permite esperar a que se complete la eliminación.

az keyvault secret delete [--id]
                          [--name]
                          [--vault-name]

Parámetros opcionales

--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

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 secret download

Editar

Descargue un secreto de KeyVault.

az keyvault secret download --file
                            [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                            [--id]
                            [--name]
                            [--vault-name]
                            [--version]

Parámetros requeridos

--file -f

Archivo para recibir el contenido del secreto.

Parámetros opcionales

--encoding -e

Codificación del secreto. De forma predeterminada, buscará la etiqueta "file-encoding" en el secreto. De lo contrario, se presupone "utf-8".

valores aceptados: ascii, base64, hex, utf-16be, utf-16le, utf-8
--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

--version -v

Versión secreta. Si se omite, usa la versión más reciente.

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

Editar

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

La operación Obtener secretos es aplicable a todo el almacén. Sin embargo, solo se proporciona el identificador del secreto base y sus atributos en la respuesta. Las versiones secretas individuales no aparecen en la respuesta. Esta operación requiere el permiso secrets/list.

az keyvault secret list [--id]
                        [--include-managed {false, true}]
                        [--maxresults]
                        [--vault-name]

Parámetros opcionales

--id

URI completo del almacén. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--include-managed

Incluir secretos administrados. Valor predeterminado: false.

valores aceptados: false, true
valor predeterminado: False
--maxresults

Número máximo de resultados que se van a devolver en una página. Si no se especifica, el servicio devolverá hasta 25 resultados.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

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

Editar

Enumera los secretos eliminados del almacén especificado.

La operación Obtener secretos eliminados devuelve los secretos que se han eliminado para un almacén habilitado para la eliminación temporal. Esta operación requiere el permiso secrets/list.

az keyvault secret list-deleted [--id]
                                [--maxresults]
                                [--vault-name]

Parámetros opcionales

--id

URI completo del almacén. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--maxresults

Número máximo de resultados que se van a devolver en una página. Si no se especifica, el servicio devolverá hasta 25 resultados.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

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 secret list-versions

Editar

Enumera todas las versiones del secreto especificado.

El identificador y los atributos de secreto completos se proporcionan en la respuesta. No se devuelven valores para los secretos. Esta operación requiere el permiso secrets/list.

az keyvault secret list-versions [--id]
                                 [--maxresults]
                                 [--name]
                                 [--vault-name]

Parámetros opcionales

--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--maxresults

Número máximo de resultados que se van a devolver en una página. Si no se especifica, el servicio devolverá hasta 25 resultados.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

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

Editar

Elimina permanentemente el secreto especificado.

La operación de purga del secreto eliminado quita el secreto de forma permanente, sin la posibilidad de recuperación. Esta operación solo se puede habilitar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso secrets/purge.

az keyvault secret purge [--id]
                         [--name]
                         [--vault-name]

Parámetros opcionales

--id

Identificador de recuperación del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén. Obligatorio si no se especifica --id.

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

Editar

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

Recupera el secreto eliminado en el almacén especificado. Esta operación solo se puede realizar en un almacén habilitado para eliminación temporal. Esta operación requiere el permiso secrets/recover.

az keyvault secret recover [--id]
                           [--name]
                           [--vault-name]

Parámetros opcionales

--id

Identificador de recuperación del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén. Obligatorio si no se especifica --id.

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 secret restore

Editar

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

Restaura un secreto de copia de seguridad y todas sus versiones en un almacén. Esta operación requiere el permiso secretos o restauración.

az keyvault secret restore --file
                           --vault-name

Parámetros requeridos

--file -f

Archivo para recibir el contenido del secreto.

--vault-name

Nombre del almacén.

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 secret set

Editar

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

az keyvault secret set --name
                       --vault-name
                       [--content-type]
                       [--disabled {false, true}]
                       [--encoding {ascii, base64, hex, utf-16be, utf-16le, utf-8}]
                       [--expires]
                       [--file]
                       [--not-before]
                       [--tags]
                       [--value]

Ejemplos

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

az keyvault secret set --name MySecretName --vault-name MyKeyVault --value MyVault

Cree un secreto (si no existe) o actualice un secreto en keyVault a través de un archivo.

az keyvault secret set --name MySecretName --vault-name MyKeyVault --file /path/to/file --encoding MyEncoding

Parámetros requeridos

--name -n

Nombre del secreto.

--vault-name

Nombre del almacén.

Parámetros opcionales

--content-type --description

Descripción del contenido del secreto (por ejemplo, contraseña, cadena de conexión, etc.).

--disabled

Cree un secreto en estado deshabilitado.

valores aceptados: false, true
--encoding -e

Codificación de archivos de origen. El valor se guarda como una etiqueta (file-encoding=<val>) y se usa durante la descarga para codificar automáticamente el archivo resultante.

valores aceptados: ascii, base64, hex, utf-16be, utf-16le, utf-8
valor predeterminado: utf-8
--expires

Fecha y hora UTC de expiración (Y-m-d'T'H:M:S'Z').

--file -f

Archivo de origen para secreto. Use junto con "--encoding".

--not-before

Secreto no utilizable antes de la fecha y hora UTC proporcionada (Y-m-d'T'H:M:S'Z').

--tags

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

--value

Valor secreto de texto sin formato. No se puede usar con '--file' o '--encoding'.

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 secret set-attributes

Editar

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

La operación UPDATE cambia los atributos especificados de un secreto almacenado existente. Los atributos que no se especifican en la solicitud se dejan sin cambios. No se puede cambiar el valor de un secreto. Esta operación requiere el permiso secrets/set.

az keyvault secret set-attributes [--content-type]
                                  [--enabled {false, true}]
                                  [--expires]
                                  [--id]
                                  [--name]
                                  [--not-before]
                                  [--tags]
                                  [--vault-name]
                                  [--version]

Parámetros opcionales

--content-type

Tipo del valor secreto, como una contraseña.

--enabled

Habilite el secreto.

valores aceptados: false, true
--expires

Fecha y hora UTC de expiración (Y-m-d'T'H:M:S'Z').

--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--not-before

Secreto no utilizable antes de la fecha y hora UTC proporcionada (Y-m-d'T'H:M:S'Z').

--tags

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

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

--version -v

Versión secreta. Si se omite, usa la versión más reciente.

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

Editar

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

La operación GET es aplicable a cualquier secreto almacenado en Azure Key Vault. Esta operación requiere el permiso secrets/get.

az keyvault secret show [--id]
                        [--name]
                        [--vault-name]
                        [--version]

Parámetros opcionales

--id

Identificador del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén de claves. Obligatorio si no se especifica --id.

--version -v

Versión secreta. Si se omite, usa la versión más reciente.

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

Editar

Obtiene el secreto eliminado especificado.

La operación Obtener secreto eliminado devuelve el secreto eliminado especificado junto con sus atributos. Esta operación requiere el permiso secrets/get.

az keyvault secret show-deleted [--id]
                                [--name]
                                [--vault-name]

Parámetros opcionales

--id

Identificador de recuperación del secreto. Si se especifican todos los demás argumentos 'Id' se deben omitir.

--name -n

Nombre del secreto. Obligatorio si no se especifica --id.

--vault-name

Nombre del almacén. Obligatorio si no se especifica --id.

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.