Compartilhar via

Get-AzApiManagementGroup

  • Referência
Módulo:
Az.ApiManagement

Obtém todos os grupos de gerenciamento de API ou grupos de gerenciamento de API específicos.

Sintaxe

Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-GroupId <String>]
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-UserId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementGroup
   -Context <PsApiManagementContext>
   [-Name <String>]
   [-ProductId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

O cmdlet Get-AzApiManagementGroup obtém todos os grupos de gerenciamento de API ou grupos de gerenciamento de API específicos.

Exemplos

Exemplo 1: Obter todos os grupos

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext

Este comando obtém todos os grupos.

Exemplo 2: Obter um grupo por ID

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -GroupId "0123456789"

Esse comando obtém a ID do grupo chamada 0123456789.

Exemplo 3: Obter um grupo por nome

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -Name "Group0002"

Esse comando obtém o grupo chamado Group0002.

Exemplo 4: Obter todos os grupos de usuários

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -UserId "0123456789"

Esse comando obtém todos os grupos de usuários com o ID de usuário chamado 0123456789.

Parâmetros

-Context

Especifica uma instância de PsApiManagementContext.

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

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para 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

-GroupId

Especifica a ID do grupo. Se especificado, o cmdlet tentará localizar o grupo pelo identificador.

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

-Name

Especifica o nome do grupo de gerenciamento.

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

-ProductId

Identificador do produto existente. Se especificado, retornará todos os grupos aos quais o produto foi atribuído. Esse parâmetro é opcional.

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

-UserId

Especifica o identificador do produto existente. Se especificado, o cmdlet retornará todos os grupos aos quais o produto foi atribuído.

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

Entradas

PsApiManagementContext

String

Saídas

PsApiManagementGroup