az keyvault setting

Manage MHSM settings.

Commands

Name	Description	Type	Status
az keyvault setting list	Get all settings associated with the managed HSM.	Core	GA
az keyvault setting show	Get specific setting associated with the managed HSM.	Core	GA
az keyvault setting update	Update specific setting associated with the managed HSM.	Core	GA

az keyvault setting list

Edit

Get all settings associated with the managed HSM.

az keyvault setting list [--hsm-name]
                         [--id]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Name of the HSM.

Property	Value
Parameter group:	Id Arguments

--id

Full URI of the HSM. If specified all other 'Id' arguments should be omitted.

Property	Value
Parameter group:	Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az keyvault setting show

Edit

Get specific setting associated with the managed HSM.

az keyvault setting show --name
                         [--hsm-name]
                         [--id]

Examples

Add "AllowKeyManagementOperationsThroughARM" setting of the managed HSM.

az keyvault setting show --name AllowKeyManagementOperationsThroughARM --hsm-name myhsm

Required Parameters

--name -n

Name of the setting.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Name of the HSM.

Property	Value
Parameter group:	Id Arguments

--id

Full URI of the HSM. If specified all other 'Id' arguments should be omitted.

Property	Value
Parameter group:	Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az keyvault setting update

Edit

Update specific setting associated with the managed HSM.

az keyvault setting update --name
                           --value
                           [--hsm-name]
                           [--id]
                           [--setting-type --type {boolean, string}]

Examples

Allow key management operations through ARM for the managed HSM.

az keyvault setting update --name AllowKeyManagementOperationsThroughARM --value true --type boolean --hsm-name myhsm

Required Parameters

--name -n

Name of the setting.

--value

Value of the setting.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--hsm-name

Name of the HSM.

Property	Value
Parameter group:	Id Arguments

--id

Full URI of the HSM. If specified all other 'Id' arguments should be omitted.

Property	Value
Parameter group:	Id Arguments

--setting-type --type

Type of the setting value.

Property	Value
Accepted values:	boolean, string

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?