Edit

Get-AzKeyVaultSetting

  • Reference
Module:
Az.KeyVault

Retrieves a specified key vault account setting or all available key vault account settings that can be configured.

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

The Get-AzKeyVaultSetting cmdlet gets key vault account settings. This cmdlet gets a specific key vault account setting or all key vault account settings.

Examples

Example 1: Get all account settings in a Managed HSM

Get-AzKeyVaultSetting -HsmName testmhsm

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

This cmdlet gets all account settings in a Managed HSM named testmhsm.

Example 2: Get a specific key vault account setting in a Managed HSM

Get-AzKeyVaultSetting -HsmName testmhsm -Name AllowKeyManagementOperationsThroughARM

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

This cmdlet gets a specific key vault account setting named AllowKeyManagementOperationsThroughARM in a Managed HSM named testmhsm.

Example 3: Get a specific key vault account setting in a Managed HSM via HsmObject

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

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

This cmdlet gets a specific key vault account setting named AllowKeyManagementOperationsThroughARM in a Managed HSM named testmhsm via HsmObject.

Example 4: Get a specific key vault account setting in a Managed HSM by piping HsmObject

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

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

This cmdlet gets a specific key vault account setting named AllowKeyManagementOperationsThroughARM in a Managed HSM named testmhsm via HsmObject.

Example 4: Get a specific key vault account setting in a Managed HSM by piping HsmObject

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

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

This cmdlet gets a specific key vault account setting named AllowKeyManagementOperationsThroughARM in a Managed HSM named testmhsm by piping HsmObject.

Example 5: Get a specific key vault account setting in a Managed HSM via HsmId

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

This cmdlet gets a specific key vault account setting named AllowKeyManagementOperationsThroughARM in a Managed HSM named testmhsm via HsmId.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

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

-HsmId

Hsm Resource Id.

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

-HsmName

Name of the HSM.

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

-HsmObject

Hsm Object.

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

-Name

Name of the setting.

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

Inputs

PSManagedHsm

Outputs

PSKeyVaultSetting