Get-AzKeyVaultSetting

  • 參考
模組:
Az.KeyVault

擷取可設定的指定金鑰保存庫帳戶設定或所有可用的金鑰保存庫帳戶設定。

Syntax

Get-AzKeyVaultSetting
   [-DefaultProfile <IAzureContextContainer>]
   [-HsmName] <String>
   [[-Name] <String>]
   [<CommonParameters>]
Get-AzKeyVaultSetting
   [-DefaultProfile <IAzureContextContainer>]
   [-HsmObject] <PSManagedHsm>
   [[-Name] <String>]
   [<CommonParameters>]
Get-AzKeyVaultSetting
   [-DefaultProfile <IAzureContextContainer>]
   [-HsmId] <String>
   [[-Name] <String>]
   [<CommonParameters>]

Description

Get-AzKeyVaultSetting Cmdlet 會取得密鑰保存庫帳戶設定。 此 Cmdlet 會取得特定的金鑰保存庫帳戶設定或所有密鑰保存庫帳戶設定。

範例

範例 1：取得受控 HSM 中的所有帳戶設定

Get-AzKeyVaultSetting -HsmName testmhsm

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會取得受控 HSM 中名為 testmhsm的所有帳戶設定。

範例 2：在受控 HSM 中取得特定的金鑰保存庫帳戶設定

Get-AzKeyVaultSetting -HsmName testmhsm -Name AllowKeyManagementOperationsThroughARM

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會在名為 testmhsm的受控 HSM 中取得名為 AllowKeyManagementOperationsThroughARM 的特定密鑰保存庫帳戶設定。

範例 3：透過 HsmObject 取得受控 HSM 中的特定密鑰保存庫帳戶設定

$hsmObject = Get-AzKeyVaultManagedHsm -Name testmhsm
Get-AzKeyVaultSetting -HsmObject $hsmObject -Name AllowKeyManagementOperationsThroughARM

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會透過 HsmObject 取得受控 HSM 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定金鑰保存庫帳戶設定。

範例 4：透過管線 HsmObject 取得受控 HSM 中的特定密鑰保存庫帳戶設定

Get-AzKeyVaultManagedHsm -Name testmhsm | Get-AzKeyVaultSetting -Name AllowKeyManagementOperationsThroughARM

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會透過 HsmObject 取得受控 HSM 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定金鑰保存庫帳戶設定。

範例 4：透過管線 HsmObject 取得受控 HSM 中的特定密鑰保存庫帳戶設定

Get-AzKeyVaultManagedHsm -Name testmhsm | Get-AzKeyVaultSetting -Name AllowKeyManagementOperationsThroughARM

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會取得以管線 HsmObject 命名的受控 HSM 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定密鑰保存庫帳戶設定。

範例 5：透過 HsmId 取得受控 HSM 中的特定金鑰保存庫帳戶設定

Get-AzKeyVaultSetting -HsmId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/managedHSMs/testmhsm -Name AllowKeyManagementOperationsThroughARM

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM false boolean testmhsm

此 Cmdlet 會透過 HsmId 取得受控 HSM 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定密鑰保存庫帳戶設定。

參數

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HsmId

Hsm 資源標識碼。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HsmName

HSM 的名稱。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HsmObject

Hsm 物件。

Type:PSManagedHsm
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

設定的名稱。

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

PSManagedHsm

輸出

PSKeyVaultSetting