Share via

az cloudhsm

Note

This reference is part of the cloudhsm extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az cloudhsm command. Learn more about extensions.

Manage Cloud Hsm Cluster.

Commands

Name Description Type Status
az cloudhsm backup

Manage Cloud HSM Backup.

 Extension GA
az cloudhsm backup start

Begin a backup of the Cloud HSM.

 Extension GA
az cloudhsm create

Create a Cloud HSM.

 Extension GA
az cloudhsm delete

Delete a Cloud HSM.

 Extension GA
az cloudhsm list

List Cloud HSMs.

 Extension GA
az cloudhsm restore

Restore a backup of a Cloud HSM.

 Extension GA
az cloudhsm restore start

Restore a backup of a Cloud HSM.

 Extension GA
az cloudhsm show

Show details of a Cloud HSM.

 Extension GA
az cloudhsm update

Update the properties of a Cloud HSM.

 Extension GA

az cloudhsm create

Create a Cloud HSM.

az cloudhsm create --name
                   --resource-group
                   [--domain-label-scope --domain-name-label-scope {NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse}]
                   [--location]
                   [--mi-user-assigned]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--sku {Standard B10, Standard_B1}]
                   [--tags]

Examples

Create Cloud HSM with user assigned managed identity

az cloudhsm create --resource-group rgcloudhsm --name chsm1 --location eastus2 --sku Standard_B1 --tags Department=Accounting --domain-name-label-scope "TenantReuse" --mi-user-assigned /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgcloudhsm /providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity

Required Parameters

--name -n

The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

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

--domain-label-scope --domain-name-label-scope

The Cloud HSM Cluster's auto-generated Domain Name Label Scope.

Property Value
Parameter group: Properties Arguments
Accepted values: NoReuse, ResourceGroupReuse, SubscriptionReuse, TenantReuse
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property Value
Parameter group: Body Arguments
--mi-user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--sku

Sku name of the Cloud HSM Cluster.

Property Value
Parameter group: Sku Arguments
Default value: Standard_B1
Accepted values: Standard B10, Standard_B1
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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 cloudhsm delete

Delete a Cloud HSM.

az cloudhsm delete [--ids]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--yes]

Examples

Delete a Cloud HSM

az cloudhsm delete --resource-group rgcloudhsm --name chsm1

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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.

--verbose

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

Property Value
Default value: False

az cloudhsm list

List Cloud HSMs.

az cloudhsm list [--max-items]
                 [--next-token]
                 [--resource-group]

Examples

Show all cloud HSMs in the selected subscription

az cloudhsm list
az cloudhsm list --subscription subId

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

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 cloudhsm show

Show details of a Cloud HSM.

az cloudhsm show [--ids]
                 [--name]
                 [--resource-group]
                 [--subscription]

Examples

Show details of a Cloud HSM.

az cloudhsm show --resource-group rgcloudhsm --name chsm1

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource 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.

--verbose

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

Property Value
Default value: False

az cloudhsm update

Update the properties of a Cloud HSM.

az cloudhsm update [--ids]
                   [--mi-user-assigned]
                   [--name]
                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                   [--resource-group]
                   [--subscription]
                   [--tags]

Examples

Update the properties of a Cloud HSM

az cloudhsm update --name chsm1 --resource-group myrg --tags Department=Accounting

Optional Parameters

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--mi-user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Identity Arguments
--name -n

The name of the Cloud HSM Cluster within the specified resource group. Cloud HSM Cluster names must be between 3 and 23 characters in length.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--tags

The Cloud HSM Cluster's tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Body 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.

--verbose

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

Property Value
Default value: False