@azure/keyvault-secrets package

SecretClient proporciona métodos para administrar keyVaultSecret en Azure Key Vault. El cliente admite la creación, recuperación, actualización, eliminación, purgado, copia de seguridad, restauración y enumeración de KeyVaultSecrets. El cliente también admite la enumeración de DeletedSecret para una instancia de Azure Key Vault habilitada para eliminación temporal.

Opciones de <xref:backupSecretOptions>.

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteSecret(string, BeginDeleteSecretOptions)

Interfaz que representa los parámetros opcionales que se pueden pasar a beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)

Interfaz que representa un secreto de KeyVault eliminado.

Opciones de getDeletedSecret(string, GetDeletedSecretOptions).

Opciones de getSecret(string, GetSecretOptions).

Interfaz que representa un secreto de KeyVault, con su nombre, valor y SecretProperties.

Representa los segmentos que componen un identificador de secreto de Key Vault.

Opciones de listDeletedSecrets(ListDeletedSecretsOptions).

Opciones de listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions).

Opciones de listPropertiesOfSecrets(ListPropertiesOfSecretsOptions).

Interfaz que realiza un seguimiento de la configuración de la iteración paginada

Interfaz que permite la iteración asincrónica tanto a la finalización como a la página.

PollOperationState contiene una lista con opiniones del conjunto más pequeño de propiedades necesarias para definir cualquier sondeo de operación de larga duración.

Aunque la clase Poller funciona como mecanismo de control local para iniciar el desencadenamiento, esperar y cancelar potencialmente una operación de larga duración, PollOperationState documenta el estado de la operación remota de larga duración.

Debe actualizarse al menos cuando se inicia la operación, cuando termine y cuando se cancele. Sin embargo, las implementaciones pueden tener cualquier otro número de propiedades que se puedan actualizar por otros motivos.

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.

Opciones de purgeDeletedSecret(string, PurgeDeletedSecretOptions).

Opciones de restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions).

Los parámetros opcionales aceptados por KeyVault KeyClient

Interfaz que representa los parámetros opcionales que se pueden pasar a beginDeleteSecret(string, BeginDeleteSecretOptions) y <xref:beginRecoverDeletedKey>.

Interfaz que representa las propiedades de un KeyVaultSecret.

Opciones de setSecret(string, string, SetSecretOptions).

Opciones de updateSecretProperties(string, string, UpdateSecretPropertiesOptions).

Define valores para DeletionRecoveryLevel.
KnownDeletionRecoveryLevel se puede usar indistintamente con DeletionRecoveryLevel, esta enumeración contiene los valores conocidos que admite el servicio.

Valores conocidos admitidos por el servicio

purgable: denota 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.).
recuperable+Purgable: denota 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
recuperables: 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
recuperable+ProtectedSubscription: indica un almacén y un estado de suscripción en el que la eliminación se puede recuperar en el 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
CustomdRecoverable+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, 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.
CustomdRecoverable: 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, 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: 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.

Valores conocidos de DeletionRecoveryLevel que acepta el servicio.

Analiza el identificador de secreto de Key Vault especificado. Un ejemplo es:

https://.vault.azure.net/secrets//

Al analizar el identificador anterior, esta función devuelve:

  {
     sourceId: "https://<keyvault-name>.vault.azure.net/secrets/<secret-name>/<unique-version-id>",
     vaultUrl: "https://<keyvault-name>.vault.azure.net",
     version: "<unique-version-id>",
     name: "<secret-name>"
  }