Get-AzureRmKeyVault

Referência

Módulo:: AzureRM.KeyVault

Obtém cofres de chaves.

Aviso

O módulo AzureRM PowerShell foi oficialmente preterido a partir de 29 de fevereiro de 2024. Os usuários são aconselhados a migrar do AzureRM para o módulo Az PowerShell para garantir suporte e atualizações contínuos.

Embora o módulo AzureRM ainda possa funcionar, ele não é mais mantido ou suportado, colocando qualquer uso continuado a critério e risco do usuário. Consulte nossos recursos de migração para obter orientação sobre a transição para o módulo Az.

Syntax

Get-AzureRmKeyVault
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmKeyVault
   [[-VaultName] <String>]
   [[-ResourceGroupName] <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmKeyVault
   [-VaultName] <String>
   [-Location] <String>
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmKeyVault
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet Get-AzureRmKeyVault obtém informações sobre os cofres de chaves em uma assinatura. Você pode exibir todas as instâncias dos cofres de chaves em uma assinatura ou filtrar seus resultados por um grupo de recursos ou um cofre de chaves específico. Observe que, embora a especificação do grupo de recursos seja opcional para esse cmdlet quando você obtém um cofre de chave única, você deve fazê-lo para obter um melhor desempenho.

Exemplos

Exemplo 1: Obter todos os cofres de chaves na sua subscrição atual

PS C:\> Get-AzureRMKeyVault

Vault Name          : myvault1
Resource Group Name : myrg
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke
                      yVault/vaults/myvault1
Tags                :


Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Este comando obtém todos os cofres de chaves na sua subscrição atual.

Exemplo 2: Obter um cofre de chaves específico

PS C:\> Get-AzureRMKeyVault -VaultName 'myvault'

Vault Name                       : myvault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/myvault
Vault URI                        : https://myvault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : True
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update

Tags                             :

Este comando obtém o cofre de chaves chamado myvault na sua subscrição atual.

Exemplo 3: Obter cofres de chaves em um grupo de recursos

PS C:\> Get-AzureRmKeyVault -ResourceGroupName 'myrg1'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Este comando obtém todos os cofres de chaves no grupo de recursos chamado ContosoPayRollResourceGroup.

Exemplo 4: Obter todos os cofres de chaves eliminados na sua subscrição atual

PS C:\> Get-AzureRmKeyVault -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Este comando obtém todos os cofres de chaves excluídos em sua assinatura atual.

Exemplo 5: Obter um cofre de chaves excluído

PS C:\> Get-AzureRMKeyVault -VaultName 'myvault4'  -Location 'westus' -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Este comando obtém as informações excluídas do cofre de chaves chamado myvault4 em sua assinatura atual e na região westus.

Parâmetros

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure

Tipo:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InRemovedState

Especifica se os cofres excluídos anteriormente devem ser mostrados na saída.

Tipo:	SwitchParameter
Position:	Named
valor predefinido:	None
Necessário:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

A localização do cofre excluído.

Tipo:	String
Position:	1
valor predefinido:	None
Necessário:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

Especifica o nome do grupo de recursos associado ao cofre de chaves ou cofres de chaves que estão sendo consultados.

Tipo:	String
Position:	1
valor predefinido:	None
Necessário:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Pares chave-valor na forma de uma tabela de hash. Por exemplo: @{key0="value0"; chave1=$null; key2="valor2"}

Tipo:	Hashtable
Position:	Named
valor predefinido:	None
Necessário:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VaultName

Especifica o nome do cofre de chaves.

Tipo:	String
Aliases:	Name
Position:	0
valor predefinido:	None
Necessário:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Entradas

String

Hashtable

Saídas

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

Partilhar via

Get-AzureRmKeyVault

Syntax

Description

Exemplos

Exemplo 1: Obter todos os cofres de chaves na sua subscrição atual

Exemplo 2: Obter um cofre de chaves específico

Exemplo 3: Obter cofres de chaves em um grupo de recursos

Exemplo 4: Obter todos os cofres de chaves eliminados na sua subscrição atual

Exemplo 5: Obter um cofre de chaves excluído

Parâmetros

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-Tag

-VaultName

Entradas

Saídas

Recursos adicionais

Partilhar via

Get-AzureRmKeyVault

Syntax

Description

Exemplos

Exemplo 1: Obter todos os cofres de chaves na sua subscrição atual

Exemplo 2: Obter um cofre de chaves específico

Exemplo 3: Obter cofres de chaves em um grupo de recursos

Exemplo 4: Obter todos os cofres de chaves eliminados na sua subscrição atual

Exemplo 5: Obter um cofre de chaves excluído

Parâmetros

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-Tag

-VaultName

Entradas

Saídas

Ligações Relacionadas

Recursos adicionais