KeyClient Classe

Interface de haut niveau pour la gestion des clés d’un coffre.

Héritage

azure.keyvault.keys._shared.client_base.KeyVaultClientBase

KeyClient

Constructeur

KeyClient(vault_url: str, credential: TokenCredential, **kwargs)

Paramètres

vault_url

str

Obligatoire

URL du coffre accessible par le client. Il s’agit également du « nom DNS » du coffre. Vous devez vérifier que cette URL fait référence à une ressource Key Vault ou HSM managée valide. Pour plus d'informations, consultez https://aka.ms/azsdk/blog/vault-uri.

credential

TokenCredential

Obligatoire

Objet qui peut fournir un jeton d’accès pour le coffre, par exemple des informations d’identification provenant de identity

api_version

ApiVersion

Version de l’API de service à utiliser. La valeur par défaut est la plus récente.

verify_challenge_resource

bool

Vérifiez si la ressource de défi d’authentification correspond au Key Vault ou au domaine HSM managé. La valeur par défaut est True.

Méthodes

backup_key	Sauvegardez une clé dans un formulaire protégé utilisable uniquement par Azure Key Vault. Nécessite des clés/une autorisation de sauvegarde. Cela est destiné à permettre la copie d’une clé d’un coffre vers un autre. Les deux coffres doivent appartenir au même abonnement Azure. En outre, la sauvegarde/restauration ne peut pas être effectuée au-delà des limites géopolitiques. Par exemple, une sauvegarde à partir d’un coffre dans une région USA ne peut pas être restaurée dans un coffre dans une région de l’UE.
begin_delete_key	Supprimez toutes les versions d’une clé et de son matériel de chiffrement. Nécessite l’autorisation clés/suppression. Lorsque cette méthode retourne Key Vault a commencé à supprimer la clé. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.
begin_recover_deleted_key	Récupérer une clé supprimée dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite l’autorisation clés/récupérer. Lorsque cette méthode retourne Key Vault a commencé à récupérer la clé. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement la clé récupérée dans une autre opération.
close	Fermez les sockets ouverts par le client. L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.
create_ec_key	Créez une nouvelle clé de courbe elliptique ou, si name elle est déjà utilisée, créez une nouvelle version de la clé. requiert l'autorisation keys/create.
create_key	Créez une clé ou, si name elle est déjà utilisée, créez une nouvelle version de la clé. Nécessite l’autorisation clés/création.
create_oct_key	Créez une nouvelle clé de séquence d’octets (symétrique) ou, si name elle est utilisée, créez une nouvelle version de la clé. requiert l'autorisation keys/create.
create_rsa_key	Créer une clé RSA ou, si name elle est déjà utilisée, créer une nouvelle version de la clé requiert l'autorisation keys/create.
get_cryptography_client	Obtient un CryptographyClient pour la clé donnée.
get_deleted_key	Obtenir une clé supprimée. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite des clés/obtenir l’autorisation.
get_key	Obtenez les attributs d’une clé et, s’il s’agit d’une clé asymétrique, son matériel public. Nécessite des clés/obtenir l’autorisation.
get_key_rotation_policy	Obtenez la stratégie de rotation d’une clé Key Vault.
get_random_bytes	Obtenez le nombre d’octets aléatoires demandés à partir d’un HSM managé.
import_key	Importez une clé créée en externe. Nécessite des clés/une autorisation d’importation. Si name elle est déjà utilisée, la clé est importée en tant que nouvelle version.
list_deleted_keys	Répertoriez toutes les clés supprimées, y compris la partie publique de chacune d’elles. Possible uniquement dans un coffre avec la suppression réversible activée. Nécessite l’autorisation clés/liste.
list_properties_of_key_versions	Répertoriez les identificateurs et les propriétés des versions d’une clé. Nécessite l’autorisation clés/liste.
list_properties_of_keys	Répertoriez les identificateurs et les propriétés de toutes les clés du coffre. Nécessite l’autorisation clés/liste.
purge_deleted_key	Supprime définitivement une clé supprimée. Possible uniquement dans un coffre avec la suppression réversible activée. Effectue une suppression irréversible de la clé spécifiée, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger une clé avant son scheduled_purge_date. Nécessite l’autorisation clés/purge.
release_key	Libère une clé. L’opération de clé de mise en production s’applique à tous les types de clés. La clé cible doit être marquée comme exportable. Cette opération nécessite l’autorisation clés/mise en production.
restore_key_backup	Restaurez une sauvegarde de clé dans le coffre. Nécessite l’autorisation clés/restauration. Cette opération importe toutes les versions de la clé, avec son nom, ses attributs et ses stratégies de contrôle d’accès. Si le nom de la clé est déjà utilisé, sa restauration échoue. En outre, le coffre cible doit appartenir au même abonnement Microsoft Azure que le coffre source.
rotate_key	Faites pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé. Cette opération nécessite l’autorisation clés/rotation.
send_request	Exécute une requête réseau à l’aide du pipeline existant du client. L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.
update_key_properties	Modifier les propriétés d’une clé (et non son matériel de chiffrement). Nécessite des clés/une autorisation de mise à jour.
update_key_rotation_policy	Mises à jour la stratégie de rotation d’une clé Key Vault. Cette opération nécessite l’autorisation clés/mise à jour.

