@azure/arm-keyvault package

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.

The object attributes managed by the KeyVault service.

The parameters used to check the availability of the managed hsm name.

The CheckMhsmNameAvailability operation response.

The CheckNameAvailability operation response.

An error response from Key Vault resource provider

An error response from Key Vault resource provider

List of deleted managed HSM Pools

Properties of the deleted managed HSM.

Deleted vault information with extended details.

List of vaults

Properties of the deleted vault.

Type of operation: get, read, delete, etc.

The server error.

A rule governing the accessibility of a vault from a specific ip address or ip range.

The key resource.

The object attributes managed by the Azure Key Vault service.

The parameters used to create a key.

The page of keys.

The properties of the key.

Optional parameters.

Interface representing a Keys.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Log specification of operation.

The security domain properties of the managed hsm.

Resource information with extended details.

The error exception.

The key resource.

The object attributes managed by the Azure Key Vault service.

The parameters used to create a key.

The page of keys.

The properties of the key.

Interface representing a ManagedHsmKeys.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

List of managed HSM Pools

Properties of the managed HSM Pool

Managed HSM resource

SKU details

Interface representing a ManagedHsms.

Optional parameters.

Defines headers for ManagedHsms_createOrUpdate operation.

Optional parameters.

Defines headers for ManagedHsms_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for ManagedHsms_purgeDeleted operation.

Optional parameters.

Defines headers for ManagedHsms_update operation.

Optional parameters.

Managed service identity (system assigned and/or user assigned identities)

Metric specification of operation.

A region that this managed HSM Pool has been extended to.

A set of rules governing the network accessibility of a managed hsm pool.

Private endpoint object properties.

Private endpoint connection resource.

Private endpoint connection item.

Interface representing a MhsmPrivateEndpointConnections.

Defines headers for MhsmPrivateEndpointConnections_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

List of private endpoint connections associated with a managed HSM Pools

Defines headers for MhsmPrivateEndpointConnections_put operation.

Optional parameters.

A private link resource

A list of private link resources

Interface representing a MhsmPrivateLinkResources.

Optional parameters.

An object that represents the approval state of the private link connection.

Interface representing a MhsmRegions.

Optional parameters.

Optional parameters.

List of regions associated with a managed HSM Pools

A rule governing the accessibility of a managed hsm pool from a specific virtual network.

A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range.

A set of rules governing the network accessibility of a vault.

Key Vault REST API operation definition.

Display metadata associated with the operation.

Result of the request to list Storage operations. It contains a list of operations and a URL link to get the next set of results.

Interface representing a Operations.

Optional parameters.

Optional parameters.

Permissions the identity has for keys, secrets, certificates and storage.

Private endpoint object properties.

Private endpoint connection resource.

Private endpoint connection item.

List of private endpoint connections.

Interface representing a PrivateEndpointConnections.

Defines headers for PrivateEndpointConnections_delete operation.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Defines headers for PrivateEndpointConnections_put operation.

Optional parameters.

A private link resource

A list of private link resources

Interface representing a PrivateLinkResources.

Optional parameters.

An object that represents the approval state of the private link connection.

Common fields that are returned in the response for all Azure Resource Manager resources

Key Vault resource

List of vault resources.

Resource information with extended details.

The secret management attributes.

Parameters for creating or updating a secret

List of secrets

Parameters for patching a secret

Properties of the secret

Properties of the secret

Interface representing a Secrets.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

One property of operation, include log specifications.

SKU details

Metadata pertaining to creation and last modification of the key vault resource.

User assigned identity properties

Resource information with extended details.

Parameters for updating the access policy in a vault

Properties of the vault access policy

The parameters used to check the availability of the vault name.

Parameters for creating or updating a vault

List of vaults

Parameters for creating or updating a vault

Properties of the vault

Properties of the vault

Interface representing a Vaults.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

Optional parameters.

A rule governing the accessibility of a vault from a specific virtual network.

Defines values for AccessPolicyUpdateKind.

Defines values for ActionsRequired.
KnownActionsRequired can be used interchangeably with ActionsRequired, this enum contains the known values that the service supports.

Known values supported by the service

None

Defines values for ActivationStatus.
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.

Defines values for CertificatePermissions.
KnownCertificatePermissions can be used interchangeably with CertificatePermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
delete
create
import
update
managecontacts
getissuers
listissuers
setissuers
deleteissuers
manageissuers
recover
purge
backup
restore

Defines values for CreateMode.

Defines values for DeletionRecoveryLevel.
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

Defines values for GeoReplicationRegionProvisioningState.
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

Defines values for IdentityType.
KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports.

Known values supported by the service

