Interface CatalogsClient


public interface CatalogsClient
An instance of this class provides access to all the operations defined in CatalogsClient.
  • Method Details

    • listByDevCenter

      com.azure.core.http.rest.PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName)
      Lists catalogs for a devcenter.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      Returns:
      results of the catalog 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.
    • listByDevCenter

      com.azure.core.http.rest.PagedIterable<CatalogInner> listByDevCenter(String resourceGroupName, String devCenterName, Integer top, com.azure.core.util.Context context)
      Lists catalogs for a devcenter.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      top - The maximum number of resources to return from the operation. Example: '$top=10'.
      context - The context to associate with this operation.
      Returns:
      results of the catalog 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<CatalogInner> getWithResponse(String resourceGroupName, String devCenterName, String catalogName, com.azure.core.util.Context context)
      Gets a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      context - The context to associate with this operation.
      Returns:
      a catalog 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.
    • get

      CatalogInner get(String resourceGroupName, String devCenterName, String catalogName)
      Gets a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      Returns:
      a catalog.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)
      Creates or updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Represents a catalog.
      Returns:
      the SyncPoller for polling of represents a catalog.
      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.
    • beginCreateOrUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CatalogInner>,CatalogInner> beginCreateOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, com.azure.core.util.Context context)
      Creates or updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Represents a catalog.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of represents a catalog.
      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

      CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body)
      Creates or updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Represents a catalog.
      Returns:
      represents a catalog.
      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

      CatalogInner createOrUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogInner body, com.azure.core.util.Context context)
      Creates or updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Represents a catalog.
      context - The context to associate with this operation.
      Returns:
      represents a catalog.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)
      Partially updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Updatable catalog properties.
      Returns:
      the SyncPoller for polling of represents a catalog.
      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.
    • beginUpdate

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<CatalogInner>,CatalogInner> beginUpdate(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, com.azure.core.util.Context context)
      Partially updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Updatable catalog properties.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of represents a catalog.
      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

      CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body)
      Partially updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Updatable catalog properties.
      Returns:
      represents a catalog.
      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

      CatalogInner update(String resourceGroupName, String devCenterName, String catalogName, CatalogUpdate body, com.azure.core.util.Context context)
      Partially updates a catalog.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      body - Updatable catalog properties.
      context - The context to associate with this operation.
      Returns:
      represents a catalog.
      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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName)
      Deletes a catalog resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      Returns:
      the SyncPoller for polling of long-running 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.
    • beginDelete

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginDelete(String resourceGroupName, String devCenterName, String catalogName, com.azure.core.util.Context context)
      Deletes a catalog resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running 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.
    • delete

      void delete(String resourceGroupName, String devCenterName, String catalogName)
      Deletes a catalog resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      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 devCenterName, String catalogName, com.azure.core.util.Context context)
      Deletes a catalog resource.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      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.
    • beginSync

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName)
      Syncs templates for a template source.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      Returns:
      the SyncPoller for polling of long-running 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.
    • beginSync

      com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,Void> beginSync(String resourceGroupName, String devCenterName, String catalogName, com.azure.core.util.Context context)
      Syncs templates for a template source.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      context - The context to associate with this operation.
      Returns:
      the SyncPoller for polling of long-running 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.
    • sync

      void sync(String resourceGroupName, String devCenterName, String catalogName)
      Syncs templates for a template source.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      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.
    • sync

      void sync(String resourceGroupName, String devCenterName, String catalogName, com.azure.core.util.Context context)
      Syncs templates for a template source.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      devCenterName - The name of the devcenter.
      catalogName - The name of the Catalog.
      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.