< Back
New-AzureRmApiManagementGroup
Post
NAME New-AzureRmApiManagementGroup
SYNOPSIS
Creates an API management group.
SYNTAX
New-AzureRmApiManagementGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-ExternalId
<String>] [-GroupId <String>] -Name <String> [-Type <PsApiManagementGroupType>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementGroup cmdlet creates an API management group.
PARAMETERS
-Context <PsApiManagementContext>
Specifies the instance of the PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies the description of the management group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExternalId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GroupId <String>
Specifies the identifier of the new management group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the management group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <PsApiManagementGroupType>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup
NOTES
Example 1: Create a management group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementGroup -Context $apimContext -Name "Group0001"
This command creates a management group.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ementgroup
Get-AzureRmApiManagementGroup
Remove-AzureRmApiManagementGroup
Set-AzureRmApiManagementGroup
SYNOPSIS
Creates an API management group.
SYNTAX
New-AzureRmApiManagementGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Description <String>] [-ExternalId
<String>] [-GroupId <String>] -Name <String> [-Type <PsApiManagementGroupType>] [<CommonParameters>]
DESCRIPTION
The New-AzureRmApiManagementGroup cmdlet creates an API management group.
PARAMETERS
-Context <PsApiManagementContext>
Specifies the instance of the PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies the description of the management group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ExternalId <String>
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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GroupId <String>
Specifies the identifier of the new management group.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the management group name.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Type <PsApiManagementGroupType>
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.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup
NOTES
Example 1: Create a management group
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementGroup -Context $apimContext -Name "Group0001"
This command creates a management group.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ementgroup
Get-AzureRmApiManagementGroup
Remove-AzureRmApiManagementGroup
Set-AzureRmApiManagementGroup