Package com.azure.resourcemanager.apimanagement.fluent

Interface GatewayHostnameConfigurationsClient

public interface GatewayHostnameConfigurationsClient
An instance of this class provides access to all the operations defined in GatewayHostnameConfigurationsClient.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<GatewayHostnameConfigurationContractInner> listByService(String resourceGroupName, String serviceName, String gatewayId)
      Lists the collection of hostname configurations for the specified gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      Returns:
      paged Gateway hostname configuration list representation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByService

      com.azure.core.http.rest.PagedIterable<GatewayHostnameConfigurationContractInner> listByService(String resourceGroupName, String serviceName, String gatewayId, String filter, Integer top, Integer skip, com.azure.core.util.Context context)
      Lists the collection of hostname configurations for the specified gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
      top - Number of records to return.
      skip - Number of records to skip.
      context - The context to associate with this operation.
      Returns:
      paged Gateway hostname configuration list representation as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTagWithResponse

      GatewayHostnameConfigurationsGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, com.azure.core.util.Context context)
      Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      context - The context to associate with this operation.
      Returns:
      the response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String gatewayId, String hcId)
      Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      GatewayHostnameConfigurationsGetResponse getWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, com.azure.core.util.Context context)
      Get details of a hostname configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      context - The context to associate with this operation.
      Returns:
      details of a hostname configuration.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      GatewayHostnameConfigurationContractInner get(String resourceGroupName, String serviceName, String gatewayId, String hcId)
      Get details of a hostname configuration.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      Returns:
      details of a hostname configuration.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      GatewayHostnameConfigurationsCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, GatewayHostnameConfigurationContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates of updates hostname configuration for a Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      parameters - The parameters parameter.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      gateway hostname configuration details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      GatewayHostnameConfigurationContractInner createOrUpdate(String resourceGroupName, String serviceName, String gatewayId, String hcId, GatewayHostnameConfigurationContractInner parameters)
      Creates of updates hostname configuration for a Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      parameters - The parameters parameter.
      Returns:
      gateway hostname configuration details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String gatewayId, String hcId, String ifMatch, com.azure.core.util.Context context)
      Deletes the specified hostname configuration from the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String serviceName, String gatewayId, String hcId, String ifMatch)
      Deletes the specified hostname configuration from the specified Gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      gatewayId - Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value 'managed'.
      hcId - Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.