Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiGatewayConfigConnectionsClient

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

  • Method Details

    • listByGateway

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayConfigConnectionResourceInner> 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<ApiManagementGatewayConfigConnectionResourceInner> 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<ApiManagementGatewayConfigConnectionResourceInner> 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

      ApiManagementGatewayConfigConnectionResourceInner 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayConfigConnectionResourceInner>,ApiManagementGatewayConfigConnectionResourceInner> beginCreateOrUpdate(String resourceGroupName, String gatewayName, String configConnectionName, ApiManagementGatewayConfigConnectionResourceInner parameters)
      Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
      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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway config connection operation.
      Returns:
      the SyncPoller for polling of a single API Management gateway resource in List or Get 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.

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayConfigConnectionResourceInner>,ApiManagementGatewayConfigConnectionResourceInner> beginCreateOrUpdate(String resourceGroupName, String gatewayName, String configConnectionName, ApiManagementGatewayConfigConnectionResourceInner parameters, com.azure.core.util.Context context)
      Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
      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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway config connection operation.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of a single API Management gateway resource in List or Get 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.

    • createOrUpdate

      ApiManagementGatewayConfigConnectionResourceInner createOrUpdate(String resourceGroupName, String gatewayName, String configConnectionName, ApiManagementGatewayConfigConnectionResourceInner parameters)
      Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
      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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway config connection operation.
      Returns:
      a single API Management gateway resource in List or Get 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.

    • createOrUpdate

      ApiManagementGatewayConfigConnectionResourceInner createOrUpdate(String resourceGroupName, String gatewayName, String configConnectionName, ApiManagementGatewayConfigConnectionResourceInner parameters, com.azure.core.util.Context context)
      Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
      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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway config connection operation.
      context - The context to associate with this operation.
      Returns:
      a single API Management gateway resource in List or Get 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.
      Returns:
      the SyncPoller for polling of long-running 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(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.
      Returns:
      the SyncPoller for polling of long-running 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.

    • 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.