Package com.azure.resourcemanager.apicenter.models

Interface Services

public interface Services
Resource collection API of Services.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Service> 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<Service> 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<Service> 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<Service> 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<Service> 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

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

    • deleteByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Void> deleteByResourceGroupWithResponse(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.

    • deleteByResourceGroup

      void deleteByResourceGroup(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.

    • exportMetadataSchema

      MetadataSchemaExportResult 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

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

    • getById

      Service getById(String id)
      Returns details of the service.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Service> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Returns details of the service.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

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

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