Edit

Share via

Add-AzApiManagementProductToGroup

  • Reference
Module:
Az.ApiManagement

Adds a product to a group.

Syntax

Add-AzApiManagementProductToGroup
   -Context <PsApiManagementContext>
   -GroupId <String>
   -ProductId <String>
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Add-AzApiManagementProductToGroup cmdlet adds a product to an existing group. In other words, this cmdlet assigns a group to a product.

Examples

Example 1: Add a product to a group

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Add-AzApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"

This command adds a product to an existing group.

Parameters

-Context

Specifies a PsApiManagementContext object. This parameter is required.

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. This parameter is required.

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

-PassThru

passthru

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

-ProductId

Specifies the product ID. This parameter is required.

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

Inputs

PsApiManagementContext

String

SwitchParameter

Outputs

Boolean