Get-AzApiManagementGroup
Gets all or specific API management groups.
Syntax
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
The Get-AzApiManagementGroup cmdlet gets all or specific API management groups.
Examples
Example 1: Get all groups
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext
This command gets all groups.
Example 2: Get a group by ID
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -GroupId "0123456789"
This command gets the group ID named 0123456789.
Example 3: Get a group by name
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -Name "Group0002"
This command gets the group named Group0002.
Example 4: Get all user groups
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementGroup -Context $apimContext -UserId "0123456789"
This command gets all user groups with the user ID named 0123456789.
Parameters
-Context
Specifies an instance of PsApiManagementContext.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupId
Specifies the group ID. If specified, the cmdlet attempts to find the group by the identifier.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the management group.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductId
Identifier of existing product. If specified will return all groups the product assigned to. This parameter is optional.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserId
Specifies the identifier of existing product. If specified the cmdlet will return all groups the product assigned to.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |