Package com.azure.resourcemanager.apimanagement.models

Class ApiManagementGatewayUpdateParameters

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.models.ApimResource
com.azure.resourcemanager.apimanagement.models.ApiManagementGatewayUpdateParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class ApiManagementGatewayUpdateParameters extends ApimResource
Parameter supplied to Update API Management gateway.

  • Constructor Details

    • ApiManagementGatewayUpdateParameters

      public ApiManagementGatewayUpdateParameters()
      Creates an instance of ApiManagementGatewayUpdateParameters class.

  • Method Details

    • sku

      public ApiManagementGatewaySkuPropertiesForPatch sku()
      Get the sku property: SKU properties of the API Management gateway.
      Returns:
      the sku value.

    • withSku

      public ApiManagementGatewayUpdateParameters withSku(ApiManagementGatewaySkuPropertiesForPatch sku)
      Set the sku property: SKU properties of the API Management gateway.
      Parameters:
      sku - the sku value to set.
      Returns:
      the ApiManagementGatewayUpdateParameters object itself.

    • etag

      public String etag()
      Get the etag property: ETag of the resource.
      Returns:
      the etag value.

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class ApimResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class ApimResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class ApimResource
      Returns:
      the id value.

    • withTags

      public ApiManagementGatewayUpdateParameters withTags(Map<String,String> tags)
      Set the tags property: Resource tags.
      Overrides:
      withTags in class ApimResource
      Parameters:
      tags - the tags value to set.
      Returns:
      the ApimResource object itself.

    • 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 ApiManagementGatewayUpdateParameters withFrontend(FrontendConfiguration frontend)
      Set the frontend property: Information regarding how the gateway should be exposed.
      Parameters:
      frontend - the frontend value to set.
      Returns:
      the ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ApimResource
      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 ApimResource
      Throws:
      IOException

    • fromJson

      public static ApiManagementGatewayUpdateParameters fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ApiManagementGatewayUpdateParameters from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ApiManagementGatewayUpdateParameters 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 ApiManagementGatewayUpdateParameters.