Get-AzKeyVaultSecret
Lekéri a titkos kulcsokat egy kulcstartóban.
Syntax
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
[-ResourceId] <String>
[[-Name] <String>]
[-InRemovedState]
[-AsPlainText]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzKeyVaultSecret
[-ResourceId] <String>
[-Name] <String>
[-Version] <String>
[-AsPlainText]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzKeyVaultSecret
[-ResourceId] <String>
[-Name] <String>
[-IncludeVersions]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
A Get-AzKeyVaultSecret parancsmag titkos kulcsokat kap egy kulcstartóban. Ez a parancsmag egy adott titkos kulcsot vagy egy kulcstartó összes titkos kulcsát kapja meg.
Példák
1. példa: Az összes titkos kulcs aktuális verziójának lekérése egy kulcstartóban
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 :
Ez a parancs lekéri az összes titkos kód aktuális verzióit a Contoso nevű kulcstartóban.
2. példa: Egy adott titkos kód összes verziójának lekérése
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 :
Ez a parancs lekéri a titkos kód1 nevű összes verzióját a Contoso nevű kulcstartóban.
3. példa: Adott titkos kód aktuális verziójának lekérése
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 :
Ez a parancs lekéri a Titkos kód1 nevű titkos kód aktuális verzióját a Contoso nevű kulcstartóban.
4. példa: Adott titkos kód adott verziójának lekérése
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 :
Ez a parancs a Titkos kód1 nevű titkos kód egy adott verzióját kapja meg a Contoso nevű kulcstartóban.
5. példa: Egy adott titkos kód aktuális verziójának egyszerű szöveges értékének lekérése
$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText
A parancsmag a titkos kulcsot sztringként adja vissza az alkalmazáskor -AsPlainText
.
Megjegyzés: Ha titkos kulcsokat listáz, azaz nem ad meg -Name
, a rendszer figyelmen kívül hagyja a -AsPlainText
titkos kulcsokat.
6. példa: Szerezze be a kulcstartóhoz törölt, de nem törölt titkos kulcsokat.
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 :
Ez a parancs lekéri az összes olyan titkos kulcsot, amelyet korábban töröltek, de nem töröltek a Contoso nevű kulcstartóban.
7. példa: Lekéri a titkos ITSecretet, amelyet töröltek, de nem töröltek ehhez a kulcstartóhoz.
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 :
Ez a parancs lekéri a korábban törölt, de nem törölt "secret1" titkos kulcsot a Contoso nevű kulcstartóban. Ez a parancs olyan metaadatokat ad vissza, mint a törlés dátuma és a törölt titkos kód ütemezett törlési dátuma.
8. példa: A titkos kulcsok összes jelenlegi verziójának lekérése egy kulcstartóban szűréssel
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 :
Ez a parancs lekéri a Contoso nevű kulcstartó összes titkos kulcsának aktuális verzióit, amelyek a "titkos kóddal" kezdődnek.
9. példa: Titkos kód lekérése az Azure Key Vaultban a Microsoft.PowerShell.SecretManagement modul Get-Secret parancsával
# 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
Ez a példa lekéri az Azure Key Vaultban a secureSecret
modul parancsa Get-Secret
által elnevezett test-kv
titkos Microsoft.PowerShell.SecretManagement
kulcsot.
Paraméterek
-AsPlainText
Ha be van állítva, a parancsmag kimenetként konvertálja a biztonságos sztringben lévő titkos kódot a visszafejtött egyszerű szöveges sztringre.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-DefaultProfile
Az Azure-ral való kommunikációhoz használt hitelesítő adatok, fiók, bérlő és előfizetés
Típus: | IAzureContextContainer |
Aliasok: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-IncludeVersions
Azt jelzi, hogy ez a parancsmag egy titkos kód összes verzióját lekéri. A titkos kódok aktuális verziója az első a listában. Ha ezt a paramétert adja meg, meg kell adnia a Name és a VaultName paramétereket is. Ha nem adja meg az IncludeVersions paramétert, ez a parancsmag lekéri a titkos kód aktuális verzióját a megadott névvel.
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-InputObject
KeyVault objektum.
Típus: | PSKeyVault |
Position: | 0 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-InRemovedState
Megadja, hogy megjelenjenek-e a korábban törölt titkos kulcsok a kimenetben
Típus: | SwitchParameter |
Position: | Named |
Alapértelmezett érték: | None |
Kötelező: | False |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Name
Megadja a lekérni kívánt titkos kód nevét.
Típus: | String |
Aliasok: | SecretName |
Position: | 1 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | True |
-ResourceId
KeyVault erőforrás-azonosító.
Típus: | String |
Position: | 0 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | True |
Helyettesítő karakterek elfogadása: | False |
-VaultName
Annak a kulcstartónak a nevét adja meg, amelyhez a titkos kulcs tartozik. Ez a parancsmag egy kulcstartó teljes tartománynevét (FQDN) hozza létre a paraméter által megadott név és az aktuális környezet alapján.
Típus: | String |
Position: | 0 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
-Version
Megadja a titkos verziót. Ez a parancsmag egy titkos kulcs teljes tartománynevét hozza létre a kulcstartó neve, a jelenleg kijelölt környezet, a titkos kód neve és a titkos verzió alapján.
Típus: | String |
Aliasok: | SecretVersion |
Position: | 2 |
Alapértelmezett érték: | None |
Kötelező: | True |
Folyamatbemenet elfogadása: | False |
Helyettesítő karakterek elfogadása: | False |
Bevitelek
Kimenetek
PSDeletedKeyVaultSecretIdentityItem