Package com.azure.resourcemanager.apicenter.fluent

Interface ApisClient

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

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ApiInner> list(String resourceGroupName, String serviceName, String workspaceName)
      Returns a collection of APIs.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      Returns:
      the response of a Api list 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<ApiInner> list(String resourceGroupName, String serviceName, String workspaceName, String filter, com.azure.core.util.Context context)
      Returns a collection of APIs.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      filter - OData filter parameter.
      context - The context to associate with this operation.
      Returns:
      the response of a Api list 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

      ApisGetResponse getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, com.azure.core.util.Context context)
      Returns details of the API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      context - The context to associate with this operation.
      Returns:
      aPI 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.

    • get

      ApiInner get(String resourceGroupName, String serviceName, String workspaceName, String apiName)
      Returns details of the API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      Returns:
      aPI 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.

    • createOrUpdateWithResponse

      ApisCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource, com.azure.core.util.Context context)
      Creates new or updates existing API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      resource - Resource create parameters.
      context - The context to associate with this operation.
      Returns:
      aPI 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.

    • createOrUpdate

      ApiInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource)
      Creates new or updates existing API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      resource - Resource create parameters.
      Returns:
      aPI 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, com.azure.core.util.Context context)
      Deletes specified API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      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 workspaceName, String apiName)
      Deletes specified API.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      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.

    • headWithResponse

      com.azure.core.http.rest.Response<Void> headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, com.azure.core.util.Context context)
      Checks if specified API exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      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.

    • head

      void head(String resourceGroupName, String serviceName, String workspaceName, String apiName)
      Checks if specified API exists.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      workspaceName - The name of the workspace.
      apiName - The name of the API.
      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.