Skip to content

Latest commit

 

History

History
210 lines (160 loc) · 6.15 KB

Get-AzKeyVaultSetting.md

File metadata and controls

210 lines (160 loc) · 6.15 KB
Raw
external help file Module Name online version schema
Microsoft.Azure.PowerShell.Cmdlets.KeyVault.dll-Help.xml
Az.KeyVault
2.0.0

Get-AzKeyVaultSetting

SYNOPSIS

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

SYNTAX

GetSettingViaFlattenParameters (Default)

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

GetSettingViaHsmObject

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

GetSettingViaHsmId

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: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HsmId

Hsm Resource Id.

Type: System.String
Parameter Sets: GetSettingViaHsmId
Aliases:

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

-HsmName

Name of the HSM.

Type: System.String
Parameter Sets: GetSettingViaFlattenParameters
Aliases:

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

-HsmObject

Hsm Object.

Type: Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm
Parameter Sets: GetSettingViaHsmObject
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Name of the setting.

Type: System.String
Parameter Sets: (All)
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.Commands.KeyVault.Models.PSManagedHsm

OUTPUTS

Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSetting

NOTES

RELATED LINKS

Update-AzKeyVaultSetting