New-​Azure​Rm​Api​Management​Group

Creates an API management group.

Syntax

New-AzureRmApiManagementGroup
   -Context <PsApiManagementContext>
   [-Description <String>]
   [-ExternalId <String>]
   [-GroupId <String>]
   -Name <String>
   [-Type <PsApiManagementGroupType>]
   [<CommonParameters>]

Description

The New-AzureRmApiManagementGroup cmdlet creates an API management group.

Examples

Example 1: Create a management group

PS C:\>New-AzureRmApiManagementGroup -Context $APImContext -Name "Group0001"

This command creates a management group.

Required Parameters

-Context

Specifies the instance of the PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Name

Specifies the management group name.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-Description

Specifies the description of the management group.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ExternalId

For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; otherwise the value is null.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GroupId

Specifies the identifier of the new management group.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Type

Group Type. Custom Group is User defined Group. System Group includes Administrator, Developers and Guests. You cannot create or update a System Group. External Group is groups from External Identity Provider like Azure Active Directory. This parameter is optional and by default assumed to be a Custom Group.

Type:PsApiManagementGroupType
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Outputs

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup