Get-AzKeyVaultSecret
Získá tajné kódy v trezoru klíčů.
Syntaxe
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
Rutina Get-AzKeyVaultSecret získá tajné kódy v trezoru klíčů. Tato rutina získá konkrétní tajný klíč nebo všechny tajné kódy v trezoru klíčů.
Příklady
Příklad 1: Získání všech aktuálních verzí všech tajných kódů v trezoru klíčů
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 :Tento příkaz získá aktuální verze všech tajných kódů v trezoru klíčů s názvem Contoso.
Příklad 2: Získání všech verzí určitého tajného kódu
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 :Tento příkaz získá všechny verze tajného kódu s názvem secret1 v trezoru klíčů s názvem Contoso.
Příklad 3: Získání aktuální verze konkrétního tajného kódu
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 :Tento příkaz získá aktuální verzi tajného kódu s názvem secret1 v trezoru klíčů s názvem Contoso.
Příklad 4: Získání konkrétní verze konkrétního tajného kódu
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 :Tento příkaz získá konkrétní verzi tajného kódu s názvem secret1 v trezoru klíčů s názvem Contoso.
Příklad 5: Získání aktuální verze konkrétního tajného kódu pomocí identifikátoru 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 :Tento příkaz získá aktuální verzi tajného kódu s názvem secret1 v trezoru klíčů s názvem Contoso.
Příklad 6: Získání konkrétní verze konkrétního tajného kódu pomocí identifikátoru 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 :Tento příkaz získá konkrétní verzi tajného kódu s názvem secret1 v trezoru klíčů s názvem Contoso.
Příklad 7: Získání aktuální verze všech tajných kódů pomocí identifikátoru 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 :Tento příkaz získá aktuální verzi všech tajných kódů v trezoru klíčů s názvem Contoso.
Příklad 8: Získání hodnoty prostého textu aktuální verze konkrétního tajného kódu
$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainTextRutina vrátí tajný kód jako řetězec při použití -AsPlainText.
Poznámka: Při výpisu tajných kódů, tj. nezadá -Name, -AsPlainText se ignoruje.
Příklad 9: Získejte všechny tajné kódy, které byly odstraněny, ale nebyly vymazány pro tento trezor klíčů.
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 :Tento příkaz získá všechny tajné kódy, které byly dříve odstraněny, ale nebyly vymazány, v trezoru klíčů s názvem Contoso.
Příklad 10: Získá tajný kód ITSecret, který byl odstraněn, ale není vymazán pro tento trezor klíčů.
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 :Tento příkaz získá tajný kód "secret1", který byl dříve odstraněn, ale není vyprázdněný, v trezoru klíčů s názvem Contoso. Tento příkaz vrátí metadata, jako je datum odstranění a plánované datum vymazání tohoto odstraněného tajného kódu.
Příklad 11: Získání všech aktuálních verzí všech tajných kódů v trezoru klíčů pomocí filtrování
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 :Tento příkaz získá aktuální verze všech tajných kódů v trezoru klíčů s názvem Contoso, který začíná na "secret".
Příklad 12: Získání tajného kódu ve službě Azure Key Vault příkazem Get-Secret v modulu 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
PasswordTento příklad získá tajný kód s názvem secureSecret ve službě Azure Key Vault s názvem test-kv příkazem Get-Secret v modulu Microsoft.PowerShell.SecretManagement.
Parametry
-AsPlainText
Při nastavení rutina převede tajný kód v zabezpečeném řetězci na dešifrovaný řetězec prostého textu jako výstup.
| Typ: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Vyžadováno: | False |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure
| Typ: | IAzureContextContainer |
| Aliasy: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Vyžadováno: | False |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-Id
Identifikátor URI tajného klíče služby KeyVault.
Ujistěte se, že se řídí formátem: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>
| Typ: | String |
| Aliasy: | SecretId |
| Position: | 0 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-IncludeVersions
Označuje, že tato rutina získá všechny verze tajného kódu. Aktuální verze tajného kódu je první verze v seznamu. Pokud zadáte tento parametr, musíte také zadat parametry Name a Vault Name. Pokud nezadáte parametr IncludeVersions, získá tato rutina aktuální verzi tajného kódu se zadaným Name.
| Typ: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-InputObject
KeyVault – objekt.
| Typ: | PSKeyVault |
| Position: | 0 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | True |
| Přijmout zástupné znaky: | False |
-InRemovedState
Určuje, jestli se mají ve výstupu zobrazit dříve odstraněné tajné kódy.
| Typ: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Vyžadováno: | False |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-Name
Určuje název tajného kódu, který se má získat.
| Typ: | String |
| Aliasy: | SecretName |
| Position: | 1 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | True |
-ParentResourceId
ID prostředku služby KeyVault
| Typ: | String |
| Aliasy: | ResourceId |
| Position: | 0 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | True |
| Přijmout zástupné znaky: | False |
-VaultName
Určuje název trezoru klíčů, do kterého tajný klíč patří. Tato rutina vytvoří plně kvalifikovaný název domény (FQDN) trezoru klíčů na základě názvu, který tento parametr určuje a vaše aktuální prostředí.
| Typ: | String |
| Position: | 0 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
-Version
Určuje verzi tajného kódu. Tato rutina vytvoří plně kvalifikovaný název domény tajného kódu na základě názvu trezoru klíčů, aktuálně vybraného prostředí, názvu tajného kódu a verze tajného kódu.
| Typ: | String |
| Aliasy: | SecretVersion |
| Position: | 2 |
| Default value: | None |
| Vyžadováno: | True |
| Přijmout vstup kanálu: | False |
| Přijmout zástupné znaky: | False |
Vstupy
Výstupy
PSDeletedKeyVaultSecretIdentityItem
Související odkazy
Azure PowerShell