GroupContract interface

Package:

@azure/arm-apimanagement

Contract details.

Extends

ProxyResource

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.
typePropertiesType	Group type.

Inherited Properties

id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name	The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

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

typePropertiesType

Group type.

typePropertiesType?: GroupType

Property Value

GroupType

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type