Package com.azure.resourcemanager.apimanagement.models

Class PortalSettingsContract

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.models.PortalSettingsContract
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class PortalSettingsContract extends com.azure.core.management.ProxyResource
Portal Settings for the Developer Portal.

  • Constructor Details

    • PortalSettingsContract

      public PortalSettingsContract()
      Creates an instance of PortalSettingsContract class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • url

      public String url()
      Get the url property: A delegation Url.
      Returns:
      the url value.

    • withUrl

      public PortalSettingsContract withUrl(String url)
      Set the url property: A delegation Url.
      Parameters:
      url - the url value to set.
      Returns:
      the PortalSettingsContract object itself.

    • validationKey

      public String validationKey()
      Get the validationKey property: A base64-encoded validation key to validate, that a request is coming from Azure API Management.
      Returns:
      the validationKey value.

    • withValidationKey

      public PortalSettingsContract withValidationKey(String validationKey)
      Set the validationKey property: A base64-encoded validation key to validate, that a request is coming from Azure API Management.
      Parameters:
      validationKey - the validationKey value to set.
      Returns:
      the PortalSettingsContract object itself.

    • subscriptions

      public SubscriptionsDelegationSettingsProperties subscriptions()
      Get the subscriptions property: Subscriptions delegation settings.
      Returns:
      the subscriptions value.

    • withSubscriptions

      public PortalSettingsContract withSubscriptions(SubscriptionsDelegationSettingsProperties subscriptions)
      Set the subscriptions property: Subscriptions delegation settings.
      Parameters:
      subscriptions - the subscriptions value to set.
      Returns:
      the PortalSettingsContract object itself.

    • userRegistration

      public RegistrationDelegationSettingsProperties userRegistration()
      Get the userRegistration property: User registration delegation settings.
      Returns:
      the userRegistration value.

    • withUserRegistration

      public PortalSettingsContract withUserRegistration(RegistrationDelegationSettingsProperties userRegistration)
      Set the userRegistration property: User registration delegation settings.
      Parameters:
      userRegistration - the userRegistration value to set.
      Returns:
      the PortalSettingsContract object itself.

    • enabled

      public Boolean enabled()
      Get the enabled property: Redirect Anonymous users to the Sign-In page.
      Returns:
      the enabled value.

    • withEnabled

      public PortalSettingsContract withEnabled(Boolean enabled)
      Set the enabled property: Redirect Anonymous users to the Sign-In page.
      Parameters:
      enabled - the enabled value to set.
      Returns:
      the PortalSettingsContract object itself.

    • termsOfService

      public TermsOfServiceProperties termsOfService()
      Get the termsOfService property: Terms of service contract properties.
      Returns:
      the termsOfService value.

    • withTermsOfService

      public PortalSettingsContract withTermsOfService(TermsOfServiceProperties termsOfService)
      Set the termsOfService property: Terms of service contract properties.
      Parameters:
      termsOfService - the termsOfService value to set.
      Returns:
      the PortalSettingsContract object itself.

    • validate

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.ProxyResource
      Throws:
      IOException

    • fromJson

      public static PortalSettingsContract fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of PortalSettingsContract from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of PortalSettingsContract if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the PortalSettingsContract.