Package com.azure.resourcemanager.devcenter.models

Interface Catalogs

public interface Catalogs
Resource collection API of Catalogs.

  • Method Details

    • listByDevCenter

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

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

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

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

    • getById

      Catalog getById(String id)
      Gets a catalog.
      Parameters:
      id - the resource ID.
      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.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Catalog> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets a catalog.
      Parameters:
      id - the resource ID.
      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.

    • deleteById

      void deleteById(String id)
      Deletes a catalog resource.
      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

      void deleteByIdWithResponse(String id, com.azure.core.util.Context context)
      Deletes a catalog resource.
      Parameters:
      id - the resource ID.
      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.

    • define

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