backup_key

Sauvegardez une clé dans un formulaire protégé utilisable uniquement par Azure Key Vault.

Nécessite des clés/une autorisation de sauvegarde.

Cela est destiné à permettre la copie d’une clé d’un coffre vers un autre. Les deux coffres doivent appartenir au même abonnement Azure. En outre, la sauvegarde/restauration ne peut pas être effectuée au-delà des limites géopolitiques. Par exemple, une sauvegarde à partir d’un coffre dans une région USA ne peut pas être restaurée dans un coffre dans une région de l’UE.

backup_key(name: str, **kwargs) -> bytes

Paramètres

name

str

Obligatoire

Nom de la clé à sauvegarder

Type de retour

bytes

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_delete_key

Supprimez toutes les versions d’une clé et de son matériel de chiffrement.

Nécessite l’autorisation clés/suppression. Lorsque cette méthode retourne Key Vault a commencé à supprimer la clé. La suppression peut prendre plusieurs secondes dans un coffre avec la suppression réversible activée. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la suppression.

begin_delete_key(name: str, **kwargs) -> LROPoller[DeletedKey]

Paramètres

name

str

Obligatoire

Nom de la clé à supprimer.

Retours

Polleur pour l’opération de suppression de clé. La méthode de résultat de l’polleur retourne le DeletedKey sans attendre la fin de la suppression. Si la suppression réversible est activée dans le coffre et que vous souhaitez supprimer définitivement la clé avec purge_deleted_key, appelez d’abord la méthode d’attente de l’polleur. Il se bloque jusqu’à ce que la suppression soit terminée. La méthode wait nécessite l’autorisation keys/get.

Type de retour

LROPoller[DeletedKey]

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

begin_recover_deleted_key

Récupérer une clé supprimée dans sa dernière version. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite l’autorisation clés/récupérer.

Lorsque cette méthode retourne Key Vault a commencé à récupérer la clé. La récupération peut prendre plusieurs secondes. Cette méthode retourne donc un polleur vous permettant d’attendre la fin de la récupération. L’attente n’est nécessaire que lorsque vous souhaitez utiliser immédiatement la clé récupérée dans une autre opération.

begin_recover_deleted_key(name: str, **kwargs) -> LROPoller[KeyVaultKey]

Paramètres

name

str

Obligatoire

Nom de la clé supprimée à récupérer

Retours

Polleur pour l’opération de récupération. La méthode de résultat de l’polleur retourne le récupéré KeyVaultKey sans attendre la fin de la récupération. Si vous souhaitez utiliser la clé récupérée immédiatement, appelez la méthode d’attente de l’polleur, qui bloque jusqu’à ce que la clé soit prête à être utilisée. La méthode wait nécessite l’autorisation keys/get.

Type de retour

LROPoller[KeyVaultKey]

Exceptions

HttpResponseError

close

Fermez les sockets ouverts par le client.

L’appel de cette méthode n’est pas nécessaire lors de l’utilisation du client comme gestionnaire de contexte.

close() -> None

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

create_ec_key

