KeysOperations Classe

Avertissement

NE PAS instancier cette classe directement.

Au lieu de cela, vous devez accéder aux opérations suivantes via

KeyVaultManagementClientEst

attribut<xref:keys> ;

Héritage

builtins.object

KeysOperations

Constructeur

KeysOperations(*args, **kwargs)

Méthodes

create_if_not_exist	Crée la première version d’une nouvelle clé si elle n’existe pas. Si elle existe déjà, la clé existante est retournée sans qu’aucune opération d’écriture n’ait été effectuée. Cette API ne crée pas de versions ultérieures et ne met pas à jour les clés existantes.
get	Obtient la version actuelle de la clé spécifiée à partir du coffre de clés spécifié.
get_version	Obtient la version spécifiée de la clé spécifiée dans le coffre de clés spécifié.
list	Répertorie les clés dans le coffre de clés spécifié.
list_versions	Répertorie les versions de la clé spécifiée dans le coffre de clés spécifié.

create_if_not_exist

Crée la première version d’une nouvelle clé si elle n’existe pas. Si elle existe déjà, la clé existante est retournée sans qu’aucune opération d’écriture n’ait été effectuée. Cette API ne crée pas de versions ultérieures et ne met pas à jour les clés existantes.

create_if_not_exist(resource_group_name: str, vault_name: str, key_name: str, parameters: _models.KeyCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Key

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le coffre de clés spécifié. Obligatoire.

vault_name

str

Obligatoire

Nom du coffre de clés qui contient la clé à créer. Obligatoire.

key_name

str

Obligatoire

Nom de la clé à créer. La valeur que vous fournissez peut être copiée globalement dans le but d’exécuter le service. La valeur fournie ne doit pas inclure d’informations d’identification personnelle ou sensibles. Obligatoire.

parameters

KeyCreateParameters ou IO

Obligatoire

Paramètres utilisés pour créer la clé spécifiée. Est un type KeyCreateParameters ou un type d’E/S. Obligatoire.

content_type

str

Body Parameter content-type. Les valeurs connues sont : 'application/json'. La valeur par défaut est Aucun.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Clé ou résultat de cls(response)

Type de retour

Key

Exceptions

HttpResponseError

get

Obtient la version actuelle de la clé spécifiée à partir du coffre de clés spécifié.

get(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Key

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le coffre de clés spécifié. Obligatoire.

vault_name

str

Obligatoire

Nom du coffre qui contient la clé à récupérer. Obligatoire.

key_name

str

Obligatoire

Nom de la clé à récupérer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Clé ou résultat de cls(response)

Type de retour

Key

Exceptions

HttpResponseError

get_version

Obtient la version spécifiée de la clé spécifiée dans le coffre de clés spécifié.

get_version(resource_group_name: str, vault_name: str, key_name: str, key_version: str, **kwargs: Any) -> Key

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le coffre de clés spécifié. Obligatoire.

vault_name

str

Obligatoire

Nom du coffre qui contient la version de clé à récupérer. Obligatoire.

key_name

str

Obligatoire

Nom de la version de clé à récupérer. Obligatoire.

key_version

str

Obligatoire

Version de la clé à récupérer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Clé ou résultat de cls(response)

Type de retour

Key

Exceptions

HttpResponseError

list

Répertorie les clés dans le coffre de clés spécifié.

list(resource_group_name: str, vault_name: str, **kwargs: Any) -> Iterable[Key]

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le coffre de clés spécifié. Obligatoire.

vault_name

str

Obligatoire

Nom du coffre qui contient les clés à récupérer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme l’instance de key ou le résultat de cls(response)

Type de retour

ItemPaged[Key]

Exceptions

HttpResponseError

list_versions

Répertorie les versions de la clé spécifiée dans le coffre de clés spécifié.

list_versions(resource_group_name: str, vault_name: str, key_name: str, **kwargs: Any) -> Iterable[Key]

Paramètres

resource_group_name

str

Obligatoire

Nom du groupe de ressources qui contient le coffre de clés spécifié. Obligatoire.

vault_name

str

Obligatoire

Nom du coffre qui contient les versions de clé à récupérer. Obligatoire.

key_name

str

Obligatoire

Nom des versions de clé à récupérer. Obligatoire.

cls

callable

Type ou fonction personnalisé qui recevra la réponse directe

Retours

Un itérateur comme l’instance de key ou le résultat de cls(response)

Type de retour

ItemPaged[Key]

Exceptions

HttpResponseError

Attributs

models

models = <module 'azure.mgmt.keyvault.v2023_02_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\keyvault\\v2023_02_01\\models\\__init__.py'>