Az.KeyVault

This topic displays help topics for the Azure Key Vault Cmdlets.

Key Vault

Add-AzKeyVaultCertificate

Adds a certificate to a key vault.

Add-AzKeyVaultCertificateContact

Adds a contact for certificate notifications.

Add-AzKeyVaultKey

Creates a key in a key vault or imports a key into a key vault.

Add-AzKeyVaultManagedHsmRegion

The List operation gets information about the regions associated with the managed HSM Pool.

Add-AzKeyVaultManagedStorageAccount

Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service.

Add-AzKeyVaultNetworkRule

Adds a rule meant to restrict access to a key vault based on the client's internet address.

Backup-AzKeyVault

Fully backup a managed HSM.

Backup-AzKeyVaultCertificate

Backs up a certificate in a key vault.

Backup-AzKeyVaultKey

Backs up a key in a key vault.

Backup-AzKeyVaultManagedStorageAccount

Backs up a KeyVault-managed storage account.

Backup-AzKeyVaultSecret

Backs up a secret in a key vault.

Export-AzKeyVaultSecurityDomain

Exports the security domain data of a managed HSM.

Get-AzKeyVault

Gets key vaults.

Get-AzKeyVaultCertificate

Gets a certificate from a key vault.

Get-AzKeyVaultCertificateContact

Gets contacts that are registered for certificate notifications for a key vault.

Get-AzKeyVaultCertificateIssuer

Gets a certificate issuer for a key vault.

Get-AzKeyVaultCertificateOperation

Gets the status of a certificate operation.

Get-AzKeyVaultCertificatePolicy

Gets the policy for a certificate in a key vault.

Get-AzKeyVaultKey

Gets Key Vault keys. Please notes that detailed information about a key, like key type or key size, only available when querying a specific key version.

Get-AzKeyVaultKeyRotationPolicy

Gets the key rotation policy for the specified key in Key Vault.

Get-AzKeyVaultManagedHsm

Get managed HSMs.

Get-AzKeyVaultManagedHsmRegion

The List operation gets information about the regions associated with the managed HSM Pool.

Get-AzKeyVaultManagedStorageAccount

Gets Key Vault managed Azure Storage Accounts.

Get-AzKeyVaultManagedStorageSasDefinition

Gets Key Vault managed Storage SAS Definitions.

Get-AzKeyVaultRandomNumber

Get the requested number of bytes containing random values from a managed HSM.

Get-AzKeyVaultRoleAssignment

Get or list role assignments of a managed HSM. Use respective parameters to list assignments to a specific user or a role definition.

Get-AzKeyVaultRoleDefinition

List role definitions of a given managed HSM at a given scope.

Get-AzKeyVaultSecret

Gets the secrets in a key vault.

Get-AzKeyVaultSetting

Retrieves a specified key vault account setting or all available key vault account settings that can be configured.

Import-AzKeyVaultCertificate

Imports a certificate to a key vault.

Import-AzKeyVaultSecurityDomain

Imports previously exported security domain data to a managed HSM.

Invoke-AzKeyVaultKeyOperation

Performs operation like "Encrypt", "Decrypt", "Wrap" or "Unwrap" using a specified key stored in a key vault or managed hsm.

Invoke-AzKeyVaultKeyRotation

Creates a new key version in Key Vault, stores it, then returns the new key.

New-AzKeyVault

Creates a key vault.

New-AzKeyVaultCertificateAdministratorDetail

Creates an in-memory certificate administrator details object.

New-AzKeyVaultCertificateOrganizationDetail

Creates an in-memory certificate organization details object.

New-AzKeyVaultCertificatePolicy

Creates an in-memory certificate policy object.

New-AzKeyVaultManagedHsm

Creates a managed HSM.

New-AzKeyVaultNetworkRuleSetObject

Create an object representing the network rule settings.

New-AzKeyVaultRoleAssignment

Assigns the specified RBAC role to the specified principal, at the specified scope.

New-AzKeyVaultRoleDefinition

Creates a custom role definition on an HSM.

Remove-AzKeyVault

Deletes a key vault.

Remove-AzKeyVaultAccessPolicy

