Partilhar via


Get-AzKeyVaultManagedHsm

Obtenha HSMs gerenciados.

Sintaxe

GetManagedHsm (Predefinição)

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>]

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 gerenciadas 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 fazê-lo para obter um melhor desempenho.

Exemplos

Exemplo 1: Obtenha 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

Este 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

Este 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

Este 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

Este 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

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

Parâmetros

-DefaultProfile

As credenciais, conta, inquilino e subscrição usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:IAzureContextContainer
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-InRemovedState

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

GetDeletedManagedHsm
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
ListDeletedManagedHsms
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Location

O local do pool de HSM gerenciado excluído.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

GetDeletedManagedHsm
Position:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Name

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:True
NãoMostrar:False
Aliases:HsmName

Conjuntos de parâmetros

GetManagedHsm
Position:0
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-ResourceGroupName

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

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

GetManagedHsm
Position:1
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-SubscriptionId

O 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. A substituição de assinaturas só entra em vigor durante o ciclo de vida do cmdlet atual. Ele não altera a assinatura no contexto e não afeta cmdlets subsequentes.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Tag

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

Propriedades dos parâmetros

Tipo:Hashtable
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Hashtable

Saídas

PSManagedHsm

PSDeletedManagedHsm

PSKeyVaultIdentityItem