Get-AzKeyVaultManagedHsm

  • Referência
Módulo:
Az.KeyVault

Obtenha HSMs gerenciados.

Sintaxe

Get-AzKeyVaultManagedHsm
   [[-Name] <String>]
   [[-ResourceGroupName] <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVaultManagedHsm
   [-Name] <String>
   [-Location] <String>
   [-InRemovedState]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVaultManagedHsm
   [-InRemovedState]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Description

O cmdlet Get-AzKeyVaultManagedHsm obtém informações sobre os HSMs gerenciados em uma assinatura. Você pode exibir todas as instâncias de HSMs gerenciados em uma assinatura ou filtrar seus resultados por um grupo de recursos ou um HSM gerenciado específico. Observe que, embora a especificação do grupo de recursos seja opcional para esse cmdlet quando você obtém um único HSM gerenciado, você deve fazer isso para obter um melhor desempenho.

Exemplos

Exemplo 1: Obter todos os HSMs gerenciados em sua assinatura atual

Get-AzKeyVaultManagedHsm

Name    Resource Group Name Location SKU        ProvisioningState Security Domain ActivationStatus
----    ------------------- -------- ---        ----------------- --------------------------------
myhsm   test-rg              eastus   StandardB1 Succeeded         Active

Esse comando obtém todos os HSMs gerenciados em sua assinatura atual.

Exemplo 2: Obter um HSM gerenciado específico

Get-AzKeyVaultManagedHsm -Name 'myhsm'

Name    Resource Group Name Location SKU        ProvisioningState Security Domain ActivationStatus
----    ------------------- -------- ---        ----------------- --------------------------------
myhsm   test-rg              eastus   StandardB1 Succeeded         Active

Esse comando obtém o HSM gerenciado chamado myhsm em sua assinatura atual.

Exemplo 3: Obter HSMs gerenciados em um grupo de recursos

Get-AzKeyVaultManagedHsm -ResourceGroupName 'myrg1'

Name  Resource Group Name Location    SKU        ProvisioningState Security Domain ActivationStatus
----  ------------------- --------    ---        ----------------- --------------------------------
myhsm myrg1               eastus2euap StandardB1 Succeeded         Active

Esse comando obtém todos os HSMs gerenciados no grupo de recursos chamado myrg1.

Exemplo 4: Obter HSMs gerenciados usando filtragem

Get-AzKeyVaultManagedHsm -Name 'myhsm*'

Name  Resource Group Name Location    SKU        ProvisioningState Security Domain ActivationStatus
----  ------------------- --------    ---        ----------------- --------------------------------
myhsm myrg1               eastus2euap StandardB1 Succeeded         Active

Esse comando obtém todos os HSMs gerenciados na assinatura que começam com "myhsm".

Exemplo 5: Listar HSMs gerenciados excluídos

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

Esse comando obtém todos os HSMs gerenciados excluídos na assinatura atual.

Parâmetros

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-InRemovedState

Especifica se o pool de HSM gerenciado excluído anteriormente deve ser mostrado na saída.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Location

O local do pool de HSM gerenciado excluído.

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Nome do HSM. O cmdlet constrói o FQDN de um HSM com base no nome e no ambiente selecionado no momento.

Tipo:String
Aliases:HsmName
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-ResourceGroupName

Especifica o nome do grupo de recursos associado ao HSM gerenciado que está sendo consultado.

Tipo:String
Cargo:1
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-SubscriptionId

A ID da assinatura. Por padrão, os cmdlets são executados na assinatura definida no contexto atual. Se o usuário especificar outra assinatura, o cmdlet atual será executado na assinatura especificada pelo usuário. As assinaturas de substituição só entram em vigor durante o ciclo de vida do cmdlet atual. Ele não altera a assinatura no contexto e não afeta os cmdlets subsequentes.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Tag

Especifica a chave e o valor opcional da marca especificada pela qual filtrar a lista de HSMs gerenciados.

Tipo:Hashtable
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

Entradas

String

Hashtable

Saídas

PSManagedHsm

PSDeletedManagedHsm

PSKeyVaultIdentityItem