你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Get-AzKeyVaultSecret
获取密钥保管库中的机密。
语法
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>]
说明
Get-AzKeyVaultSecret cmdlet 获取密钥保管库中的机密。 此 cmdlet 获取特定机密或密钥保管库中的所有机密。
示例
示例 1:获取密钥保管库中所有机密的所有当前版本
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 :
此命令获取名为 Contoso 的密钥保管库中所有机密的当前版本。
示例 2:获取特定机密的所有版本
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 :
此命令获取名为 Contoso 的密钥保管库中名为 secret1 的所有版本。
示例 3:获取特定机密的当前版本
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 :
此命令获取名为 Contoso 的密钥保管库中名为 secret1 的当前版本。
示例 4:获取特定机密的特定版本
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 :
此命令获取名为 Contoso 的密钥保管库中名为 secret1 的特定版本。
示例 5:获取特定机密的当前版本的纯文本值
$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText
应用时 -AsPlainText
,该 cmdlet 将机密作为字符串返回。
注意: 列出机密时,即未提供 -Name
机密, -AsPlainText
将忽略该机密。
示例 6:获取已删除但未清除此密钥保管库的所有机密。
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 :
此命令在名为 Contoso 的密钥保管库中获取以前删除但未清除的所有机密。
示例 7:获取已删除但未清除此密钥保管库的机密 ITSecret。
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 :
此命令在名为 Contoso 的密钥保管库中获取以前删除但未清除的机密“secret1”。 此命令将返回元数据,例如删除日期,以及此已删除机密的计划清除日期。
示例 8:使用筛选获取密钥保管库中所有机密的所有当前版本
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 :
此命令获取以“机密”开头的密钥保管库中所有机密的当前版本。
示例 9:在模块 Microsoft.PowerShell.SecretManagement 中通过命令 Get-Secret 获取 Azure 密钥库 中的机密
# 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
此示例获取模块中命令Get-Secret
命名的 Azure 密钥库中命名secureSecret
test-kv
的Microsoft.PowerShell.SecretManagement
机密。
参数
-AsPlainText
设置后,cmdlet 会将安全字符串中的机密转换为已解密的纯文本字符串作为输出。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-DefaultProfile
用于与 azure 通信的凭据、帐户、租户和订阅
类型: | IAzureContextContainer |
别名: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-IncludeVersions
指示此 cmdlet 获取机密的所有版本。 机密的当前版本是列表中的第一个机密版本。 如果指定此参数,还必须指定 Name 和 VaultName 参数。 如果未指定 IncludeVersions 参数,此 cmdlet 将获取具有指定 名称的机密的当前版本。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-InputObject
KeyVault 对象。
类型: | PSKeyVault |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-InRemovedState
指定是否在输出中显示以前删除的机密
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Name
指定要获取的机密的名称。
类型: | String |
别名: | SecretName |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | True |
-ResourceId
KeyVault 资源 ID。
类型: | String |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-VaultName
指定机密所属的密钥保管库的名称。 此 cmdlet 基于此参数指定的名称和当前环境构造密钥保管库的完全限定域名(FQDN)。
类型: | String |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Version
指定机密版本。 此 cmdlet 基于密钥保管库名称、当前所选环境、机密名称和机密版本构造机密的 FQDN。
类型: | String |
别名: | SecretVersion |
Position: | 2 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
输入
输出
PSDeletedKeyVaultSecretIdentityItem