/*
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { SimplePollerLike, OperationState } from "@azure/core-lro";
import {
Catalog,
CatalogsListByDevCenterOptionalParams,
CatalogsGetOptionalParams,
CatalogsGetResponse,
CatalogsCreateOrUpdateOptionalParams,
CatalogsCreateOrUpdateResponse,
CatalogUpdate,
CatalogsUpdateOptionalParams,
CatalogsUpdateResponse,
CatalogsDeleteOptionalParams,
CatalogsDeleteResponse,
CatalogsGetSyncErrorDetailsOptionalParams,
CatalogsGetSyncErrorDetailsResponse,
CatalogsSyncOptionalParams,
CatalogsSyncResponse,
CatalogsConnectOptionalParams,
CatalogsConnectResponse,
} from "../models";
///
/** Interface representing a Catalogs. */
export interface Catalogs {
/**
* Lists catalogs for a devcenter.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param options The options parameters.
*/
listByDevCenter(
resourceGroupName: string,
devCenterName: string,
options?: CatalogsListByDevCenterOptionalParams,
): PagedAsyncIterableIterator;
/**
* Gets a catalog
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
get(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsGetOptionalParams,
): Promise;
/**
* Creates or updates a catalog.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param body Represents a catalog.
* @param options The options parameters.
*/
beginCreateOrUpdate(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
body: Catalog,
options?: CatalogsCreateOrUpdateOptionalParams,
): Promise<
SimplePollerLike<
OperationState,
CatalogsCreateOrUpdateResponse
>
>;
/**
* Creates or updates a catalog.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param body Represents a catalog.
* @param options The options parameters.
*/
beginCreateOrUpdateAndWait(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
body: Catalog,
options?: CatalogsCreateOrUpdateOptionalParams,
): Promise;
/**
* Partially updates a catalog.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param body Updatable catalog properties.
* @param options The options parameters.
*/
beginUpdate(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
body: CatalogUpdate,
options?: CatalogsUpdateOptionalParams,
): Promise<
SimplePollerLike<
OperationState,
CatalogsUpdateResponse
>
>;
/**
* Partially updates a catalog.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param body Updatable catalog properties.
* @param options The options parameters.
*/
beginUpdateAndWait(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
body: CatalogUpdate,
options?: CatalogsUpdateOptionalParams,
): Promise;
/**
* Deletes a catalog resource.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginDelete(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsDeleteOptionalParams,
): Promise<
SimplePollerLike<
OperationState,
CatalogsDeleteResponse
>
>;
/**
* Deletes a catalog resource.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginDeleteAndWait(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsDeleteOptionalParams,
): Promise;
/**
* Gets catalog synchronization error details
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
getSyncErrorDetails(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsGetSyncErrorDetailsOptionalParams,
): Promise;
/**
* Syncs templates for a template source.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginSync(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsSyncOptionalParams,
): Promise<
SimplePollerLike, CatalogsSyncResponse>
>;
/**
* Syncs templates for a template source.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginSyncAndWait(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsSyncOptionalParams,
): Promise;
/**
* Connects a catalog to enable syncing.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginConnect(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsConnectOptionalParams,
): Promise<
SimplePollerLike<
OperationState,
CatalogsConnectResponse
>
>;
/**
* Connects a catalog to enable syncing.
* @param resourceGroupName The name of the resource group. The name is case insensitive.
* @param devCenterName The name of the devcenter.
* @param catalogName The name of the Catalog.
* @param options The options parameters.
*/
beginConnectAndWait(
resourceGroupName: string,
devCenterName: string,
catalogName: string,
options?: CatalogsConnectOptionalParams,
): Promise;
}