Get-AzKeyVault

Módulo:: Az.KeyVault Module

Obtém cofres de chaves.

Sintaxe

GetVaultByName (Default)

Get-AzKeyVault
    [[-VaultName] <String>]
    [[-ResourceGroupName] <String>]
    [-Tag <Hashtable>]
    [-DefaultProfile <IAzureContextContainer>]
    [-SubscriptionId <String>]
    [<CommonParameters>]

ByDeletedVault

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

ListAllDeletedVaultsInSubscription

Get-AzKeyVault
    [-InRemovedState]
    [-DefaultProfile <IAzureContextContainer>]
    [-SubscriptionId <String>]
    [<CommonParameters>]

Description

O cmdlet Get-AzKeyVault obtém informações sobre os cofres de chaves em uma assinatura. Você pode exibir todas as instâncias de 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 único cofre de chaves, você deve fazer isso para melhorar o desempenho.

O cmdlet pode chamar abaixo da API do Microsoft Graph de acordo com os parâmetros de entrada:

GET /directoryObjects/{id}
GET /users/{id}
GET /servicePrincipals/{id}
GET /groups/{id}

Exemplos

Exemplo 1: Obter todos os cofres de chaves em sua assinatura atual

Get-AzKeyVault

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                :

Esse comando obtém todos os cofres de chaves em sua assinatura atual.

Exemplo 2: Obter um cofre de chaves específico

Get-AzKeyVault -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                             :

Esse comando obtém o cofre de chaves chamado myvault em sua assinatura atual.

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

Get-AzKeyVault -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                :

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

Exemplo 4: Obter todos os cofres de chaves excluídos em sua assinatura atual

Get-AzKeyVault -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                 :

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

Exemplo 5: Obter um cofre de chaves excluído

Get-AzKeyVault -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                 :

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

Exemplo 6: Obter cofres de chaves usando filtragem

Get-AzKeyVault -VaultName 'myvault*'

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                :

Esse comando obtém todos os cofres de chaves na assinatura que começam com "myvault".

Parâmetros

-DefaultProfile

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

Propriedades do parâmetro

Tipo:	IAzureContextContainer
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-InRemovedState

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

Propriedades do parâmetro

Tipo:	SwitchParameter
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ByDeletedVault

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

ListAllDeletedVaultsInSubscription

Cargo:	Named
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	False
Valor dos argumentos restantes:	False

-Location

O local do cofre excluído.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

ByDeletedVault

Cargo:	1
Obrigatório:	True
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-ResourceGroupName

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

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False

Conjuntos de parâmetros

GetVaultByName

Cargo:	1
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-SubscriptionId

A ID da assinatura. Por padrão, os cmdlets são executados na assinatura definida no contexto atual. Se o usuário especificar outra assinatura, o cmdlet atual será executado na assinatura especificada pelo usuário. A substituição de assinaturas só tem efeito durante o ciclo de vida do cmdlet atual. Ele não altera a assinatura no contexto e não afeta os cmdlets subsequentes.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

(All)

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-Tag

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

Propriedades do parâmetro

Tipo:	Hashtable
Valor padrão:	None
Dá suporte a curingas:	False
DontShow:	False

Conjuntos de parâmetros

GetVaultByName

Cargo:	Named
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

-VaultName

Especifica o nome do cofre de chaves.

Propriedades do parâmetro

Tipo:	String
Valor padrão:	None
Dá suporte a curingas:	True
DontShow:	False
Aliases:	Nome

Conjuntos de parâmetros

GetVaultByName

Cargo:	0
Obrigatório:	False
Valor do pipeline:	False
Valor do pipeline pelo nome da propriedade:	True
Valor dos argumentos restantes:	False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Compartilhar via

Get-AzKeyVault

Sintaxe

GetVaultByName (Default)

ByDeletedVault

ListAllDeletedVaultsInSubscription

Description

Exemplos

Exemplo 1: Obter todos os cofres de chaves em sua assinatura 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 excluídos em sua assinatura atual

Exemplo 5: Obter um cofre de chaves excluído

Exemplo 6: Obter cofres de chaves usando filtragem

Parâmetros

-DefaultProfile

Propriedades do parâmetro

Conjuntos de parâmetros

-InRemovedState

Propriedades do parâmetro

Conjuntos de parâmetros

-Location

Propriedades do parâmetro

Conjuntos de parâmetros

-ResourceGroupName

Propriedades do parâmetro

Conjuntos de parâmetros

-SubscriptionId

Propriedades do parâmetro

Conjuntos de parâmetros

-Tag

Propriedades do parâmetro

Conjuntos de parâmetros

-VaultName

Propriedades do parâmetro

Conjuntos de parâmetros

CommonParameters

Entradas

String

Hashtable

Saídas

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

Links Relacionados

Comentários