Package com.azure.resourcemanager.apicenter.models

Interface ApiDefinitions

public interface ApiDefinitions
Resource collection API of ApiDefinitions.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ApiDefinition> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName)
      Returns a collection of API definitions.
      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.
      versionName - The name of the API version.
      Returns:
      the response of a ApiDefinition 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<ApiDefinition> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String filter, com.azure.core.util.Context context)
      Returns a collection of API definitions.
      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.
      versionName - The name of the API version.
      filter - OData filter parameter.
      context - The context to associate with this operation.
      Returns:
      the response of a ApiDefinition 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

      com.azure.core.http.rest.Response<ApiDefinition> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, com.azure.core.util.Context context)
      Returns details of the API definition.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      context - The context to associate with this operation.
      Returns:
      aPI definition 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

      ApiDefinition get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)
      Returns details of the API definition.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      Returns:
      aPI definition 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, String versionName, String definitionName, com.azure.core.util.Context context)
      Deletes specified API definition.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      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, String versionName, String definitionName)
      Deletes specified API definition.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      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, String versionName, String definitionName, com.azure.core.util.Context context)
      Checks if specified API definition 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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      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, String versionName, String definitionName)
      Checks if specified API definition 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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      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.

    • exportSpecification

      ApiSpecExportResult exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)
      Exports the API specification.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      Returns:
      the API specification export result.
      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.

    • exportSpecification

      ApiSpecExportResult exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, com.azure.core.util.Context context)
      Exports the API specification.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      context - The context to associate with this operation.
      Returns:
      the API specification export result.
      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.

    • importSpecification

      void importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body)
      Imports the API specification.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      body - The content of the action request.
      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.

    • importSpecification

      void importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body, com.azure.core.util.Context context)
      Imports the API specification.
      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.
      versionName - The name of the API version.
      definitionName - The name of the API definition.
      body - The content of the action request.
      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

      ApiDefinition getById(String id)
      Returns details of the API definition.
      Parameters:
      id - the resource ID.
      Returns:
      aPI definition 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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<ApiDefinition> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns details of the API definition.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      aPI definition 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.

    • deleteById

      void deleteById(String id)
      Deletes specified API definition.
      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

      com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes specified API definition.
      Parameters:
      id - the resource ID.
      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.

    • define

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