Package com.azure.resourcemanager.apimanagement.models

Interface ApiGatewayConfigConnections

public interface ApiGatewayConfigConnections
Resource collection API of ApiGatewayConfigConnections.

  • Method Details

    • listByGateway

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayConfigConnectionResource> listByGateway(String resourceGroupName, String gatewayName)
      List all API Management gateway config connections within a gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      Returns:
      the response of the List API Management gateway operation 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.

    • listByGateway

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayConfigConnectionResource> listByGateway(String resourceGroupName, String gatewayName, com.azure.core.util.Context context)
      List all API Management gateway config connections within a gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      context - The context to associate with this operation.
      Returns:
      the response of the List API Management gateway operation 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.

    • getWithResponse

      com.azure.core.http.rest.Response<ApiManagementGatewayConfigConnectionResource> getWithResponse(String resourceGroupName, String gatewayName, String configConnectionName, com.azure.core.util.Context context)
      Gets an API Management gateway config connection resource description.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      configConnectionName - The name of the API Management gateway config connection.
      context - The context to associate with this operation.
      Returns:
      an API Management gateway config connection resource description along with 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.

    • get

      ApiManagementGatewayConfigConnectionResource get(String resourceGroupName, String gatewayName, String configConnectionName)
      Gets an API Management gateway config connection resource description.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      configConnectionName - The name of the API Management gateway config connection.
      Returns:
      an API Management gateway config connection resource description.
      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 gatewayName, String configConnectionName, String ifMatch)
      Deletes an existing API Management gateway config connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      configConnectionName - The name of the API Management gateway config connection.
      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.

    • delete

      void delete(String resourceGroupName, String gatewayName, String configConnectionName, String ifMatch, com.azure.core.util.Context context)
      Deletes an existing API Management gateway config connection.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      configConnectionName - The name of the API Management gateway config connection.
      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.
      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.

    • getById

      ApiManagementGatewayConfigConnectionResource getById(String id)
      Gets an API Management gateway config connection resource description.
      Parameters:
      id - the resource ID.
      Returns:
      an API Management gateway config connection resource description along with 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ApiManagementGatewayConfigConnectionResource> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets an API Management gateway config connection resource description.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      an API Management gateway config connection resource description along with 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.

    • deleteById

      void deleteById(String id)
      Deletes an existing API Management gateway config connection.
      Parameters:
      id - the resource ID.
      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.

    • deleteByIdWithResponse

      void deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
      Deletes an existing API Management gateway config connection.
      Parameters:
      id - the resource ID.
      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.
      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.

    • define

      ApiManagementGatewayConfigConnectionResource.DefinitionStages.Blank define(String name)
      Begins definition for a new ApiManagementGatewayConfigConnectionResource resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new ApiManagementGatewayConfigConnectionResource definition.