Package com.azure.resourcemanager.apicenter.fluent

Interface ServicesClient

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

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<ServiceInner> list()
      Lists services within an Azure subscription.
      Returns:
      the response of a Service list 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<ServiceInner> list(com.azure.core.util.Context context)
      Lists services within an Azure subscription.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the response of a Service 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ServiceInner> listByResourceGroup(String resourceGroupName)
      Returns a collection of services within the resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      the response of a Service 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.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<ServiceInner> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)
      Returns a collection of services within the 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 a Service 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.

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<ServiceInner> getByResourceGroupWithResponse(String resourceGroupName, String serviceName, com.azure.core.util.Context context)
      Returns details of the service.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      context - The context to associate with this operation.
      Returns:
      the service entity 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

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

      com.azure.core.http.rest.Response<ServiceInner> createOrUpdateWithResponse(String resourceGroupName, String serviceName, ServiceInner 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.
      resource - Resource create parameters.
      context - The context to associate with this operation.
      Returns:
      the service entity 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.

    • createOrUpdate

      ServiceInner createOrUpdate(String resourceGroupName, String serviceName, ServiceInner 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.
      resource - Resource create parameters.
      Returns:
      the service 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.

    • updateWithResponse

      com.azure.core.http.rest.Response<ServiceInner> updateWithResponse(String resourceGroupName, String serviceName, ServiceUpdate properties, com.azure.core.util.Context context)
      Updates existing service.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      properties - The resource properties to be updated.
      context - The context to associate with this operation.
      Returns:
      the service entity 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.

    • update

      ServiceInner update(String resourceGroupName, String serviceName, ServiceUpdate properties)
      Updates existing service.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      properties - The resource properties to be updated.
      Returns:
      the service 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, com.azure.core.util.Context context)
      Deletes specified service.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      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)
      Deletes specified service.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      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.

    • beginExportMetadataSchema

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<MetadataSchemaExportResultInner>,MetadataSchemaExportResultInner> beginExportMetadataSchema(String resourceGroupName, String serviceName, MetadataSchemaExportRequest body)
      Exports the effective metadata schema.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      body - The content of the action request.
      Returns:
      the SyncPoller for polling of the metadata schema 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.

    • beginExportMetadataSchema

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<MetadataSchemaExportResultInner>,MetadataSchemaExportResultInner> beginExportMetadataSchema(String resourceGroupName, String serviceName, MetadataSchemaExportRequest body, com.azure.core.util.Context context)
      Exports the effective metadata schema.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      body - The content of the action request.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of the metadata schema 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.

    • exportMetadataSchema

      MetadataSchemaExportResultInner exportMetadataSchema(String resourceGroupName, String serviceName, MetadataSchemaExportRequest body)
      Exports the effective metadata schema.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      body - The content of the action request.
      Returns:
      the metadata schema 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.

    • exportMetadataSchema

      MetadataSchemaExportResultInner exportMetadataSchema(String resourceGroupName, String serviceName, MetadataSchemaExportRequest body, com.azure.core.util.Context context)
      Exports the effective metadata schema.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of Azure API Center service.
      body - The content of the action request.
      context - The context to associate with this operation.
      Returns:
      the metadata schema 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.