Package com.azure.resourcemanager.apimanagement.models

Interface GroupContract

public interface GroupContract

An immutable client-side representation of GroupContract.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GroupContract.Definition	The entirety of the GroupContract definition.
static interface	GroupContract.DefinitionStages	The GroupContract definition stages.
static interface	GroupContract.Update	The template for GroupContract update.
static interface	GroupContract.UpdateStages	The GroupContract update stages.

Method Summary

Modifier and Type	Method	Description
Boolean	builtIn()	Gets the builtIn property: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
String	description()	Gets the description property: Group description.
String	displayName()	Gets the displayName property: Group name.
String	externalId()	Gets the externalId property: For external groups, this property contains the id of the group from the external identity provider, e.g.
String	id()	Gets the id property: Fully qualified resource Id for the resource.
GroupContractInner	innerModel()	Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner object.
String	name()	Gets the name property: The name of the resource.
GroupContract	refresh()	Refreshes the resource to sync with Azure.
GroupContract	refresh(com.azure.core.util.Context context)	Refreshes the resource to sync with Azure.
String	type()	Gets the type property: The type of the resource.
GroupType	typePropertiesType()	Gets the typePropertiesType property: Group type.
GroupContract.Update	update()	Begins update for the GroupContract resource.

Method Detail

id

String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

name

String name()

Gets the name property: The name of the resource.

Returns:

the name value.

type

String type()

Gets the type property: The type of the resource.

Returns:

the type value.

displayName

String displayName()

Gets the displayName property: Group name.

Returns:

the displayName value.

description

String description()

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

Returns:

the description value.

builtIn

Boolean builtIn()

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

Returns:

the builtIn value.

typePropertiesType

GroupType typePropertiesType()

Gets the typePropertiesType property: Group type.

Returns:

the typePropertiesType value.

externalId

String externalId()

Gets 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://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.

Returns:

the externalId value.

innerModel

GroupContractInner innerModel()

Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.GroupContractInner object.

Returns:

the inner object.

update

GroupContract.Update update()

Begins update for the GroupContract resource.

Returns:

the stage of resource update.

refresh

GroupContract refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

GroupContract refresh(com.azure.core.util.Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.