Get-AzKeyVaultManagedHsm
Get managed HSMs.
语法
GetManagedHsm （默认值）
Get-AzKeyVaultManagedHsm
[[-Name] <String>]
[[-ResourceGroupName] <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<CommonParameters>]
GetDeletedManagedHsm
Get-AzKeyVaultManagedHsm
[-Name] <String>
[-Location] <String>
[-InRemovedState]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<CommonParameters>]
ListDeletedManagedHsms
Get-AzKeyVaultManagedHsm
[-InRemovedState]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-SubscriptionId <String>]
[<CommonParameters>]
说明
The Get-AzKeyVaultManagedHsm cmdlet gets information about the managed HSMs in a subscription. You can view all managed HSMs instances in a subscription, or filter your results by a resource group or a particular managed HSM. Note that although specifying the resource group is optional for this cmdlet when you get a single managed HSM, you should do so for better performance.
示例
Example 1: Get all managed HSMs in your current subscription
Get-AzKeyVaultManagedHsm
Name Resource Group Name Location SKU ProvisioningState Security Domain ActivationStatus
---- ------------------- -------- --- ----------------- --------------------------------
myhsm test-rg eastus StandardB1 Succeeded Active
This command gets all managed HSMs in your current subscription.
Example 2: Get a specific managed HSM
Get-AzKeyVaultManagedHsm -Name 'myhsm'
Name Resource Group Name Location SKU ProvisioningState Security Domain ActivationStatus
---- ------------------- -------- --- ----------------- --------------------------------
myhsm test-rg eastus StandardB1 Succeeded Active
This command gets the managed HSM named myhsm in your current subscription.
Example 3: Get managed HSMs in a resource group
Get-AzKeyVaultManagedHsm -ResourceGroupName 'myrg1'
Name Resource Group Name Location SKU ProvisioningState Security Domain ActivationStatus
---- ------------------- -------- --- ----------------- --------------------------------
myhsm myrg1 eastus2euap StandardB1 Succeeded Active
This command gets all managed HSMs in the resource group named myrg1.
Example 4: Get managed HSMs using filtering
Get-AzKeyVaultManagedHsm -Name 'myhsm*'
Name Resource Group Name Location SKU ProvisioningState Security Domain ActivationStatus
---- ------------------- -------- --- ----------------- --------------------------------
myhsm myrg1 eastus2euap StandardB1 Succeeded Active
This command gets all managed HSMs in the subscription that start with "myhsm".
Example 5: List deleted managed HSMs
Get-AzKeyVaultManagedHsm -InRemovedState
Name Location DeletionDate ScheduledPurgeDate Purge Protection Enabled?
---- -------- ------------ ------------------ -------------------------
xxxxxxxx-mhsm-4op2n2g4xe eastus2 12/30/2021 2:29:00 AM 3/30/2022 2:29:00 AM True
xxxxxxx-mhsm-ertopo7tnxa westus 12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM True
xxxxxxx-mhsm-gg66fgctz67 westus 12/29/2021 11:48:42 PM 3/29/2022 11:48:42 PM False
xxxxxxx-mhsm-2m5jiop6mfo westcentralus 12/30/2021 12:26:14 AM 3/30/2022 12:26:14 AM True
This command gets all deleted managed HSMs in current subscription.
参数
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
参数属性
| 类型: | IAzureContextContainer |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | AzContext, AzureRmContext, AzureCredential |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-InRemovedState
Specifies whether to show the previously deleted managed HSM pool in the output.
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
GetDeletedManagedHsm
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
ListDeletedManagedHsms
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Location
The location of the deleted managed HSM pool.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
GetDeletedManagedHsm
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Name
HSM name. Cmdlet constructs the FQDN of a HSM based on the name and currently selected environment.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
| 别名: | HsmName |
参数集
GetManagedHsm
| Position: | 0 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-ResourceGroupName
Specifies the name of the resource group associated with the managed HSM being queried.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
GetManagedHsm
| Position: | 1 |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-SubscriptionId
The ID of the subscription. By default, cmdlets are executed in the subscription that is set in the current context. If the user specifies another subscription, the current cmdlet is executed in the subscription specified by the user. Overriding subscriptions only take effect during the lifecycle of the current cmdlet. It does not change the subscription in the context, and does not affect subsequent cmdlets.
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
-Tag
Specifies the key and optional value of the specified tag to filter the list of managed HSMs by.
参数属性
| 类型: | Hashtable |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | True |
| 来自剩余参数的值: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
