Package com.azure.resourcemanager.apimanagement.models

Interface ApiGateways

public interface ApiGateways
Resource collection API of ApiGateways.

  • Method Details

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<ApiManagementGatewayResource> 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

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

    • deleteByResourceGroup

      ApiManagementGatewayResource deleteByResourceGroup(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

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

    • getById

      ApiManagementGatewayResource getById(String id)
      Gets an API Management gateway resource description.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ApiManagementGatewayResource> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets an API Management gateway resource description.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

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

    • deleteByIdWithResponse

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

    • define

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