Package com.azure.resourcemanager.apimanagement.fluent.models

Class GroupContractProperties

  • public final class GroupContractProperties
extends Object
    Group contract Properties.

    • Constructor Detail

      • GroupContractProperties

        public GroupContractProperties()

    • Method Detail

      • displayName

        public String displayName()
        Get the displayName property: Group name.
        Returns:
        the displayName value.

      • withDisplayName

        public GroupContractProperties withDisplayName​(String displayName)
        Set the displayName property: Group name.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the GroupContractProperties object itself.

      • description

        public String description()
        Get the description property: Group description. Can contain HTML formatting tags.
        Returns:
        the description value.

      • withDescription

        public GroupContractProperties withDescription​(String description)
        Set the description property: Group description. Can contain HTML formatting tags.
        Parameters:
        description - the description value to set.
        Returns:
        the GroupContractProperties object itself.

      • 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.

      • type

        public GroupType type()
        Get the type property: Group type.
        Returns:
        the type value.

      • withType

        public GroupContractProperties withType​(GroupType type)
        Set the type property: Group type.
        Parameters:
        type - the type value to set.
        Returns:
        the GroupContractProperties object itself.

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

      • withExternalId

        public GroupContractProperties 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://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.
        Parameters:
        externalId - the externalId value to set.
        Returns:
        the GroupContractProperties object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.