Package com.azure.resourcemanager.apimanagement.models

Class ApiManagementGatewayBaseProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.ApiManagementGatewayBaseProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ApiManagementGatewayBaseProperties>
Direct Known Subclasses:
ApiManagementGatewayProperties, ApiManagementGatewayUpdateProperties
public class ApiManagementGatewayBaseProperties extends Object implements com.azure.json.JsonSerializable<ApiManagementGatewayBaseProperties>
Base Properties of an API Management gateway resource description.

  • Constructor Details

    • ApiManagementGatewayBaseProperties

      public ApiManagementGatewayBaseProperties()
      Creates an instance of ApiManagementGatewayBaseProperties class.

  • Method Details

    • provisioningState

      public String provisioningState()
      Get the provisioningState property: The current provisioning state of the API Management gateway which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.
      Returns:
      the provisioningState value.

    • targetProvisioningState

      public String targetProvisioningState()
      Get the targetProvisioningState property: The provisioning state of the API Management gateway, which is targeted by the long running operation started on the gateway.
      Returns:
      the targetProvisioningState value.

    • createdAtUtc

      public OffsetDateTime createdAtUtc()
      Get the createdAtUtc property: Creation UTC date of the API Management gateway.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.
      Returns:
      the createdAtUtc value.

    • frontend

      public FrontendConfiguration frontend()
      Get the frontend property: Information regarding how the gateway should be exposed.
      Returns:
      the frontend value.

    • withFrontend

      public ApiManagementGatewayBaseProperties withFrontend(FrontendConfiguration frontend)
      Set the frontend property: Information regarding how the gateway should be exposed.
      Parameters:
      frontend - the frontend value to set.
      Returns:
      the ApiManagementGatewayBaseProperties object itself.

    • backend

      public BackendConfiguration backend()
      Get the backend property: Information regarding how the gateway should integrate with backend systems.
      Returns:
      the backend value.

    • withBackend

      public ApiManagementGatewayBaseProperties withBackend(BackendConfiguration backend)
      Set the backend property: Information regarding how the gateway should integrate with backend systems.
      Parameters:
      backend - the backend value to set.
      Returns:
      the ApiManagementGatewayBaseProperties object itself.

    • configurationApi

      public GatewayConfigurationApi configurationApi()
      Get the configurationApi property: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
      Returns:
      the configurationApi value.

    • withConfigurationApi

      public ApiManagementGatewayBaseProperties withConfigurationApi(GatewayConfigurationApi configurationApi)
      Set the configurationApi property: Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.
      Parameters:
      configurationApi - the configurationApi value to set.
      Returns:
      the ApiManagementGatewayBaseProperties object itself.

    • virtualNetworkType

      public VirtualNetworkType virtualNetworkType()
      Get the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.
      Returns:
      the virtualNetworkType value.

    • withVirtualNetworkType

      public ApiManagementGatewayBaseProperties withVirtualNetworkType(VirtualNetworkType virtualNetworkType)
      Set the virtualNetworkType property: The type of VPN in which API Management gateway needs to be configured in.
      Parameters:
      virtualNetworkType - the virtualNetworkType value to set.
      Returns:
      the ApiManagementGatewayBaseProperties 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<ApiManagementGatewayBaseProperties>
      Throws:
      IOException

    • fromJson

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