@azure/arm-keyvault package

Classes

KeyVaultManagementClient

Interfaces

AccessPolicyEntry	An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID.
Action	model interface Action
Attributes	The object attributes managed by the KeyVault service.
CheckMhsmNameAvailabilityParameters	The parameters used to check the availability of the managed hsm name.
CheckMhsmNameAvailabilityResult	The CheckMhsmNameAvailability operation response.
CheckNameAvailabilityResult	The CheckNameAvailability operation response.
CloudError	An error response from Key Vault resource provider
CloudErrorBody	An error response from Key Vault resource provider
DeletedManagedHsm	Concrete proxy resource types can be created by aliasing this type using a specific property type.
DeletedManagedHsmProperties	Properties of the deleted managed HSM.
DeletedVault	Deleted vault information with extended details.
DeletedVaultProperties	Properties of the deleted vault.
DimensionProperties	Type of operation: get, read, delete, etc.
ErrorModel	The server error.
IPRule	A rule governing the accessibility of a vault from a specific ip address or ip range.
Key	The key resource.
KeyAttributes	The object attributes managed by the Azure Key Vault service.
KeyCreateParameters	The parameters used to create a key.
KeyProperties	The properties of the key.
KeyReleasePolicy	model interface KeyReleasePolicy
KeyRotationPolicyAttributes	model interface KeyRotationPolicyAttributes
KeyVaultManagementClientOptionalParams	Optional parameters for the client.
KeysCreateIfNotExistOptionalParams	Optional parameters.
KeysGetOptionalParams	Optional parameters.
KeysGetVersionOptionalParams	Optional parameters.
KeysListOptionalParams	Optional parameters.
KeysListVersionsOptionalParams	Optional parameters.
KeysOperations	Interface representing a Keys operations.
LifetimeAction	model interface LifetimeAction
LogSpecification	Log specification of operation.
ManagedHSMSecurityDomainProperties	The security domain properties of the managed hsm.
ManagedHsm	Resource information with extended details.
ManagedHsmAction	model interface ManagedHsmAction
ManagedHsmError	The error exception.
ManagedHsmKey	The key resource.
ManagedHsmKeyAttributes	The object attributes managed by the Azure Key Vault service.
ManagedHsmKeyCreateParameters	The parameters used to create a key.
ManagedHsmKeyProperties	The properties of the key.
ManagedHsmKeyReleasePolicy	model interface ManagedHsmKeyReleasePolicy
ManagedHsmKeyRotationPolicyAttributes	model interface ManagedHsmKeyRotationPolicyAttributes
ManagedHsmKeysCreateIfNotExistOptionalParams	Optional parameters.
ManagedHsmKeysGetOptionalParams	Optional parameters.
ManagedHsmKeysGetVersionOptionalParams	Optional parameters.
ManagedHsmKeysListOptionalParams	Optional parameters.
ManagedHsmKeysListVersionsOptionalParams	Optional parameters.
ManagedHsmKeysOperations	Interface representing a ManagedHsmKeys operations.
ManagedHsmLifetimeAction	model interface ManagedHsmLifetimeAction
ManagedHsmProperties	Properties of the managed HSM Pool
ManagedHsmRotationPolicy	model interface ManagedHsmRotationPolicy
ManagedHsmSku	SKU details
ManagedHsmTrigger	model interface ManagedHsmTrigger
ManagedHsmsCheckMhsmNameAvailabilityOptionalParams	Optional parameters.
ManagedHsmsCreateOrUpdateOptionalParams	Optional parameters.
ManagedHsmsDeleteOptionalParams	Optional parameters.
ManagedHsmsGetDeletedOptionalParams	Optional parameters.
ManagedHsmsGetOptionalParams	Optional parameters.
ManagedHsmsListByResourceGroupOptionalParams	Optional parameters.
ManagedHsmsListBySubscriptionOptionalParams	Optional parameters.
ManagedHsmsListDeletedOptionalParams	Optional parameters.
ManagedHsmsOperations	Interface representing a ManagedHsms operations.
ManagedHsmsPurgeDeletedOptionalParams	Optional parameters.
ManagedHsmsUpdateOptionalParams	Optional parameters.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MetricSpecification	Metric specification of operation.
MhsmGeoReplicatedRegion	A region that this managed HSM Pool has been extended to.
MhsmNetworkRuleSet	A set of rules governing the network accessibility of a managed hsm pool.
MhsmPrivateEndpoint	Private endpoint object properties.
MhsmPrivateEndpointConnection	Private endpoint connection resource.
MhsmPrivateEndpointConnectionItem	Private endpoint connection item.
MhsmPrivateEndpointConnectionProperties	Properties of the private endpoint connection resource.
MhsmPrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
MhsmPrivateEndpointConnectionsGetOptionalParams	Optional parameters.
MhsmPrivateEndpointConnectionsListByResourceOptionalParams	Optional parameters.
MhsmPrivateEndpointConnectionsOperations	Interface representing a MhsmPrivateEndpointConnections operations.
MhsmPrivateEndpointConnectionsPutOptionalParams	Optional parameters.
MhsmPrivateLinkResource	A private link resource
MhsmPrivateLinkResourceListResult	A list of private link resources
MhsmPrivateLinkResourceProperties	Properties of a private link resource.
MhsmPrivateLinkResourcesListByMhsmResourceOptionalParams	Optional parameters.
MhsmPrivateLinkResourcesOperations	Interface representing a MhsmPrivateLinkResources operations.
MhsmPrivateLinkServiceConnectionState	An object that represents the approval state of the private link connection.
MhsmRegionsListByResourceOptionalParams	Optional parameters.
MhsmRegionsOperations	Interface representing a MhsmRegions operations.
MhsmServiceTagRule	A rule governing the accessibility of a managed hsm pool from a specific service tags.
MhsmVirtualNetworkRule	A rule governing the accessibility of a managed hsm pool from a specific virtual network.
MhsmipRule	A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.
NetworkRuleSet	A set of rules governing the network accessibility of a vault.
Operation	Key Vault REST API operation definition.
OperationDisplay	Display metadata associated with the operation.
OperationProperties	Properties of operation, include metric specifications.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Permissions	Permissions the identity has for keys, secrets, certificates and storage.
PrivateEndpoint	Private endpoint object properties.
PrivateEndpointConnection	Private endpoint connection resource.
PrivateEndpointConnectionItem	Private endpoint connection item.
PrivateEndpointConnectionProperties	Properties of the private endpoint connection resource.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByResourceOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateEndpointConnectionsPutOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesListByVaultOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	An object that represents the approval state of the private link connection.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RotationPolicy	model interface RotationPolicy
Secret	Resource information with extended details.
SecretAttributes	The secret management attributes.
SecretCreateOrUpdateParameters	Parameters for creating or updating a secret
SecretPatchParameters	Parameters for patching a secret
SecretPatchProperties	Properties of the secret
SecretProperties	Properties of the secret
SecretsCreateOrUpdateOptionalParams	Optional parameters.
SecretsGetOptionalParams	Optional parameters.
SecretsListOptionalParams	Optional parameters.
SecretsOperations	Interface representing a Secrets operations.
SecretsUpdateOptionalParams	Optional parameters.
ServiceSpecification	One property of operation, include log specifications.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	SKU details
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
Trigger	model interface Trigger
UserAssignedIdentity	User assigned identity properties
Vault	Resource information with extended details.
VaultAccessPolicyParameters	Parameters for updating the access policy in a vault
VaultAccessPolicyProperties	Properties of the vault access policy
VaultCheckNameAvailabilityParameters	The parameters used to check the availability of the vault name.
VaultCreateOrUpdateParameters	Parameters for creating or updating a vault
VaultPatchParameters	Parameters for creating or updating a vault
VaultPatchProperties	Properties of the vault
VaultProperties	Properties of the vault
VaultsCheckNameAvailabilityOptionalParams	Optional parameters.
VaultsCreateOrUpdateOptionalParams	Optional parameters.
VaultsDeleteOptionalParams	Optional parameters.
VaultsGetDeletedOptionalParams	Optional parameters.
VaultsGetOptionalParams	Optional parameters.
VaultsListByResourceGroupOptionalParams	Optional parameters.
VaultsListBySubscriptionOptionalParams	Optional parameters.
VaultsListDeletedOptionalParams	Optional parameters.
VaultsListOptionalParams	Optional parameters.
VaultsOperations	Interface representing a Vaults operations.
VaultsPurgeDeletedOptionalParams	Optional parameters.
VaultsUpdateAccessPolicyOptionalParams	Optional parameters.
VaultsUpdateOptionalParams	Optional parameters.
VirtualNetworkRule	A rule governing the accessibility of a vault from a specific virtual network.