Removes all permissions for a user or application from a key vault.

Remove-AzKeyVaultCertificate

Removes a certificate from a key vault.

Remove-AzKeyVaultCertificateContact

Deletes a contact that is registered for certificate notifications from a key vault.

Remove-AzKeyVaultCertificateIssuer

Deletes a certificate issuer from a key vault.

Remove-AzKeyVaultCertificateOperation

Deletes a certificate operation from a key vault.

Remove-AzKeyVaultKey

Deletes a key in a key vault.

Remove-AzKeyVaultManagedHsm

Deletes/Purges a managed HSM.

Remove-AzKeyVaultManagedHsmRegion

The List operation gets information about the regions associated with the managed HSM Pool.

Remove-AzKeyVaultManagedStorageAccount

Removes a Key Vault managed Azure Storage Account and all associated SAS definitions.

Remove-AzKeyVaultManagedStorageSasDefinition

Removes a Key Vault managed Azure Storage SAS definitions.

Remove-AzKeyVaultNetworkRule

Removes a network rule from a key vault.

Remove-AzKeyVaultRoleAssignment

Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope.

Remove-AzKeyVaultRoleDefinition

Removes a custom role definition from an HSM.

Remove-AzKeyVaultSecret

Deletes a secret in a key vault.

Restore-AzKeyVault

Fully restores a managed HSM from backup.

Restore-AzKeyVaultCertificate

Restores a certificate in a key vault from a backup file.

Restore-AzKeyVaultKey

Creates a key in a key vault from a backed-up key.

Restore-AzKeyVaultManagedStorageAccount

Restores a managed storage account in a key vault from a backup file.

Restore-AzKeyVaultSecret

Creates a secret in a key vault from a backed-up secret.

Set-AzKeyVaultAccessPolicy

Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault.

Set-AzKeyVaultCertificateIssuer

Sets a certificate issuer in a key vault.

Set-AzKeyVaultCertificatePolicy

Creates or updates the policy for a certificate in a key vault.

Set-AzKeyVaultKeyRotationPolicy

Sets the key rotation policy for the specified key in Key Vault.

Set-AzKeyVaultManagedStorageSasDefinition

Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account.

Set-AzKeyVaultSecret

Creates or updates a secret in a key vault.

Stop-AzKeyVaultCertificateOperation

Cancels a certificate operation in key vault.

Test-AzKeyVaultManagedHsmNameAvailability

Checks that the managed hsm name is valid and is not already in use.

Test-AzKeyVaultNameAvailability

Checks that the vault name is valid and is not already in use.

Undo-AzKeyVaultCertificateRemoval

Recovers a deleted certificate in a key vault into an active state.

Undo-AzKeyVaultKeyRemoval

Recovers a deleted key in a key vault into an active state.

Undo-AzKeyVaultManagedHsmRemoval

Recover a managed HSM.

Undo-AzKeyVaultManagedStorageAccountRemoval

Recovers a previously deleted KeyVault-managed storage account.

Undo-AzKeyVaultManagedStorageSasDefinitionRemoval

Recovers a previously deleted KeyVault-managed storage SAS definition.

Undo-AzKeyVaultRemoval

Recovers a deleted key vault into an active state.

Undo-AzKeyVaultSecretRemoval

Recovers a deleted secret in a key vault into an active state.

Update-AzKeyVault

Update the state of an Azure key vault.

Update-AzKeyVaultCertificate

Modifies editable attributes of a certificate.

Update-AzKeyVaultKey

Updates the attributes of a key in a key vault.

Update-AzKeyVaultManagedHsm

Update the state of an Azure managed HSM.

Update-AzKeyVaultManagedStorageAccount

Update editable attributes of a Key Vault managed Azure Storage Account.

Update-AzKeyVaultManagedStorageAccountKey

Regenerates the specified key of Key Vault managed Azure Storage Account.

Update-AzKeyVaultNetworkRuleSet

Updates the network rule set on a key vault.

Update-AzKeyVaultSecret

Updates attributes of a secret in a key vault.

Update-AzKeyVaultSetting

Update specific setting associated with the managed HSM.