Get-AzDedicatedHsm
Gets the specified Azure dedicated HSM.
Syntax
Get-AzDedicatedHsm
[-SubscriptionId <String[]>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDedicatedHsm
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDedicatedHsm
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzDedicatedHsm
-InputObject <IDedicatedHsmIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Gets the specified Azure dedicated HSM.
Examples
Example 1: Get all Dedicated HSM under a subscription
Get-AzDedicatedHsm
Name Provisioning State SKU Location
---- ------------------ --- --------
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastus
yeminghsm Succeeded SafeNet Luna Network HSM A790 eastusThis command gets all Dedicated HSM under a subscription
Example 2: Get all Dedicated HSM under a resource group.
Get-AzDedicatedHsm -ResourceGroupName dedicatedhsm-rg-n359cz
Name Provisioning State SKU Location
---- ------------------ --- --------
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastusThis command gets all Dedicated HSM under a resource group.
Example 3: Get a Dedicated HSM by name
Get-AzDedicatedHsm -Name hsm-7t2xaf -ResourceGroupName dedicatedhsm-rg-n359cz
Name Provisioning State SKU Location
---- ------------------ --- --------
hsm-7t2xaf Succeeded SafeNet Luna Network HSM A790 eastusThis command gets a Dedicated HSM by name.
Example 4: Get a Dedicated HSM by object
$hsm = New-AzDedicatedHsm -Name hsm-n7wfxi -ResourceGroupName dedicatedhsm-rg-n359cz -Location eastus -Sku "SafeNet Luna Network HSM A790" -StampId stamp1 -SubnetId "/subscriptions/xxxx-xxxx-xxx-xxx/resourceGroups/dedicatedhsm-rg-n359cz/providers/Microsoft.Network/virtualNetworks/vnetq30la9/subnets/hsmsubnet" -NetworkInterface @{PrivateIPAddress = '10.2.1.120' }
Get-AzDedicatedHsm -InputObject $hsm
Name Provisioning State SKU Location
---- ------------------ --- --------
hsm-n7wfxi Succeeded SafeNet Luna Network HSM A790 eastusThis command gets a Dedicated HSM by object.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IDedicatedHsmIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the dedicated HSM.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the Resource Group to which the dedicated hsm belongs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Top
Maximum number of results to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
