SecretClient class
SecretClient fournit des méthodes pour gérer KeyVaultSecret dans Azure Key Vault. Le client prend en charge la création, la récupération, la mise à jour, la suppression, la purge, la sauvegarde, la restauration et la description de KeyVaultSecrets. Le client prend également en charge la description DeletedSecret pour une suppression réversible d’Azure Key Vault.
Constructeurs
Secret |
Crée une instance de SecretClient. Exemple d’utilisation :
|
Propriétés
vault |
URL de base du coffre |
Méthodes
backup |
Demande qu’une sauvegarde du secret spécifié soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/sauvegarde. Exemple d’utilisation :
Sauvegarde le secret spécifié. |
begin |
Supprime un secret stocké dans Azure Key Vault. Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit supprimé. Cette opération nécessite l’autorisation secrets/suppression. Exemple d’utilisation :
Supprime un secret d’un coffre de clés spécifié. |
begin |
Récupère le secret supprimé dans le coffre spécifié. Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit récupéré. Cette opération nécessite l’autorisation secrets/récupération. Exemple d’utilisation :
Récupère le secret supprimé vers la dernière version. |
get |
La méthode getDeletedSecret retourne le secret supprimé spécifié, ainsi que ses attributs. Cette opération nécessite l’autorisation secrets/obtenir. Exemple d’utilisation :
Obtient le secret supprimé spécifié. |
get |
La méthode getSecret s’applique à tout secret stocké dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir. Exemple d’utilisation :
Obtenez un secret spécifié à partir d’un coffre de clés donné. |
list |
Itère les secrets supprimés dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste. Exemple d’utilisation :
Répertoriez tous les secrets dans le coffre. |
list |
Itère la dernière version de tous les secrets dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste. Exemple d’utilisation :
Répertoriez tous les secrets dans le coffre. |
list |
Itère toutes les versions du secret donné dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste. Exemple d’utilisation :
|
purge |
L’opération de suppression du secret supprimé supprime définitivement le secret, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé par suppression réversible. Cette opération nécessite l’autorisation secrets/purge. Exemple d’utilisation :
Supprime définitivement le secret spécifié. |
restore |
Restaure un secret sauvegardé, et toutes ses versions, dans un coffre. Cette opération nécessite l’autorisation secrets/restauration. Exemple d’utilisation :
Restaure un secret sauvegardé dans un coffre. |
set |
La méthode setSecret ajoute une version secrète ou secrète à Azure Key Vault. Si le secret nommé existe déjà, Azure Key Vault crée une nouvelle version de ce secret. Cette opération nécessite l’autorisation secrets/set. Exemple d’utilisation :
Ajoute un secret dans un coffre de clés spécifié. |
update |
La méthode updateSecret modifie les attributs spécifiés d’un secret stocké existant. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’un secret lui-même ne peut pas être modifiée. Cette opération nécessite l’autorisation secrets/set. Exemple d’utilisation :
Met à jour les attributs associés à un secret spécifié dans un coffre de clés donné. |
Détails du constructeur
SecretClient(string, TokenCredential, SecretClientOptions)
Crée une instance de SecretClient.
Exemple d’utilisation :
import { SecretClient } from "@azure/keyvault-secrets";
import { DefaultAzureCredential } from "@azure/identity";
let vaultUrl = `https://<MY KEYVAULT HERE>.vault.azure.net`;
let credentials = new DefaultAzureCredential();
let client = new SecretClient(vaultUrl, credentials);
new SecretClient(vaultUrl: string, credential: TokenCredential, pipelineOptions?: SecretClientOptions)
Paramètres
- vaultUrl
-
string
URL de base du coffre. Vous devez vérifier que cette URL fait référence à une ressource Key Vault valide. Pour plus d’informations, consultez https://aka.ms/azsdk/blog/vault-uri.
- credential
- TokenCredential
Objet qui implémente l’interface TokenCredential
utilisée pour authentifier les demandes auprès du service. Utilisez le package @azure/identity pour créer des informations d’identification qui correspondent à vos besoins.
- pipelineOptions
- SecretClientOptions
Options de pipeline utilisées pour configurer les demandes d’API Key Vault. Omettez ce paramètre pour utiliser la configuration du pipeline par défaut.
Détails de la propriété
vaultUrl
URL de base du coffre
vaultUrl: string
Valeur de propriété
string
Détails de la méthode
backupSecret(string, BackupSecretOptions)
Demande qu’une sauvegarde du secret spécifié soit téléchargée sur le client. Toutes les versions du secret seront téléchargées. Cette opération nécessite l’autorisation secrets/sauvegarde.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
let backupResult = await client.backupSecret("MySecretName");
Sauvegarde le secret spécifié.
function backupSecret(secretName: string, options?: BackupSecretOptions): Promise<undefined | Uint8Array>
Paramètres
- secretName
-
string
Nom du secret.
- options
- BackupSecretOptions
Paramètres facultatifs.
Retours
Promise<undefined | Uint8Array>
beginDeleteSecret(string, BeginDeleteSecretOptions)
Supprime un secret stocké dans Azure Key Vault. Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit supprimé.
Cette opération nécessite l’autorisation secrets/suppression.
Exemple d’utilisation :
const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");
const deletePoller = await client.beginDeleteSecret("MySecretName");
// Serializing the poller
const serialized = deletePoller.toString();
// A new poller can be created with:
// const newPoller = await client.beginDeleteSecret("MySecretName", { resumeFrom: serialized });
// Waiting until it's done
const deletedSecret = await deletePoller.pollUntilDone();
console.log(deletedSecret);
Supprime un secret d’un coffre de clés spécifié.
function beginDeleteSecret(name: string, options?: BeginDeleteSecretOptions): Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>
Paramètres
- name
-
string
- options
- BeginDeleteSecretOptions
Paramètres facultatifs.
Retours
Promise<PollerLike<PollOperationState<DeletedSecret>, DeletedSecret>>
beginRecoverDeletedSecret(string, BeginRecoverDeletedSecretOptions)
Récupère le secret supprimé dans le coffre spécifié. Cette fonction retourne un polleur d’opération longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que le secret soit récupéré.
Cette opération nécessite l’autorisation secrets/récupération.
Exemple d’utilisation :
const client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
const recoverPoller = await client.beginRecoverDeletedSecret("MySecretName");
// Serializing the poller
const serialized = recoverPoller.toString();
// A new poller can be created with:
// const newPoller = await client.beginRecoverDeletedSecret("MySecretName", { resumeFrom: serialized });
// Waiting until it's done
const deletedSecret = await recoverPoller.pollUntilDone();
console.log(deletedSecret);
Récupère le secret supprimé vers la dernière version.
function beginRecoverDeletedSecret(name: string, options?: BeginRecoverDeletedSecretOptions): Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>
Paramètres
- name
-
string
- options
- BeginRecoverDeletedSecretOptions
Paramètres facultatifs.
Retours
Promise<PollerLike<PollOperationState<SecretProperties>, SecretProperties>>
getDeletedSecret(string, GetDeletedSecretOptions)
La méthode getDeletedSecret retourne le secret supprimé spécifié, ainsi que ses attributs. Cette opération nécessite l’autorisation secrets/obtenir.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
await client.getDeletedSecret("MyDeletedSecret");
Obtient le secret supprimé spécifié.
function getDeletedSecret(secretName: string, options?: GetDeletedSecretOptions): Promise<DeletedSecret>
Paramètres
- secretName
-
string
Nom du secret.
- options
- GetDeletedSecretOptions
Paramètres facultatifs.
Retours
Promise<DeletedSecret>
getSecret(string, GetSecretOptions)
La méthode getSecret s’applique à tout secret stocké dans Azure Key Vault. Cette opération nécessite l’autorisation secrets/obtenir.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
let secret = await client.getSecret("MySecretName");
Obtenez un secret spécifié à partir d’un coffre de clés donné.
function getSecret(secretName: string, options?: GetSecretOptions): Promise<KeyVaultSecret>
Paramètres
- secretName
-
string
Nom du secret.
- options
- GetSecretOptions
Paramètres facultatifs.
Retours
Promise<KeyVaultSecret>
listDeletedSecrets(ListDeletedSecretsOptions)
Itère les secrets supprimés dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
for await (const deletedSecret of client.listDeletedSecrets()) {
console.log("deleted secret: ", deletedSecret);
}
Répertoriez tous les secrets dans le coffre.
function listDeletedSecrets(options?: ListDeletedSecretsOptions): PagedAsyncIterableIterator<DeletedSecret, DeletedSecret[], PageSettings>
Paramètres
- options
- ListDeletedSecretsOptions
Paramètres facultatifs.
Retours
listPropertiesOfSecrets(ListPropertiesOfSecretsOptions)
Itère la dernière version de tous les secrets dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecrets()) {
const secret = await client.getSecret(secretProperties.name);
console.log("secret: ", secret);
}
Répertoriez tous les secrets dans le coffre.
function listPropertiesOfSecrets(options?: ListPropertiesOfSecretsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>
Paramètres
- options
- ListPropertiesOfSecretsOptions
Paramètres facultatifs.
Retours
listPropertiesOfSecretVersions(string, ListPropertiesOfSecretVersionsOptions)
Itère toutes les versions du secret donné dans le coffre. L’identificateur de secret complet et les attributs sont fournis dans la réponse. Aucune valeur n’est retournée pour les secrets. Ces opérations nécessitent l’autorisation secrets/liste.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
for await (const secretProperties of client.listPropertiesOfSecretVersions("MySecretName")) {
const secret = await client.getSecret(secretProperties.name);
console.log("secret version: ", secret);
}
function listPropertiesOfSecretVersions(secretName: string, options?: ListPropertiesOfSecretVersionsOptions): PagedAsyncIterableIterator<SecretProperties, SecretProperties[], PageSettings>
Paramètres
- secretName
-
string
Nom du secret pour lequel récupérer des versions.
Paramètres facultatifs.
Retours
purgeDeletedSecret(string, PurgeDeletedSecretOptions)
L’opération de suppression du secret supprimé supprime définitivement le secret, sans possibilité de récupération. Cette opération ne peut être activée que sur un coffre activé par suppression réversible. Cette opération nécessite l’autorisation secrets/purge.
Exemple d’utilisation :
const client = new SecretClient(url, credentials);
const deletePoller = await client.beginDeleteSecret("MySecretName");
await deletePoller.pollUntilDone();
await client.purgeDeletedSecret("MySecretName");
Supprime définitivement le secret spécifié.
function purgeDeletedSecret(secretName: string, options?: PurgeDeletedSecretOptions): Promise<void>
Paramètres
- secretName
-
string
Nom du secret.
- options
- PurgeDeletedSecretOptions
Paramètres facultatifs.
Retours
Promise<void>
restoreSecretBackup(Uint8Array, RestoreSecretBackupOptions)
Restaure un secret sauvegardé, et toutes ses versions, dans un coffre. Cette opération nécessite l’autorisation secrets/restauration.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
let mySecretBundle = await client.backupSecret("MySecretName");
// ...
await client.restoreSecretBackup(mySecretBundle);
Restaure un secret sauvegardé dans un coffre.
function restoreSecretBackup(secretBundleBackup: Uint8Array, options?: RestoreSecretBackupOptions): Promise<SecretProperties>
Paramètres
- secretBundleBackup
-
Uint8Array
Objet blob de sauvegarde associé à un ensemble de secrets.
- options
- RestoreSecretBackupOptions
Paramètres facultatifs.
Retours
Promise<SecretProperties>
setSecret(string, string, SetSecretOptions)
La méthode setSecret ajoute une version secrète ou secrète à Azure Key Vault. Si le secret nommé existe déjà, Azure Key Vault crée une nouvelle version de ce secret. Cette opération nécessite l’autorisation secrets/set.
Exemple d’utilisation :
let client = new SecretClient(url, credentials);
await client.setSecret("MySecretName", "ABC123");
Ajoute un secret dans un coffre de clés spécifié.
function setSecret(secretName: string, value: string, options?: SetSecretOptions): Promise<KeyVaultSecret>
Paramètres
- secretName
-
string
Nom du secret.
- value
-
string
Valeur du secret.
- options
- SetSecretOptions
Paramètres facultatifs.
Retours
Promise<KeyVaultSecret>
updateSecretProperties(string, string, UpdateSecretPropertiesOptions)
La méthode updateSecret modifie les attributs spécifiés d’un secret stocké existant. Les propriétés qui ne sont pas spécifiées dans la requête restent inchangées. La valeur d’un secret lui-même ne peut pas être modifiée. Cette opération nécessite l’autorisation secrets/set.
Exemple d’utilisation :
let secretName = "MySecretName";
let client = new SecretClient(url, credentials);
let secret = await client.getSecret(secretName);
await client.updateSecretProperties(secretName, secret.properties.version, { enabled: false });
Met à jour les attributs associés à un secret spécifié dans un coffre de clés donné.
function updateSecretProperties(secretName: string, secretVersion: string, options?: UpdateSecretPropertiesOptions): Promise<SecretProperties>
Paramètres
- secretName
-
string
Nom du secret.
- secretVersion
-
string
Version du secret.
- options
- UpdateSecretPropertiesOptions
Paramètres facultatifs.
Retours
Promise<SecretProperties>