User
Application
ManagedIdentity
Key

Defines values for JsonWebKeyCurveName.
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

Defines values for 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

Defines values for 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

Defines values for KeyPermissions.
KnownKeyPermissions can be used interchangeably with KeyPermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
encrypt
decrypt
wrapKey
unwrapKey
sign
verify
get
list
create
update
import
delete
backup
restore
recover
purge
release
rotate
getrotationpolicy
setrotationpolicy

Defines values for KeyRotationPolicyActionType.

Contains response data for the createIfNotExist operation.

Contains response data for the get operation.

Contains response data for the getVersion operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the listVersionsNext operation.

Contains response data for the listVersions operation.

Contains response data for the createIfNotExist operation.

Contains response data for the get operation.

Contains response data for the getVersion operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the listVersionsNext operation.

Contains response data for the listVersions operation.

Defines values for ManagedHsmSkuFamily.
KnownManagedHsmSkuFamily can be used interchangeably with ManagedHsmSkuFamily, this enum contains the known values that the service supports.

Known values supported by the service

B

Defines values for ManagedHsmSkuName.

Contains response data for the checkMhsmNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the getDeleted operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the listDeletedNext operation.

Contains response data for the listDeleted operation.

Contains response data for the purgeDeleted operation.

Contains response data for the update operation.

Defines values for ManagedServiceIdentityType.
KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByResourceNext operation.

Contains response data for the listByResource operation.

Contains response data for the put operation.

Contains response data for the listByMhsmResource operation.

Contains response data for the listByResourceNext operation.

Contains response data for the listByResource operation.

Defines values for NetworkRuleAction.
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

Defines values for NetworkRuleBypassOptions.
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

Contains response data for the listNext operation.

Contains response data for the list operation.

Defines values for PrivateEndpointConnectionProvisioningState.
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

Contains response data for the delete operation.

Contains response data for the get operation.

Contains response data for the listByResourceNext operation.

Contains response data for the listByResource operation.

Contains response data for the put operation.

Defines values for PrivateEndpointServiceConnectionStatus.
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

Contains response data for the listByVault operation.

Defines values for ProvisioningState.
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.

Defines values for PublicNetworkAccess.
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

Defines values for Reason.

Defines values for SecretPermissions.
KnownSecretPermissions can be used interchangeably with SecretPermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
set
delete
backup
restore
recover
purge

Contains response data for the createOrUpdate operation.

Contains response data for the get operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the update operation.

Defines values for SkuFamily.
KnownSkuFamily can be used interchangeably with SkuFamily, this enum contains the known values that the service supports.

Known values supported by the service

A

Defines values for SkuName.

Defines values for StoragePermissions.
KnownStoragePermissions can be used interchangeably with StoragePermissions, this enum contains the known values that the service supports.

Known values supported by the service

all
get
list
delete
set
update
regeneratekey
recover
purge
backup
restore
setsas
listsas
getsas
deletesas

Defines values for VaultProvisioningState.
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

Contains response data for the checkNameAvailability operation.

Contains response data for the createOrUpdate operation.

Contains response data for the getDeleted operation.

Contains response data for the get operation.

Contains response data for the listByResourceGroupNext operation.

Contains response data for the listByResourceGroup operation.

Contains response data for the listBySubscriptionNext operation.

Contains response data for the listBySubscription operation.

Contains response data for the listDeletedNext operation.

Contains response data for the listDeleted operation.

Contains response data for the listNext operation.

Contains response data for the list operation.

Contains response data for the updateAccessPolicy operation.

Contains response data for the update operation.

Known values of ActionsRequired that the service accepts.

Known values of ActivationStatus that the service accepts.

Known values of CertificatePermissions that the service accepts.

Known values of DeletionRecoveryLevel that the service accepts.

Known values of GeoReplicationRegionProvisioningState that the service accepts.

Known values of IdentityType that the service accepts.

Known values of JsonWebKeyCurveName that the service accepts.

Known values of JsonWebKeyOperation that the service accepts.

Known values of JsonWebKeyType that the service accepts.

Known values of KeyPermissions that the service accepts.

Known values of ManagedHsmSkuFamily that the service accepts.

Known values of ManagedServiceIdentityType that the service accepts.

Known values of NetworkRuleAction that the service accepts.

Known values of NetworkRuleBypassOptions that the service accepts.

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

Known values of ProvisioningState that the service accepts.

Known values of PublicNetworkAccess that the service accepts.

Known values of SecretPermissions that the service accepts.

Known values of SkuFamily that the service accepts.

Known values of StoragePermissions that the service accepts.

Known values of VaultProvisioningState that the service accepts.

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.