Compartir a través de

Get-AzKeyVaultSecret

Módulo:
Az.KeyVault Module

Obtiene los secretos de un almacén de claves.

Sintaxis

ByVaultName (valor predeterminado) 

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

BySecretName 

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

BySecretVersions 

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

ByInputObjectVaultName 

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

ByInputObjectSecretName 

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

ByInputObjectSecretVersions 

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

BySecretUri 

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

ByParentResourceIdVaultName 

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

ByParentResourceIdSecretName 

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

ByParentResourceIdSecretVersions 

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

Description

El cmdlet Get-AzKeyVaultSecret obtiene secretos en un almacén de claves. Este cmdlet obtiene un secreto específico o todos los secretos de un almacén de claves.

Ejemplos

Ejemplo 1: Obtención de todas las versiones actuales de todos los secretos de un almacén de claves

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         :

Este comando obtiene las versiones actuales de todos los secretos del almacén de claves denominado Contoso.

Ejemplo 2: Obtener todas las versiones de un secreto 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         :

Este comando obtiene todas las versiones del secreto denominado secret1 en el almacén de claves denominado Contoso.

Ejemplo 3: Obtención de la versión actual de un secreto 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         :

Este comando obtiene la versión actual del secreto denominado secret1 en el almacén de claves denominado Contoso.

Ejemplo 4: Obtener una versión específica de un secreto 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         :

Este comando obtiene una versión específica del secreto denominado secret1 en el almacén de claves denominado Contoso.

Ejemplo 5: Obtención de la versión actual de un secreto específico mediante 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         :

Este comando obtiene la versión actual del secreto denominado secret1 en el almacén de claves denominado Contoso.

Ejemplo 6: Obtención de una versión específica de un secreto específico mediante 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         :

Este comando obtiene una versión específica del secreto denominado secret1 en el almacén de claves denominado Contoso.

Ejemplo 7: Obtención de la versión actual de todos los secretos mediante 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         :

Este comando obtiene la versión actual de todos los secretos del almacén de claves denominado Contoso.

Ejemplo 8: Obtención del valor de texto sin formato de la versión actual de un secreto específico

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

El cmdlet devuelve el secreto como una cadena cuando -AsPlainText se aplica.

Nota: Al enumerar secretos, es decir, no proporcionar -Name, se omite .-AsPlainText

Ejemplo 9: Obtenga todos los secretos que se han eliminado, pero no purgado para este almacén de claves.

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                 :

Este comando obtiene todos los secretos que se han eliminado anteriormente, pero no purgados, en el almacén de claves denominado Contoso.

Ejemplo 10: obtiene el secreto ITSecret que se ha eliminado pero no purgado para este almacén de claves.

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                 :

Este comando obtiene el secreto "secret1" que se ha eliminado anteriormente, pero no purgado, en el almacén de claves denominado Contoso. Este comando devolverá metadatos como la fecha de eliminación y la fecha de purga programada de este secreto eliminado.

Ejemplo 11: Obtención de todas las versiones actuales de todos los secretos de un almacén de claves mediante el filtrado

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         :

Este comando obtiene las versiones actuales de todos los secretos del almacén de claves denominado Contoso que comienzan por "secreto".

Ejemplo 12: Obtención de un secreto en Azure Key Vault mediante el comando Get-Secret en el 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

En este ejemplo se obtiene un secreto denominado secureSecret en Azure Key Vault denominado test-kv por comando Get-Secret en el módulo Microsoft.PowerShell.SecretManagement.

Parámetros

-AsPlainText

Cuando se establece, el cmdlet convertirá el secreto en una cadena segura en la cadena de texto no cifrado descifrado como salida.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
BySecretName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectSecretName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
BySecretUri
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdSecretName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure

Propiedades de parámetro

Tipo:IAzureContextContainer
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Id

URI del secreto de KeyVault. Asegúrese de que sigue el formato: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:SecretId

Conjuntos de parámetros

BySecretUri
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-IncludeVersions

Indica que este cmdlet obtiene todas las versiones de un secreto. La versión actual de un secreto es la primera de la lista. Si especifica este parámetro, también debe especificar los parámetros Name y VaultName . Si no especifica el parámetro IncludeVersions , este cmdlet obtiene la versión actual del secreto con el nombre especificado.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

BySecretVersions
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectSecretVersions
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdSecretVersions
Posición:Named
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

KeyVault (objeto).

Propiedades de parámetro

Tipo:PSKeyVault
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByInputObjectVaultName
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectSecretName
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectSecretVersions
Posición:0
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InRemovedState

Especifica si se muestran los secretos eliminados anteriormente en la salida.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
BySecretUri
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdVaultName
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Especifica el nombre del secreto que se va a obtener.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:True
DontShow:False
Alias:SecretName

Conjuntos de parámetros

ByVaultName
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectVaultName
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdVaultName
Posición:1
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ParentResourceId

Id. de recurso de KeyVault.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:ResourceId

Conjuntos de parámetros

ByParentResourceIdVaultName
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
ByParentResourceIdSecretName
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False
ByParentResourceIdSecretVersions
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-VaultName

Especifica el nombre del almacén de claves al que pertenece el secreto. Este cmdlet construye el nombre de dominio completo (FQDN) de un almacén de claves en función del nombre que especifica este parámetro y el entorno actual.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

ByVaultName
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
BySecretName
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
BySecretVersions
Posición:0
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Version

Especifica la versión secreta. Este cmdlet construye el FQDN de un secreto en función del nombre del almacén de claves, el entorno seleccionado actualmente, el nombre del secreto y la versión del secreto.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:SecretVersion

Conjuntos de parámetros

BySecretName
Posición:2
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByInputObjectSecretName
Posición:2
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False
ByParentResourceIdSecretName
Posición:2
Obligatorio:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

PSKeyVault

String

Salidas

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret