Package com.azure.resourcemanager.apimanagement.fluent

Interface ApiGatewaysClient

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

  • Method Details

    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayResourceInner parameters)
      Creates or updates an API Management gateway. 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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginCreateOrUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayResourceInner parameters, com.azure.core.util.Context context)
      Creates or updates an API Management gateway. 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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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

      ApiManagementGatewayResourceInner createOrUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayResourceInner parameters)
      Creates or updates an API Management gateway. 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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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

      ApiManagementGatewayResourceInner createOrUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayResourceInner parameters, com.azure.core.util.Context context)
      Creates or updates an API Management gateway. 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.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayUpdateParameters parameters)
      Updates an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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.

    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginUpdate(String resourceGroupName, String gatewayName, ApiManagementGatewayUpdateParameters parameters, com.azure.core.util.Context context)
      Updates an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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.

    • update

      ApiManagementGatewayResourceInner update(String resourceGroupName, String gatewayName, ApiManagementGatewayUpdateParameters parameters)
      Updates an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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.

    • update

      ApiManagementGatewayResourceInner update(String resourceGroupName, String gatewayName, ApiManagementGatewayUpdateParameters parameters, com.azure.core.util.Context context)
      Updates an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      parameters - Parameters supplied to the CreateOrUpdate API Management gateway 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<ApiManagementGatewayResourceInner> getByResourceGroupWithResponse(String resourceGroupName, String gatewayName, com.azure.core.util.Context context)
      Gets an API Management gateway resource description.
      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:
      an API Management gateway 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.

    • getByResourceGroup

      ApiManagementGatewayResourceInner getByResourceGroup(String resourceGroupName, String gatewayName)
      Gets an API Management gateway resource description.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      Returns:
      an API Management gateway 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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginDelete(String resourceGroupName, String gatewayName)
      Deletes an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      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.

    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<ApiManagementGatewayResourceInner>,ApiManagementGatewayResourceInner> beginDelete(String resourceGroupName, String gatewayName, com.azure.core.util.Context context)
      Deletes an existing API Management 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 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.

    • delete

      ApiManagementGatewayResourceInner delete(String resourceGroupName, String gatewayName)
      Deletes an existing API Management gateway.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      gatewayName - The name of the API Management gateway.
      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.

    • delete

      ApiManagementGatewayResourceInner delete(String resourceGroupName, String gatewayName, com.azure.core.util.Context context)
      Deletes an existing API Management 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:
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayResourceInner> listByResourceGroup(String resourceGroupName)
      List all API Management gateways within a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayResourceInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      List all API Management gateways within a resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.

    • list

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayResourceInner> list()
      List all API Management gateways within a subscription.
      Returns:
      the response of the List API Management gateway operation as paginated response with PagedIterable.
      Throws:
      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.

    • list

      com.azure.core.http.rest.PagedIterable<ApiManagementGatewayResourceInner> list(com.azure.core.util.Context context)
      List all API Management gateways within a subscription.
      Parameters:
      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.