Get-AzApiManagementGroup

  • Ссылка
Модуль:
Az.ApiManagement

Возвращает все или определенные группы управления API.

Синтаксис

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

Описание

Командлет Get-AzApiManagementGroup получает все или определенные группы управления API.

Примеры

Пример 1. Получение всех групп

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

Эта команда получает все группы.

Пример 2. Получение группы по идентификатору

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

Эта команда получает идентификатор группы с именем 0123456789.

Пример 3. Получение группы по имени

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

Эта команда получает группу с именем Group0002.

Пример 4. Получение всех групп пользователей

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

Эта команда получает все группы пользователей с идентификатором пользователя с именем 0123456789.

Параметры

-Context

Указывает экземпляр PsApiManagementContext.

Type:PsApiManagementContext
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupId

Указывает идентификатор группы. Если задано, командлет пытается найти группу по идентификатору.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Указывает имя группы управления.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Идентификатор существующего продукта. Если указанный параметр вернет все группы, которым назначен продукт. Это необязательный параметр.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-UserId

Указывает идентификатор существующего продукта. Если этот командлет возвратит все группы, назначенные продукту.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Входные данные

PsApiManagementContext

String

Выходные данные

PsApiManagementGroup