Créez une nouvelle clé de courbe elliptique ou, si name elle est déjà utilisée, créez une nouvelle version de la clé.

requiert l'autorisation keys/create.

create_ec_key(name: str, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la nouvelle clé.

curve

KeyCurveName ou str ou None

Nom de la courbe elliptique. Par défaut, la courbe elliptique NIST P-256.

key_operations

list[KeyOperation ou str] ou None

Opérations de clé autorisées

hardware_protected

bool ou None

Indique si la clé doit être créée dans un module de sécurité matérielle. La valeur par défaut est False.

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

exportable

bool ou None

Indique si la clé privée peut être exportée.

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé créée

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

create_key

Créez une clé ou, si name elle est déjà utilisée, créez une nouvelle version de la clé.

Nécessite l’autorisation clés/création.

create_key(name: str, key_type: str | KeyType, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la nouvelle clé.

key_type

KeyType ou str

Obligatoire

Type de clé à créer

size

int ou None

Taille de clé en bits. S’applique uniquement aux clés RSA et symétriques. Envisagez d’utiliser create_rsa_key ou create_oct_key à la place.

curve

KeyCurveName ou str ou None

Nom de la courbe elliptique. S’applique uniquement aux touches de courbe elliptique. Par défaut, la courbe elliptique NIST P-256. Pour créer une clé de courbe elliptique, envisagez plutôt d’utiliser create_ec_key .

public_exponent

int ou None

Exposant public RSA à utiliser. S’applique uniquement aux clés RSA créées dans un HSM managé.

key_operations

list[KeyOperation ou str] ou None

Opérations de clé autorisées

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

exportable

bool ou None

Indique si la clé privée peut être exportée.

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé créée

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

create_oct_key

Créez une nouvelle clé de séquence d’octets (symétrique) ou, si name elle est utilisée, créez une nouvelle version de la clé.

requiert l'autorisation keys/create.

create_oct_key(name: str, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la nouvelle clé.

size

int ou None

Taille de clé en bits, par exemple 128, 192 ou 256.

key_operations

list[KeyOperation ou str] ou None

Opérations de clé autorisées.

hardware_protected

bool ou None

Indique si la clé doit être créée dans un module de sécurité matérielle. La valeur par défaut est False.

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

exportable

bool ou None

Indique si la clé peut être exportée.

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé créée

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

create_rsa_key

Créer une clé RSA ou, si name elle est déjà utilisée, créer une nouvelle version de la clé

requiert l'autorisation keys/create.

create_rsa_key(name: str, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la nouvelle clé.

size

int ou None

Taille de clé en bits, par exemple 2048, 3072 ou 4096.

public_exponent

int ou None

Exposant public RSA à utiliser. S’applique uniquement aux clés RSA créées dans un HSM managé.

hardware_protected

bool ou None

Indique si la clé doit être créée dans un module de sécurité matérielle. La valeur par défaut est False.

key_operations

list[KeyOperation ou str] ou None

Opérations de clé autorisées

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

exportable

bool ou None

Indique si la clé privée peut être exportée.

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé créée

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

get_cryptography_client

Obtient un CryptographyClient pour la clé donnée.

get_cryptography_client(key_name: str, **kwargs) -> CryptographyClient

Paramètres

key_name

str

Obligatoire

Nom de la clé utilisée pour effectuer des opérations de chiffrement.

key_version

str

Version facultative de la clé utilisée pour effectuer des opérations de chiffrement.

Retours

CryptographyClient utilisant les mêmes options, informations d’identification et client HTTP que ce KeyClient.

Type de retour

CryptographyClient

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

get_deleted_key

Obtenir une clé supprimée. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite des clés/obtenir l’autorisation.

get_deleted_key(name: str, **kwargs) -> DeletedKey

Paramètres

name

str

Obligatoire

Nom de la clé

Retours

Clé supprimée

Type de retour

DeletedKey

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

get_key

Obtenez les attributs d’une clé et, s’il s’agit d’une clé asymétrique, son matériel public.

Nécessite des clés/obtenir l’autorisation.

get_key(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la clé à obtenir.

version

str ou None

Obligatoire

(facultatif) Version spécifique de la clé à obtenir. Si elle n’est pas spécifiée, obtient la dernière version de la clé.

Type de retour

KeyVaultKey

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

get_key_rotation_policy

Obtenez la stratégie de rotation d’une clé Key Vault.

get_key_rotation_policy(key_name: str, **kwargs) -> KeyRotationPolicy

Paramètres

key_name

str

Obligatoire

Nom de la clé.

Retours

Stratégie de rotation des clés.

Type de retour

KeyRotationPolicy

Exceptions

*azure.core.exceptions.HttpResponseError*

get_random_bytes

Obtenez le nombre d’octets aléatoires demandés à partir d’un HSM managé.

get_random_bytes(count: int, **kwargs) -> bytes

Paramètres

count

int

Obligatoire

Nombre d’octets aléatoires demandés.

Retours

Octets aléatoires.

Type de retour

bytes

Exceptions

ValueError

si moins d’un octet aléatoire est demandé,

HttpResponseError

pour d’autres erreurs

import_key

Importez une clé créée en externe.

Nécessite des clés/une autorisation d’importation. Si name elle est déjà utilisée, la clé est importée en tant que nouvelle version.

import_key(name: str, key: JsonWebKey, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la clé importée

key

JsonWebKey

Obligatoire

Clé web JSON à importer

hardware_protected

bool ou None

Si la clé doit être sauvegardée par un module de sécurité matérielle

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

exportable

bool ou None

Indique si la clé privée peut être exportée.

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé importée

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

list_deleted_keys

Répertoriez toutes les clés supprimées, y compris la partie publique de chacune d’elles. Possible uniquement dans un coffre avec la suppression réversible activée.

Nécessite l’autorisation clés/liste.

list_deleted_keys(**kwargs) -> ItemPaged[DeletedKey]

Retours

Itérateur de clés supprimées

Type de retour

ItemPaged[DeletedKey]

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

list_properties_of_key_versions

Répertoriez les identificateurs et les propriétés des versions d’une clé.

Nécessite l’autorisation clés/liste.

list_properties_of_key_versions(name: str, **kwargs) -> ItemPaged[KeyProperties]

Paramètres

name

str

Obligatoire

Nom de la clé

Retours

Itérateur de clés sans leur matériel de chiffrement

Type de retour

ItemPaged[KeyProperties]

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

list_properties_of_keys

Répertoriez les identificateurs et les propriétés de toutes les clés du coffre.

Nécessite l’autorisation clés/liste.

list_properties_of_keys(**kwargs) -> ItemPaged[KeyProperties]

Retours

Itérateur de clés sans leur matériel de chiffrement ou leurs informations de version

Type de retour

ItemPaged[KeyProperties]

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

purge_deleted_key

Supprime définitivement une clé supprimée. Possible uniquement dans un coffre avec la suppression réversible activée.

Effectue une suppression irréversible de la clé spécifiée, sans possibilité de récupération. L’opération n’est pas disponible si le recovery_level ne spécifie pas « Purgeable ». Cette méthode n’est nécessaire que pour purger une clé avant son scheduled_purge_date.

Nécessite l’autorisation clés/purge.

purge_deleted_key(name: str, **kwargs) -> None

Paramètres

name

str

Obligatoire

Nom de la clé supprimée à purger

Retours

None

Exceptions

HttpResponseError

Exemples

   # if the vault has soft-delete enabled, purge permanently deletes a deleted key
   # (with soft-delete disabled, begin_delete_key is permanent)
   key_client.purge_deleted_key("key-name")

release_key

Libère une clé.

L’opération de clé de mise en production s’applique à tous les types de clés. La clé cible doit être marquée comme exportable. Cette opération nécessite l’autorisation clés/mise en production.

release_key(name: str, target_attestation_token: str, **kwargs) -> ReleaseKeyResult

Paramètres

name

str

Obligatoire

Nom de la clé à obtenir.

target_attestation_token

str

Obligatoire

Assertion d’attestation pour la cible de la version de clé.

version

str ou None

Version spécifique de la clé à libérer. Si elle n’est pas spécifiée, la dernière version est publiée.

algorithm

str ou KeyExportEncryptionAlgorithm ou None

Algorithme de chiffrement à utiliser pour protéger le matériel de clé libéré.

nonce

str ou None

Un nonce fourni par le client pour la fraîcheur.

Retours

Résultat de la mise en production de la clé.

Type de retour

ReleaseKeyResult

Exceptions

HttpResponseError

restore_key_backup

Restaurez une sauvegarde de clé dans le coffre.

Nécessite l’autorisation clés/restauration.

Cette opération importe toutes les versions de la clé, avec son nom, ses attributs et ses stratégies de contrôle d’accès. Si le nom de la clé est déjà utilisé, sa restauration échoue. En outre, le coffre cible doit appartenir au même abonnement Microsoft Azure que le coffre source.

restore_key_backup(backup: bytes, **kwargs) -> KeyVaultKey

Paramètres

backup

bytes

Obligatoire

Sauvegarde de clé retournée par backup_key

Retours

Clé restaurée

Type de retour

KeyVaultKey

Exceptions

ResourceExistsError

si le nom de la clé sauvegardée est déjà utilisé,

HttpResponseError

pour d’autres erreurs

rotate_key

Faites pivoter la clé en fonction de la stratégie de clé en générant une nouvelle version de la clé.

Cette opération nécessite l’autorisation clés/rotation.

rotate_key(name: str, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la clé à faire pivoter.

Retours

Nouvelle version de la clé pivotée.

Type de retour

KeyVaultKey

Exceptions

HttpResponseError

send_request

Exécute une requête réseau à l’aide du pipeline existant du client.

L’URL de requête peut être relative à l’URL du coffre. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Cette méthode ne déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de requêtes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Paramètres

request

HttpRequest

Obligatoire

Demande réseau que vous souhaitez effectuer.

stream

bool

Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.

Retours

Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.

Type de retour

HttpResponse

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

update_key_properties

Modifier les propriétés d’une clé (et non son matériel de chiffrement).

Nécessite des clés/une autorisation de mise à jour.

update_key_properties(name: str, version: str | None = None, **kwargs) -> KeyVaultKey

Paramètres

name

str

Obligatoire

Nom de la clé à mettre à jour

version

str ou None

Obligatoire

(facultatif) Version de la clé à mettre à jour. Si elle n’est pas spécifiée, la dernière version est mise à jour.

key_operations

list[KeyOperation ou str] ou None

Opérations de clé autorisées

enabled

bool ou None

Indique si la clé est activée pour l’utilisation.

tags

dict[str, str] ou None

Métadonnées spécifiques d’application sous la forme de paires clé/valeur.

not_before

datetime ou None

Date non antérieure de la clé en UTC

expires_on

datetime ou None

Date d’expiration de la clé en UTC

release_policy

KeyReleasePolicy ou None

Règles de stratégie selon lesquelles la clé peut être exportée.

Retours

Clé mise à jour

Type de retour

KeyVaultKey

Exceptions

ResourceNotFoundError

si la clé n’existe pas,

HttpResponseError

pour d’autres erreurs

update_key_rotation_policy

Mises à jour la stratégie de rotation d’une clé Key Vault.

Cette opération nécessite l’autorisation clés/mise à jour.

update_key_rotation_policy(key_name: str, policy: KeyRotationPolicy, **kwargs) -> KeyRotationPolicy

Paramètres

key_name

str

Obligatoire

Nom de la clé dans le coffre donné.

policy

KeyRotationPolicy

Obligatoire

Nouvelle stratégie de rotation pour la clé.

lifetime_actions

list[KeyRotationLifetimeAction]

Actions qui seront effectuées par Key Vault sur la durée de vie d’une clé. Cela remplace les actions de durée de vie du fourni policy.

expires_in

str

Heure d’expiration de la stratégie qui sera appliquée aux nouvelles versions de clé, définie comme une durée ISO 8601. Par exemple : 90 jours est « P90D », 3 mois est « P3M » et 48 heures est « PT48H ». Pour plus d’informations sur les durées iso 8601, consultez Wikipédia . Cela remplacera l’heure d’expiration du fourni policy.

Retours

Stratégie de rotation mise à jour.

Type de retour

KeyRotationPolicy

Exceptions

HttpResponseError

Attributs

vault_url