Get Secret - Get Secret
Obtenga un secreto especificado de un almacén de claves determinado.
La operación GET es aplicable a cualquier secreto almacenado en el Almacén de claves de Azure. Esta operación requiere el permiso secrets/get.
GET {vaultBaseUrl}/secrets/{secret-name}/{secret-version}?api-version=7.4
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
secret-name
|
path | True |
string |
Nombre del secreto. |
secret-version
|
path | True |
string |
Versión del secreto. Este fragmento de URI es opcional. Si no se especifica, se devuelve la versión más reciente del secreto. |
vault
|
path | True |
string |
El nombre del almacén, por ejemplo https://myvault.vault.azure.net, . |
api-version
|
query | True |
string |
Versión de API del cliente. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Secreto recuperado. |
|
Other Status Codes |
Key Vault respuesta de error que describe por qué se produjo un error en la operación. |
Ejemplos
GetSecret
Sample Request
GET https://myvault.vault.azure.net//secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79?api-version=7.4
Sample Response
{
"value": "mysecretvalue",
"id": "https://myvault.vault.azure.net/secrets/mysecretname/4387e9f3d6e14c459867679a90fd0f79",
"attributes": {
"enabled": true,
"created": 1493938410,
"updated": 1493938410,
"recoveryLevel": "Recoverable+Purgeable"
}
}
Definiciones
Nombre | Description |
---|---|
Deletion |
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. |
Key |
Excepción de error del almacén de claves. |
Secret |
Atributos de administración de secretos. |
Secret |
Un secreto que consta de un valor, un identificador y sus atributos. |
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.
Nombre | Tipo | Description |
---|---|---|
CustomizedRecoverable |
string |
Indica 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, purgar 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 |
string |
Indica un almacén y un estado de suscripción en el que la eliminación es recuperable, inmediata y permanente (es decir, 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 |
string |
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, purgar 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 |
string |
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 |
string |
Indica 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, purgar). 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 |
string |
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 |
string |
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, purgar). 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
Error del servidor del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
code |
string |
Código de error. |
innererror |
Error del servidor del almacén de claves. |
|
message |
string |
El mensaje de error. |
KeyVaultError
Excepción de error del almacén de claves.
Nombre | Tipo | Description |
---|---|---|
error |
Error del servidor del almacén de claves. |
SecretAttributes
Atributos de administración de secretos.
Nombre | Tipo | Description |
---|---|---|
created |
integer |
Hora de creación en UTC. |
enabled |
boolean |
Determina si el objeto está habilitado. |
exp |
integer |
Fecha de expiración en UTC. |
nbf |
integer |
No antes de la fecha en UTC. |
recoverableDays |
integer |
días de retención de datos softDelete. El valor debe ser >=7 y <=90 cuando softDelete está habilitado; en caso contrario, es 0. |
recoveryLevel |
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 |
Hora de la última actualización en UTC. |
SecretBundle
Un secreto que consta de un valor, un identificador y sus atributos.
Nombre | Tipo | Description |
---|---|---|
attributes |
Atributos de administración de secretos. |
|
contentType |
string |
Tipo de contenido del secreto. |
id |
string |
Identificador del secreto. |
kid |
string |
Si se trata de un secreto que respalda un certificado KV, este campo especifica la clave correspondiente que respalda el certificado KV. |
managed |
boolean |
True si el almacén de claves administra la duración del secreto. Si se trata de un secreto que respalda un certificado, se administrará como true. |
tags |
object |
Metadatos específicos de la aplicación en forma de pares clave-valor. |
value |
string |
Valor del secreto. |