Get-AzKeyVaultSetting
Retrieves a specified key vault account setting or all available key vault account settings that can be configured.
Syntax
GetSettingViaFlattenParameters (Default)
Get-AzKeyVaultSetting
[-HsmName] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetSettingViaHsmObject
Get-AzKeyVaultSetting
[-HsmObject] <PSManagedHsm>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetSettingViaHsmId
Get-AzKeyVaultSetting
[-HsmId] <String>
[[-Name] <String>]
[-DefaultProfile <IAzureContextContainer>]
[<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.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HsmId
Hsm Resource Id.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetSettingViaHsmId
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HsmName
Name of the HSM.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetSettingViaFlattenParameters
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HsmObject
Hsm Object.
Parameter properties
| Type: | PSManagedHsm |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetSettingViaHsmObject
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Name of the setting.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
