Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureKeyVault

Get-AzureKeyVault

microsoft.azure.commands.keyvault.dll

Synopsis

Gets Azure Key Vault instances.

Syntax

Get-AzureKeyVault [-VaultName] [-ResourceGroupName] [-Profile] [<CommonParameters>]

Get-AzureKeyVault [-ResourceGroupName] [-Profile] [<CommonParameters>]

Get-AzureKeyVault [-Profile] [-Tag] [<CommonParameters>]

Detailed Description

The Get-AzureKeyVault cmdlet gets information about the Azure Key Vault instances in a subscription. You can view all key vault instances in a subscription, or filter your results by a resource group or a particular key vault.

Note that although specifying the resource group is optional for this cmdlet when you get a single key vault, you should do so for better performance.

Parameters

-Profile <Microsoft.Azure.Common.Authentication.Models.AzureProfile>

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-ResourceGroupName <System.String>

Specifies the name of the resource group associated with the key vault or key vaults being queried.

Aliases

none

Required?

false

Position

2

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-Tag <System.Collections.Hashtable>

Specifies the key and value of the specified tag to filter the list of key vaults by hash table.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

-VaultName <System.String>

Specifies the name of the key vault.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

true(ByPropertyName)

Accept wildcard characters?

false

Input Type

String

Return Type

PSVault, List<PSVaultIdentityItem>

Notes

None

Examples

Example 1: Get all key vaults in your current subscription

This command gets all the key vaults in your current subscription.

PS C:\>Get-AzureKeyVault

Example 2: Get a specific key vault

This command gets the key vault named Contoso03Vault in your current subscription, and then stores it in the $MyVault variable. You can inspect the properties of $MyVault to get details about the key vault.

PS C:\>$MyVault = Get-AzureKeyVault -VaultName "Contoso03Vault"

Example 3: Get key vaults in a resource group

This command gets all the key vaults in the resource group named ContosoPayRollResourceGroup.

PS C:\>Get-AzureKeyVault -ResourceGroupName "ContosoPayRollResourceGroup"

Online Version
New-AzureKeyVault
Remove-AzureKeyVault