Get Secrets - Get Secrets

Servicio:: Key Vault

Versión de la API:: 7.4

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.

GET {vaultBaseUrl}/secrets?api-version=7.4

Con parámetros opcionales:

GET {vaultBaseUrl}/secrets?maxresults={maxresults}&api-version=7.4

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
vaultBaseUrl	path	True	string	El nombre del almacén, por ejemplo, `https://myvault.vault.azure.net`.
api-version	query	True	string	Versión de la API de cliente.
maxresults	query		integer (int32) minimum: 1 maximum: 25	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.

Respuestas

Nombre	Tipo	Description
200 OK	SecretListResult	Mensaje de respuesta que contiene una lista de secretos en el almacén junto con un vínculo a la página siguiente de secretos.
Other Status Codes	KeyVaultError	Respuesta de error de Key Vault que describe por qué se produjo un error en la operación.

Ejemplos

GetSecrets

Solicitud de ejemplo

HTTP

GET https://myvault.vault.azure.net//secrets?maxresults=1&api-version=7.4

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "contentType": "plainText",
      "id": "https://myvault.vault.azure.net/secrets/listsecrettest0",
      "attributes": {
        "enabled": true,
        "created": 1482189047,
        "updated": 1482189047
      }
    }
  ],
  "nextLink": "https://myvault.vault.azure.net:443/secrets?api-version=7.2&$skiptoken=eyJOZXh0TWFya2VyIjoiMiE4OCFNREF3TURJeUlYTmxZM0psZEM5TVNWTlVVMFZEVWtWVVZFVlRWREVoTURBd01ESTRJVEl3TVRZdE1USXRNVGxVTWpNNk1UQTZORFV1T0RneE9ERXhNRm9oIiwiVGFyZ2V0TG9jYXRpb24iOjB9&maxresults=1"
}

Definiciones

Nombre	Description
DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; De lo contrario, solo el sistema puede purgar el secreto, al final del intervalo de retención.
Error	Error del servidor del almacén de claves.
KeyVaultError	Excepción de error del almacén de claves.
SecretAttributes	Atributos de administración de secretos.
SecretItem	Elemento secreto que contiene metadatos secretos.
SecretListResult	Resultado de la lista de secretos.

DeletionRecoveryLevel

Enumeración

Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; De lo contrario, solo el sistema puede purgar el secreto, al final del intervalo de retención.

Valor	Description
CustomizedRecoverable	Denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y mientras la suscripción sigue estando disponible.
CustomizedRecoverable+ProtectedSubscription	Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, la purga) no está permitida y en la que la propia suscripción no se puede cancelar permanentemente cuando 7<= SoftDeleteRetentionInDays < 90. Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención y también refleja el hecho de que no se puede cancelar la propia suscripción.
CustomizedRecoverable+Purgeable	Denota un estado de almacén en el que se puede recuperar la eliminación y, además, permite la eliminación inmediata y permanente (es decir, purga cuando 7<= SoftDeleteRetentionInDays < 90). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención, a menos que se solicite una operación de purga o se cancele la suscripción.
Purgeable	Indica un estado de almacén en el que la eliminación es una operación irreversible, sin la posibilidad de recuperación. Este nivel no corresponde a ninguna protección disponible en una operación de eliminación; los datos se pierden irrecuperablemente al aceptar una operación De eliminación en el nivel de entidad o superior (almacén, grupo de recursos, suscripción, etc.).
Recoverable	Denota un estado de almacén en el que la eliminación se puede recuperar sin la posibilidad de eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días) y mientras la suscripción sigue estando disponible. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+ProtectedSubscription	Indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar dentro del intervalo de retención (90 días), no se permite la eliminación inmediata y permanente (es decir, purga) y en la que la propia suscripción no se puede cancelar permanentemente. El sistema lo eliminará permanentemente después de 90 días, si no se recupera
Recoverable+Purgeable	Indica un estado de almacén en el que se puede recuperar la eliminación y que también permite la eliminación inmediata y permanente (es decir, purga). Este nivel garantiza la capacidad de recuperación de la entidad eliminada durante el intervalo de retención (90 días), a menos que se solicite una operación de purga o se cancele la suscripción. El sistema lo eliminará permanentemente después de 90 días, si no se recupera

Error

Object

Error del servidor del almacén de claves.

Nombre	Tipo	Description
code	string	Código de error.
innererror	Error	Error del servidor del almacén de claves.
message	string	Mensaje de error.

KeyVaultError

Object

Excepción de error del almacén de claves.

Nombre	Tipo	Description
error	Error	Error del servidor del almacén de claves.

SecretAttributes

Object

Atributos de administración de secretos.

Nombre	Tipo	Description
created	integer (unixtime)	Hora de creación en UTC.
enabled	boolean	Determina si el objeto está habilitado.
exp	integer (unixtime)	Fecha de expiración en UTC.
nbf	integer (unixtime)	No antes de la fecha en UTC.
recoverableDays	integer (int32)	días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete esté habilitado; de lo contrario, 0.
recoveryLevel	DeletionRecoveryLevel	Refleja el nivel de recuperación de eliminación actualmente en vigor para los secretos del almacén actual. Si contiene "Purgable", un usuario con privilegios puede eliminar permanentemente el secreto; De lo contrario, solo el sistema puede purgar el secreto, al final del intervalo de retención.
updated	integer (unixtime)	Hora actualizada por última vez en UTC.

SecretItem

Object

Elemento secreto que contiene metadatos secretos.

Nombre	Tipo	Description
attributes	SecretAttributes	Atributos de administración de secretos.
contentType	string	Tipo del valor secreto, como una contraseña.
id	string	Identificador secreto.
managed	boolean	True si el almacén de claves administra la duración del secreto. Si se trata de una clave que respalda un certificado, la administración será true.
tags	object	Metadatos específicos de la aplicación en forma de pares clave-valor.

SecretListResult

Object

Resultado de la lista de secretos.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de secretos.
value	SecretItem[]	Mensaje de respuesta que contiene una lista de secretos en el almacén de claves junto con un vínculo a la página siguiente de secretos.

Compartir a través de

Get Secrets - Get Secrets

Parámetros de identificador URI

Respuestas

Ejemplos

GetSecrets

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DeletionRecoveryLevel

Error

KeyVaultError

SecretAttributes

SecretItem

SecretListResult