az dedicated-hsm

Dedicated-hsm to create, update, list, show, and delete HSMs.

Commands

az dedicated-hsm create

Create a dedicated HSM in the specified subscription.

az dedicated-hsm delete

Deletes the specified Azure Dedicated HSM.

az dedicated-hsm list

The List operation gets information about the dedicated HSMs associated with the subscription.

az dedicated-hsm show

Gets the specified Azure dedicated HSM.

az dedicated-hsm update

Update a dedicated HSM in the specified subscription.

az dedicated-hsm wait

Waits for operation to complete.

az dedicated-hsm create

Create a dedicated HSM in the specified subscription.

az dedicated-hsm create --location
                        --name
                        --resource-group
                        [--network-profile-network-interfaces]
                        [--no-wait]
                        [--sku]
                        [--stamp-id]
                        [--subnet]
                        [--tags]
                        [--zones]

Examples

Create a new dedicated HSM

az dedicated-hsm create -n "hsm1" -l "japanwest" -i private-ip-address="1.0.0.1" -s id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.Network/virtualNetworks/hsm/subnets/hsm" --stamp-id "stamp1" --sku name="SafeNet Luna Network HSM A790" --tags Dept="hsm" Environment="dogfood" -g "hsm-group"

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

Name of the dedicated Hsm.

--resource-group -g

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

Optional Parameters

--network-profile-network-interfaces -i

Specifies a list of ip address from the specfied subnet for the network interfaces associated with the dedicated HSM. Expected value: -i private-ip-address=xx.

--no-wait

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

--sku

The HSM device SKU if a non-standard HSM is wanted (default is: SafeNet Luna Network HSM A790).

--stamp-id

This field will be used when RP does not support Availability zones.

--subnet -s

Specifies the identifier of the subnet. Expected value: id=xx.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--zones

The Dedicated Hsm zones.

az dedicated-hsm delete

Deletes the specified Azure Dedicated HSM.

az dedicated-hsm delete --name
                        --resource-group
                        [--no-wait]
                        [--yes]

Examples

Delete a dedicated HSM

az dedicated-hsm delete -n "hsm1" -g "hsm-group"

Required Parameters

--name -n

The name of the dedicated HSM to delete.

--resource-group -g

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

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

az dedicated-hsm list

The List operation gets information about the dedicated HSMs associated with the subscription.

az dedicated-hsm list [--resource-group]
                      [--top]

Examples

List dedicated HSM devices in a subscription

az dedicated-hsm list

Optional Parameters

--resource-group -g

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

--top

Maximum number of results to return.

az dedicated-hsm show

Gets the specified Azure dedicated HSM.

az dedicated-hsm show --name
                      --resource-group

Examples

Get a dedicated HSM

az dedicated-hsm show -n "hsm1" -g "hsm-group"

Required Parameters

--name -n

The name of the dedicated HSM.

--resource-group -g

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

az dedicated-hsm update

Update a dedicated HSM in the specified subscription.

az dedicated-hsm update --name
                        --resource-group
                        [--no-wait]
                        [--tags]

Examples

Update an existing dedicated HSM

az dedicated-hsm update -n "hsm1" --tags Dept="hsm" Environment="dogfood" Slice="A" -g "hsm-group"

Required Parameters

--name -n

Name of the dedicated HSM.

--resource-group -g

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

Optional Parameters

--no-wait

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

az dedicated-hsm wait

Waits for operation to complete.

az dedicated-hsm wait --name
                      --resource-group
                      [--created]
                      [--custom]
                      [--deleted]
                      [--exists]
                      [--interval]
                      [--timeout]
                      [--updated]

Examples

Delete a dedicated HSM

az dedicated-hsm wait --created -g "hsm-group" --name "hsm1"

Required Parameters

--name

The name of the dedicated HSM.

--resource-group -g

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.