Set-AzureRmApiManagementGroup

NAME Set-AzureRmApiManagementGroup



SYNOPSIS

Configures an API management group.





SYNTAX

Set-AzureRmApiManagementGroup -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Description <String>] -GroupId

<String> [-Name <String>] [-PassThru] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmApiManagementGroup cmdlet configures an API management group.





PARAMETERS

-Context <PsApiManagementContext>

Specifies an instance of a 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



-GroupId <String>

Specifies the identifier of the management group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String>

Specifies the name of the management group.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

passthru



Required? false

Position? named

Default value False

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: Configure a management group



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Set-AzureRmApiManagementGroup -Context $apimContext -Description "Updated Management Group" -Name "Group0001"



This command configures a management group named Group0001.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... ementgroup

Get-AzureRmApiManagementGroup

New-AzureRmApiManagementGroup

Remove-AzureRmApiManagementGroup