GroupContractInner Class

public final class GroupContractInner
extends ProxyResource

Contract details.

Constructor Summary

Constructor Description
GroupContractInner()

Creates an instance of GroupContractInner class.

Method Summary

Modifier and Type Method and Description
Boolean builtIn()

Get the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

String description()

Get the description property: Group description.

String displayName()

Get the displayName property: Group name.

String externalId()

Get the externalId property: For external groups, this property contains the id of the group from the external identity provider, e.g.

GroupType typePropertiesType()

Get the type property: Group type.

void validate()

Validates the instance.

GroupContractInner withDescription(String description)

Set the description property: Group description.

GroupContractInner withDisplayName(String displayName)

Set the displayName property: Group name.

GroupContractInner withExternalId(String externalId)

Set the externalId property: For external groups, this property contains the id of the group from the external identity provider, e.g.

GroupContractInner withTypePropertiesType(GroupType type)

Set the type property: Group type.

Methods inherited from ProxyResource

Methods inherited from java.lang.Object

Constructor Details

GroupContractInner

public GroupContractInner()

Creates an instance of GroupContractInner class.

Method Details

builtIn

public Boolean builtIn()

Get the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.

Returns:

the builtIn value.

description

public String description()

Get the description property: Group description. Can contain HTML formatting tags.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: Group name.

Returns:

the displayName value.

externalId

public String externalId()

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

Returns:

the externalId value.

typePropertiesType

public GroupType typePropertiesType()

Get the type property: Group type.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withDescription

public GroupContractInner withDescription(String description)

Set the description property: Group description. Can contain HTML formatting tags.

Parameters:

description - the description value to set.

Returns:

the GroupContractInner object itself.

withDisplayName

public GroupContractInner withDisplayName(String displayName)

Set the displayName property: Group name.

Parameters:

displayName - the displayName value to set.

Returns:

the GroupContractInner object itself.

withExternalId

public GroupContractInner withExternalId(String externalId)

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

Parameters:

externalId - the externalId value to set.

Returns:

the GroupContractInner object itself.

withTypePropertiesType

public GroupContractInner withTypePropertiesType(GroupType type)

Set the type property: Group type.

Parameters:

type - the type value to set.

Returns:

the GroupContractInner object itself.

Applies to