Type Aliases

AccessPolicyUpdateKind	Type of AccessPolicyUpdateKind
ActionsRequired	A message indicating if changes on the service provider require any updates on the consumer. KnownActionsRequired can be used interchangeably with ActionsRequired, this enum contains the known values that the service supports. Known values supported by the service None
ActivationStatus	Activation Status KnownActivationStatus can be used interchangeably with ActivationStatus, this enum contains the known values that the service supports. Known values supported by the service Active: The managed HSM Pool is active. NotActivated: The managed HSM Pool is not yet activated. Unknown: An unknown error occurred while activating managed hsm. Failed: Failed to activate managed hsm.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CertificatePermissions	Type of CertificatePermissions
ContinuablePage	An interface that describes a page of results.
CreateMode	The vault's create mode to indicate whether the vault need to be recovered or not.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DeletionRecoveryLevel	The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. KnownDeletionRecoveryLevel can be used interchangeably with DeletionRecoveryLevel, this enum contains the known values that the service supports. Known values supported by the service Purgeable Recoverable+Purgeable Recoverable Recoverable+ProtectedSubscription
GeoReplicationRegionProvisioningState	The current provisioning state. KnownGeoReplicationRegionProvisioningState can be used interchangeably with GeoReplicationRegionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Preprovisioning Provisioning Succeeded Failed Deleting Cleanup
JsonWebKeyCurveName	The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256 KnownJsonWebKeyCurveName can be used interchangeably with JsonWebKeyCurveName, this enum contains the known values that the service supports. Known values supported by the service P-256 P-384 P-521 P-256K
JsonWebKeyOperation	The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation. KnownJsonWebKeyOperation can be used interchangeably with JsonWebKeyOperation, this enum contains the known values that the service supports. Known values supported by the service encrypt decrypt sign verify wrapKey unwrapKey import release
JsonWebKeyType	The type of the key. For valid values, see JsonWebKeyType. KnownJsonWebKeyType can be used interchangeably with JsonWebKeyType, this enum contains the known values that the service supports. Known values supported by the service EC EC-HSM RSA RSA-HSM
KeyPermissions	Type of KeyPermissions
KeyRotationPolicyActionType	The type of action.
ManagedHsmSkuFamily	SKU Family of the managed HSM Pool KnownManagedHsmSkuFamily can be used interchangeably with ManagedHsmSkuFamily, this enum contains the known values that the service supports. Known values supported by the service B C
ManagedHsmSkuName	SKU of the managed HSM Pool
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
NetworkRuleAction	The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. KnownNetworkRuleAction can be used interchangeably with NetworkRuleAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
NetworkRuleBypassOptions	Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. KnownNetworkRuleBypassOptions can be used interchangeably with NetworkRuleBypassOptions, this enum contains the known values that the service supports. Known values supported by the service AzureServices None
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Updating Deleting Failed Disconnected
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ProvisioningState	Provisioning state. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: The managed HSM Pool has been full provisioned. Provisioning: The managed HSM Pool is currently being provisioned. Failed: Provisioning of the managed HSM Pool has failed. Updating: The managed HSM Pool is currently being updated. Deleting: The managed HSM Pool is currently being deleted. Activated: The managed HSM pool is ready for normal use. SecurityDomainRestore: The managed HSM pool is waiting for a security domain restore action. Restoring: The managed HSM pool is being restored from full HSM backup.
PublicNetworkAccess	Control permission to the managed HSM from public networks. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
Reason	The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false. KnownReason can be used interchangeably with Reason, this enum contains the known values that the service supports. Known values supported by the service AccountNameInvalid AlreadyExists
SecretPermissions	Type of SecretPermissions
SkuFamily	SKU family name KnownSkuFamily can be used interchangeably with SkuFamily, this enum contains the known values that the service supports. Known values supported by the service A
SkuName	SKU name to specify whether the key vault is a standard vault or a premium vault.
StoragePermissions	Type of StoragePermissions
VaultProvisioningState	Provisioning state of the vault. KnownVaultProvisioningState can be used interchangeably with VaultProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded RegisteringDns

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionsRequired	A message indicating if changes on the service provider require any updates on the consumer.
KnownActivationStatus	Activation Status
KnownCertificatePermissions	Known values of CertificatePermissions that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownDeletionRecoveryLevel	The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.
KnownGeoReplicationRegionProvisioningState	The current provisioning state.
KnownJsonWebKeyCurveName	The elliptic curve name. For valid values, see JsonWebKeyCurveName. Default for EC and EC-HSM keys is P-256
KnownJsonWebKeyOperation	The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.
KnownJsonWebKeyType	The type of the key. For valid values, see JsonWebKeyType.
KnownKeyPermissions	Known values of KeyPermissions that the service accepts.
KnownManagedHsmSkuFamily	SKU Family of the managed HSM Pool
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownNetworkRuleAction	The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.
KnownNetworkRuleBypassOptions	Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownProvisioningState	Provisioning state.
KnownPublicNetworkAccess	Control permission to the managed HSM from public networks.
KnownReason	The reason that a vault name could not be used. The Reason element is only returned if NameAvailable is false.
KnownSecretPermissions	Known values of SecretPermissions that the service accepts.
KnownSkuFamily	SKU family name
KnownStoragePermissions	Known values of StoragePermissions that the service accepts.
KnownVaultProvisioningState	Provisioning state of the vault.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(KeyVaultManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: KeyVaultManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

KeyVaultManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>