Get-AzKeyVaultSecret

Referência

Módulo:: Az.KeyVault

Obtém os segredos em um cofre de chaves.

Sintaxe

Get-AzKeyVaultSecret
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-Id] <String>
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [-Name] <String>
   [-Version] <String>
   [-AsPlainText]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultSecret
   [-ParentResourceId] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet Get-AzKeyVaultSecret obtém segredos em um cofre de chaves. Esse cmdlet obtém um segredo específico ou todos os segredos em um cofre de chaves.

Exemplos

Exemplo 1: Obter todas as versões atuais de todos os segredos em um cofre de chaves

Get-AzKeyVaultSecret -VaultName 'Contoso'

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

Esse comando obtém as versões atuais de todos os segredos no cofre de chaves chamado Contoso.

Exemplo 2: Obter todas as versões de um segredo específico

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Esse comando obtém todas as versões do segredo chamado secret1 no cofre de chaves chamado Contoso.

Exemplo 3: Obter a versão atual de um segredo específico

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Esse comando obtém a versão atual do segredo chamado secret1 no cofre de chaves chamado Contoso.

Exemplo 4: Obter uma versão específica de um segredo específico

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c'

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Esse comando obtém uma versão específica do segredo chamado secret1 no cofre de chaves chamado Contoso.

Exemplo 5: Obter a versão atual de um segredo específico usando o Uri

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/secret1/'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Esse comando obtém a versão atual do segredo chamado secret1 no cofre de chaves chamado Contoso.

Exemplo 6: Obter uma versão específica de um segredo específico usando o Uri

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/secret1/7128133570f84a71b48d7d0550deb74c'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Esse comando obtém uma versão específica do segredo chamado secret1 no cofre de chaves chamado Contoso.

Exemplo 7: Obter a versão atual de todos os segredos usando o Uri

Get-AzKeyVaultSecret -Id 'https://contoso.vault.azure.net/secrets/'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret2/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Esse comando obtém a versão atual de todos os segredos no cofre de chaves chamado Contoso.

Exemplo 8: Obter o valor de texto sem formatação da versão atual de um segredo específico

$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText

O cmdlet retorna o segredo como uma cadeia de caracteres quando -AsPlainText é aplicado.

Observação: Ao listar segredos, ou seja, não fornecer -Name, o -AsPlainText é ignorado.

Exemplo 9: obter todos os segredos que foram excluídos, mas não limpos para este cofre de chaves.

Get-AzKeyVaultSecret -VaultName 'Contoso' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Id                   : https://contoso.vault.azure.net:443/secrets/secret1
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Vault Name           : contoso
Name                 : secret2
Id                   : https://contoso.vault.azure.net:443/secrets/secret2
Deleted Date         : 5/7/2018 7:56:34 PM
Scheduled Purge Date : 8/5/2018 7:56:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/6/2018 8:39:15 PM
Updated              : 4/6/2018 10:11:24 PM
Content Type         :
Tags                 :

Esse comando obtém todos os segredos que foram excluídos anteriormente, mas não limpos, no cofre de chaves chamado Contoso.

Exemplo 10: obtém o ITSecret secreto que foi excluído, mas não limpo para este cofre de chaves.

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Version              : 689d23346e9c42a2a64f4e3d75094dcc
Id                   : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Esse comando obtém o segredo 'secret1' que foi excluído anteriormente, mas não limpo, no cofre de chaves chamado Contoso. Esse comando retornará metadados como a data de exclusão e a data de limpeza agendada desse segredo excluído.

Exemplo 11: Obter todas as versões atuais de todos os segredos em um cofre de chaves usando filtragem

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name "secret*"

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

Esse comando obtém as versões atuais de todos os segredos no cofre de chaves chamado Contoso que começam com "secret".

Exemplo 12: obter um segredo no Azure Key Vault por comando Get-Secret no módulo Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "****" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Get-Secret -Vault AzKeyVault -Name secureSecret -AsPlainText

Password

Este exemplo obtém um segredo chamado secureSecret no Azure Key Vault chamado test-kv por Get-Secret de comando no módulo Microsoft.PowerShell.SecretManagement.

Parâmetros

-AsPlainText

Quando definido, o cmdlet converterá o segredo na cadeia de caracteres segura para a cadeia de caracteres de texto sem formatação descriptografada como saída.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-DefaultProfile

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

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Id

