@azure/arm-keyvault package
Classes
| KeyVaultManagementClient |
Interfaces
| AccessPolicyEntry |
Identité qui a accès au coffre de clés. Toutes les identités du tableau doivent utiliser le même ID de locataire que l’ID de locataire du coffre de clés. |
| Action |
Interface modèle Action |
| Attributes |
Attributs d’objet gérés par le service KeyVault. |
| CheckMhsmNameAvailabilityParameters |
Paramètres utilisés pour vérifier la disponibilité du nom hsm managé. |
| CheckMhsmNameAvailabilityResult |
Réponse de l’opération CheckMhsmNameAvailability. |
| CheckNameAvailabilityResult |
Réponse de l’opération CheckNameAvailability. |
| CloudError |
Réponse d’erreur du fournisseur de ressources Key Vault |
| CloudErrorBody |
Réponse d’erreur du fournisseur de ressources Key Vault |
| DeletedManagedHsm |
Les types de ressources proxy concrets peuvent être créés en alias ce type à l’aide d’un type de propriété spécifique. |
| DeletedManagedHsmProperties |
Propriétés du HSM managé supprimé. |
| DeletedVault |
Informations de coffre supprimées avec des détails étendus. |
| DeletedVaultProperties |
Propriétés du coffre supprimé. |
| DimensionProperties |
Type d’opération : obtenir, lire, supprimer, etc. |
| ErrorModel |
Erreur du serveur. |
| IPRule |
Règle régissant l’accessibilité d’un coffre à partir d’une adresse IP ou d’une plage d’adresses IP spécifique. |
| Key |
Ressource de clé. |
| KeyAttributes |
Attributs d’objet gérés par le service Azure Key Vault. |
| KeyCreateParameters |
Paramètres utilisés pour créer une clé. |
| KeyProperties |
Propriétés de la clé. |
| KeyReleasePolicy |
interface de modèle KeyReleasePolicy |
| KeyRotationPolicyAttributes |
interface de modèle KeyRotationPolicyAttributes |
| KeyVaultManagementClientOptionalParams |
Paramètres facultatifs pour le client. |
| KeysCreateIfNotExistOptionalParams |
Paramètres facultatifs. |
| KeysGetOptionalParams |
Paramètres facultatifs. |
| KeysGetVersionOptionalParams |
Paramètres facultatifs. |
| KeysListOptionalParams |
Paramètres facultatifs. |
| KeysListVersionsOptionalParams |
Paramètres facultatifs. |
| KeysOperations |
Interface représentant une opération de clés. |
| LifetimeAction |
interface modèle LifetimeAction |
| LogSpecification |
Spécification du journal de l’opération. |
| ManagedHSMSecurityDomainProperties |
Propriétés du domaine de sécurité du hsm managé. |
| ManagedHsm |
Informations sur les ressources avec des détails étendus. |
| ManagedHsmAction |
interface modèle ManagedHsmAction |
| ManagedHsmError |
Exception d’erreur. |
| ManagedHsmKey |
Ressource de clé. |
| ManagedHsmKeyAttributes |
Attributs d’objet gérés par le service Azure Key Vault. |
| ManagedHsmKeyCreateParameters |
Paramètres utilisés pour créer une clé. |
| ManagedHsmKeyProperties |
Propriétés de la clé. |
| ManagedHsmKeyReleasePolicy |
interface de modèle ManagedHsmKeyReleasePolicy |
| ManagedHsmKeyRotationPolicyAttributes |
interface modèle ManagedHsmKeyRotationPolicyAttributes |
| ManagedHsmKeysCreateIfNotExistOptionalParams |
Paramètres facultatifs. |
| ManagedHsmKeysGetOptionalParams |
Paramètres facultatifs. |
| ManagedHsmKeysGetVersionOptionalParams |
Paramètres facultatifs. |
| ManagedHsmKeysListOptionalParams |
Paramètres facultatifs. |
| ManagedHsmKeysListVersionsOptionalParams |
Paramètres facultatifs. |
| ManagedHsmKeysOperations |
Interface représentant une opération ManagedHsmKeys. |
| ManagedHsmLifetimeAction |
interface modèle ManagedHsmLifetimeAction |
| ManagedHsmProperties |
Propriétés du pool HSM managé |
| ManagedHsmRotationPolicy |
interface modèle ManagedHsmRotationPolicy |
| ManagedHsmSku |
Détails de la référence SKU |
| ManagedHsmTrigger |
interface modèle ManagedHsmTrigger |
| ManagedHsmsCheckMhsmNameAvailabilityOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsDeleteOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsGetDeletedOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsGetOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsListBySubscriptionOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsListDeletedOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsOperations |
Interface représentant une opération ManagedHsms. |
| ManagedHsmsPurgeDeletedOptionalParams |
Paramètres facultatifs. |
| ManagedHsmsUpdateOptionalParams |
Paramètres facultatifs. |
| ManagedServiceIdentity |
Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur) |
| MetricSpecification |
Spécification de métrique de l’opération. |
| MhsmGeoReplicatedRegion |
Région vers laquelle ce pool HSM managé a été étendu. |
| MhsmNetworkRuleSet |
Ensemble de règles régissant l’accessibilité réseau d’un pool hsm managé. |
| MhsmPrivateEndpoint |
Propriétés de l’objet point de terminaison privé. |
| MhsmPrivateEndpointConnection |
Ressource de connexion de point de terminaison privé. |
| MhsmPrivateEndpointConnectionItem |
Élément de connexion de point de terminaison privé. |
| MhsmPrivateEndpointConnectionProperties |
Propriétés de la ressource de connexion du point de terminaison privé. |
| MhsmPrivateEndpointConnectionsDeleteOptionalParams |
Paramètres facultatifs. |
| MhsmPrivateEndpointConnectionsGetOptionalParams |
Paramètres facultatifs. |
| MhsmPrivateEndpointConnectionsListByResourceOptionalParams |
Paramètres facultatifs. |
| MhsmPrivateEndpointConnectionsOperations |
Interface représentant une opération MhsmPrivateEndpointConnections. |
| MhsmPrivateEndpointConnectionsPutOptionalParams |
Paramètres facultatifs. |
| MhsmPrivateLinkResource |
Ressource de liaison privée |
| MhsmPrivateLinkResourceListResult |
Liste des ressources de liaison privée |
| MhsmPrivateLinkResourceProperties |
Propriétés d’une ressource de liaison privée. |
| MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams |
Paramètres facultatifs. |
| MhsmPrivateLinkResourcesOperations |
Interface représentant une opération MhsmPrivateLinkResources. |
| MhsmPrivateLinkServiceConnectionState |
Objet qui représente l’état d’approbation de la connexion de liaison privée. |
| MhsmRegionsListByResourceOptionalParams |
Paramètres facultatifs. |
| MhsmRegionsOperations |
Interface représentant une opération MhsmRegions. |
| MhsmServiceTagRule |
Une règle régissant l’accessibilité d’un pool HSM géré à partir d’un service spécifique. |
| MhsmVirtualNetworkRule |
Règle régissant l’accessibilité d’un pool hsm managé à partir d’un réseau virtuel spécifique. |
| MhsmipRule |
Règle régissant l’accessibilité d’un pool HSM managé à partir d’une adresse IP ou d’une plage d’adresses IP spécifiques. |
| NetworkRuleSet |
Ensemble de règles régissant l’accessibilité réseau d’un coffre. |
| Operation |
Définition de l’opération d’API REST Key Vault. |
| OperationDisplay |
Afficher les métadonnées associées à l’opération. |
| OperationProperties |
Les propriétés de fonctionnement incluent les spécifications métriques. |
| OperationsListOptionalParams |
Paramètres facultatifs. |
| OperationsOperations |
Interface représentant des opérations. |
| PageSettings |
Options de la méthode byPage |
| PagedAsyncIterableIterator |
Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page. |
| Permissions |
Autorisations dont dispose l’identité pour les clés, les secrets, les certificats et le stockage. |
| PrivateEndpoint |
Propriétés de l’objet point de terminaison privé. |
| PrivateEndpointConnection |
Ressource de connexion de point de terminaison privé. |
| PrivateEndpointConnectionItem |
Élément de connexion de point de terminaison privé. |
| PrivateEndpointConnectionProperties |
Propriétés de la ressource de connexion du point de terminaison privé. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsGetOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsListByResourceOptionalParams |
Paramètres facultatifs. |
| PrivateEndpointConnectionsOperations |
Interface représentant des opérations PrivateEndpointConnections. |
| PrivateEndpointConnectionsPutOptionalParams |
Paramètres facultatifs. |
| PrivateLinkResource |
Ressource de liaison privée |
| PrivateLinkResourceListResult |
Liste des ressources de liaison privée |
| PrivateLinkResourceProperties |
Propriétés d’une ressource de liaison privée. |
| PrivateLinkResourcesListByVaultOptionalParams |
Paramètres facultatifs. |
| PrivateLinkResourcesOperations |
Interface représentant une opération PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Objet qui représente l’état d’approbation de la connexion de liaison privée. |
| ProxyResource |
Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement |
| Resource |
Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager |
| RestorePollerOptions | |
| RotationPolicy |
interface modèle RotationPolicy |
| Secret |
Informations sur les ressources avec des détails étendus. |
| SecretAttributes |
Attributs de gestion des secrets. |
| SecretCreateOrUpdateParameters |
Paramètres de création ou de mise à jour d’un secret |
| SecretPatchParameters |
Paramètres de mise à jour corrective d’un secret |
| SecretPatchProperties |
Propriétés du secret |
| SecretProperties |
Propriétés du secret |
| SecretsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| SecretsGetOptionalParams |
Paramètres facultatifs. |
| SecretsListOptionalParams |
Paramètres facultatifs. |
| SecretsOperations |
Interface représentant une opération Secrets. |
| SecretsUpdateOptionalParams |
Paramètres facultatifs. |
| ServiceSpecification |
Une propriété d’opération inclut des spécifications de journal. |
| SimplePollerLike |
Un polleur simple qui peut être utilisé pour interroger une opération de longue durée. |
| Sku |
Détails de la référence SKU |
| SystemData |
Métadonnées relatives à la création et à la dernière modification de la ressource. |
| TrackedResource |
Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement » |
| Trigger |
Interface modèle Trigger |
| UserAssignedIdentity |
Propriétés d’identité attribuées par l’utilisateur |
| Vault |
Informations sur les ressources avec des détails étendus. |
| VaultAccessPolicyParameters |
Paramètres de mise à jour de la stratégie d’accès dans un coffre |
| VaultAccessPolicyProperties |
Propriétés de la stratégie d’accès au coffre |
| VaultCheckNameAvailabilityParameters |
Paramètres utilisés pour vérifier la disponibilité du nom du coffre. |
| VaultCreateOrUpdateParameters |
Paramètres de création ou de mise à jour d’un coffre |
| VaultPatchParameters |
Paramètres de création ou de mise à jour d’un coffre |
| VaultPatchProperties |
Propriétés du coffre |
| VaultProperties |
Propriétés du coffre |
| VaultsCheckNameAvailabilityOptionalParams |
Paramètres facultatifs. |
| VaultsCreateOrUpdateOptionalParams |
Paramètres facultatifs. |
| VaultsDeleteOptionalParams |
Paramètres facultatifs. |
| VaultsGetDeletedOptionalParams |
Paramètres facultatifs. |
| VaultsGetOptionalParams |
Paramètres facultatifs. |
| VaultsListByResourceGroupOptionalParams |
Paramètres facultatifs. |
| VaultsListBySubscriptionOptionalParams |
Paramètres facultatifs. |
| VaultsListDeletedOptionalParams |
Paramètres facultatifs. |
| VaultsListOptionalParams |
Paramètres facultatifs. |
| VaultsOperations |
Interface représentant une opération Vaults. |
| VaultsPurgeDeletedOptionalParams |
Paramètres facultatifs. |
| VaultsUpdateAccessPolicyOptionalParams |
Paramètres facultatifs. |
| VaultsUpdateOptionalParams |
Paramètres facultatifs. |
| VirtualNetworkRule |
Règle régissant l’accessibilité d’un coffre à partir d’un réseau virtuel spécifique. |
Alias de type
| AccessPolicyUpdateKind |
Type d’AccessPolicyUpdateType |
| ActionsRequired |
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. Valeurs connues prises en charge par le serviceAucun |
| ActivationStatus |
Statut d’activation Valeurs connues prises en charge par le service
actif : le pool HSM managé est actif. |
| AzureSupportedClouds |
Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne |
| CertificatePermissions |
Type de certificatPermissions |
| ContinuablePage |
Interface qui décrit une page de résultats. |
| CreateMode |
Mode de création du coffre pour indiquer si le coffre doit être récupéré ou non. |
| CreatedByType |
Type d’entité qui a créé la ressource. Valeurs connues prises en charge par le service
'utilisateur: l’entité a été créée par un utilisateur. |
| DeletionRecoveryLevel |
Le niveau de récupération de suppression actuellement en vigueur pour l’objet. S’il contient « Purgeable », alors l’objet peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut purger l’objet à la fin de l’intervalle de rétention. Valeurs connues prises en charge par le service
purgeable |
| GeoReplicationRegionProvisioningState |
État d’approvisionnement actuel. Valeurs connues prises en charge par le service
de préprovisionnement |
| JsonWebKeyCurveName |
Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. Par défaut pour les touches EC et EC-HSM est P-256 Valeurs connues prises en charge par le service
P-256 |
| JsonWebKeyOperation |
Les opérations de clé web JSON autorisées de la clé. Pour plus d’informations, consultez JsonWebKeyOperation. Valeurs connues prises en charge par le service
chiffrer |
| JsonWebKeyType |
Type de la clé. Pour obtenir des valeurs valides, consultez JsonWebKeyType. Valeurs connues prises en charge par le service
EC |
| KeyPermissions |
Type de CléPermissions |
| KeyRotationPolicyActionType |
Type d’action. |
| ManagedHsmSkuFamily |
Famille SKU du pool HSM géré Valeurs connues prises en charge par le service
B |
| ManagedHsmSkuName |
Référence SKU du pool HSM managé |
| ManagedServiceIdentityType |
Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). Valeurs connues prises en charge par le service
Aucun: aucune identité managée. |
| NetworkRuleAction |
Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette opération est utilisée uniquement après l’évaluation de la propriété de contournement. Valeurs connues prises en charge par le service
Autoriser |
| NetworkRuleBypassOptions |
Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ». Valeurs connues prises en charge par le service
AzureServices |
| PrivateEndpointConnectionProvisioningState |
État d’approvisionnement actuel. Valeurs connues prises en charge par le service
réussi |
| PrivateEndpointServiceConnectionStatus |
État de la connexion de point de terminaison privé. Valeurs connues prises en charge par le service
en attente |
| ProvisioningState |
État d’approvisionnement. Valeurs connues prises en charge par le service
réussi: le pool HSM managé a été approvisionné entièrement. |
| PublicNetworkAccess |
Contrôlez l’autorisation sur le HSM managé à partir de réseaux publics. Valeurs connues prises en charge par le service
activé |
| Reason |
Raison pour laquelle un nom de coffre-fort n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false. Valeurs connues prises en charge par le service
CompteNomInvalide |
| SecretPermissions |
Type de permissionsSecrets |
| SkuFamily |
Nom de famille SKU Valeurs connues prises en charge par le serviceun |
| SkuName |
Nom de la référence SKU pour spécifier si le coffre de clés est un coffre standard ou un coffre Premium. |
| StoragePermissions |
Type de permissionsStockage |
| VaultProvisioningState |
État d’approvisionnement du coffre. Valeurs connues prises en charge par le service
réussi |
Énumérations
| AzureClouds |
Une énumération pour décrire les environnements Cloud Azure. |
| KnownActionsRequired |
Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur. |
| KnownActivationStatus |
État d’activation |
| KnownCertificatePermissions |
Valeurs connues de CertificatePermissions que le service accepte. |
| KnownCreatedByType |
Type d’entité qui a créé la ressource. |
| KnownDeletionRecoveryLevel |
Le niveau de récupération de suppression actuellement en vigueur pour l’objet. S’il contient « Purgeable », alors l’objet peut être supprimé définitivement par un utilisateur privilégié ; sinon, seul le système peut purger l’objet à la fin de l’intervalle de rétention. |
| KnownGeoReplicationRegionProvisioningState |
État d’approvisionnement actuel. |
| KnownJsonWebKeyCurveName |
Nom de la courbe elliptique. Pour obtenir des valeurs valides, consultez JsonWebKeyCurveName. La valeur par défaut des clés EC et EC-HSM est P-256 |
| KnownJsonWebKeyOperation |
Les opérations de clé web JSON autorisées de la clé. Pour plus d’informations, consultez JsonWebKeyOperation. |
| KnownJsonWebKeyType |
Type de la clé. Pour obtenir des valeurs valides, consultez JsonWebKeyType. |
| KnownKeyPermissions |
Valeurs connues de KeyPermissions que le service accepte. |
| KnownManagedHsmSkuFamily |
Famille de références SKU du pool HSM managé |
| KnownManagedServiceIdentityType |
Type d’identité de service managé (où les types SystemAssigned et UserAssigned sont autorisés). |
| KnownNetworkRuleAction |
Action par défaut lorsqu’aucune règle d’ipRules et de virtualNetworkRules ne correspond. Cette opération est utilisée uniquement après l’évaluation de la propriété de contournement. |
| KnownNetworkRuleBypassOptions |
Indique ce que le trafic peut contourner les règles réseau. Il peut s’agir d'« AzureServices » ou de « Aucun ». S’il n’est pas spécifié, la valeur par défaut est « AzureServices ». |
| KnownPrivateEndpointConnectionProvisioningState |
État d’approvisionnement actuel. |
| KnownPrivateEndpointServiceConnectionStatus |
État de la connexion de point de terminaison privé. |
| KnownProvisioningState |
État d’approvisionnement. |
| KnownPublicNetworkAccess |
Contrôlez l’autorisation sur le HSM managé à partir de réseaux publics. |
| KnownReason |
Raison pour laquelle un nom de coffre-fort n’a pas pu être utilisé. L’élément Reason est retourné uniquement si NameAvailable a la valeur false. |
| KnownSecretPermissions |
Valeurs connues de SecretPermissions que le service accepte. |
| KnownSkuFamily |
Nom de la famille de référenceS (SKU) |
| KnownStoragePermissions |
Valeurs connues de StoragePermissions que le service accepte. |
| KnownVaultProvisioningState |
État d’approvisionnement du coffre. |
| KnownVersions |
Versions d’API disponibles. |
Functions
| restore |
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue. |
Informations relatives à la fonction
restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crée un polleur à partir de l’état sérialisé d’un autre polleur. Cela peut être utile lorsque vous souhaitez créer des polleurs sur un autre hôte ou qu’un polleur doit être construit une fois que l’original n’est pas dans l’étendue.
function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Paramètres
- client
- KeyVaultManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Retours
PollerLike<OperationState<TResult>, TResult>