GroupContractProperties interface

Package:

@azure/arm-apimanagement

Group contract Properties.

Properties

builtIn	true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.
description	Group description. Can contain HTML formatting tags.
displayName	Group name.
externalId	For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.
type	Group type.

Property Details

builtIn

true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. NOTE: This property will not be serialized. It can only be populated by the server.

builtIn?: boolean

Property Value

boolean

description

Group description. Can contain HTML formatting tags.

description?: string

Property Value

string

displayName

Group name.

displayName: string

Property Value

string

externalId

For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

externalId?: string

Property Value

string

type

Group type.

type?: GroupType

Property Value

GroupType