O URI do segredo KeyVault. Verifique se ele segue o formato: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Tipo:	String
Aliases:	SecretId
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-IncludeVersions

Indica que esse cmdlet obtém todas as versões de um segredo. A versão atual de um segredo é a primeira da lista. Se você especificar esse parâmetro, também deverá especificar os parâmetros Name e VaultName. Se você não especificar o parâmetro IncludeVersions, esse cmdlet obterá a versão atual do segredo com o nome especificado.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-InputObject

Objeto KeyVault.

Tipo:	PSKeyVault
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-InRemovedState

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

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Name

Especifica o nome do segredo a ser obtido.

Tipo:	String
Aliases:	SecretName
Cargo:	1
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	True

-ParentResourceId

ID do recurso KeyVault.

Tipo:	String
Aliases:	ResourceId
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-VaultName

Especifica o nome do cofre de chaves ao qual o segredo pertence. Esse cmdlet constrói o FQDN (nome de domínio totalmente qualificado) de um cofre de chaves com base no nome especificado por esse parâmetro e no ambiente atual.

Tipo:	String
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Version

Especifica a versão secreta. Esse cmdlet constrói o FQDN de um segredo com base no nome do cofre de chaves, no ambiente atualmente selecionado, no nome do segredo e na versão secreta.

Tipo:	String
Aliases:	SecretVersion
Cargo:	2
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

PSKeyVault

String

Saídas

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret

Compartilhar via

Get-AzKeyVaultSecret

Sintaxe

Description

Exemplos

Exemplo 1: Obter todas as versões atuais de todos os segredos em um cofre de chaves

Exemplo 2: Obter todas as versões de um segredo específico

Exemplo 3: Obter a versão atual de um segredo específico

Exemplo 4: Obter uma versão específica de um segredo específico

Exemplo 5: Obter a versão atual de um segredo específico usando o Uri

Exemplo 6: Obter uma versão específica de um segredo específico usando o Uri

Exemplo 7: Obter a versão atual de todos os segredos usando o Uri

Exemplo 8: Obter o valor de texto sem formatação da versão atual de um segredo específico

Exemplo 9: obter todos os segredos que foram excluídos, mas não limpos para este cofre de chaves.

Exemplo 10: obtém o ITSecret secreto que foi excluído, mas não limpo para este cofre de chaves.

Exemplo 11: Obter todas as versões atuais de todos os segredos em um cofre de chaves usando filtragem

Exemplo 12: obter um segredo no Azure Key Vault por comando Get-Secret no módulo Microsoft.PowerShell.SecretManagement

Parâmetros

-AsPlainText

-DefaultProfile

-Id

-IncludeVersions

-InputObject

-InRemovedState

-Name

-ParentResourceId

-VaultName

-Version

Entradas

Saídas

Recursos adicionais

Compartilhar via

Get-AzKeyVaultSecret

Sintaxe

Description

Exemplos

Exemplo 1: Obter todas as versões atuais de todos os segredos em um cofre de chaves

Exemplo 2: Obter todas as versões de um segredo específico

Exemplo 3: Obter a versão atual de um segredo específico

Exemplo 4: Obter uma versão específica de um segredo específico

Exemplo 5: Obter a versão atual de um segredo específico usando o Uri

Exemplo 6: Obter uma versão específica de um segredo específico usando o Uri

Exemplo 7: Obter a versão atual de todos os segredos usando o Uri

Exemplo 8: Obter o valor de texto sem formatação da versão atual de um segredo específico

Exemplo 9: obter todos os segredos que foram excluídos, mas não limpos para este cofre de chaves.

Exemplo 10: obtém o ITSecret secreto que foi excluído, mas não limpo para este cofre de chaves.

Exemplo 11: Obter todas as versões atuais de todos os segredos em um cofre de chaves usando filtragem

Exemplo 12: obter um segredo no Azure Key Vault por comando Get-Secret no módulo Microsoft.PowerShell.SecretManagement

Parâmetros

-AsPlainText

-DefaultProfile

-Id

-IncludeVersions

-InputObject

-InRemovedState

-Name

-ParentResourceId

-VaultName

-Version

Entradas

Saídas

Links Relacionados

Recursos adicionais