GroupContract Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface GroupContract

An immutable client-side representation of GroupContract.

Method Summary

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

Method Details

builtIn

public abstract 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.

description

public abstract String description()

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

Returns:

the description value.

displayName

public abstract String displayName()

Gets the displayName property: Group name.

Returns:

the displayName value.

externalId

public abstract 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://.onmicrosoft.com/groups/`; otherwise the value is null.

Returns:

the externalId value.

id

public abstract String id()

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

Returns:

the id value.

innerModel

public abstract GroupContractInner innerModel()

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

Returns:

the inner object.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

refresh

public abstract GroupContract refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract GroupContract refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

typePropertiesType

public abstract GroupType typePropertiesType()

Gets the typePropertiesType property: Group type.

Returns:

the typePropertiesType value.

update

public abstract GroupContract.Update update()

Begins update for the GroupContract resource.

Returns:

the stage of resource update.