Catalogs interface

Package:

@azure/arm-devcenter

Interface representing a Catalogs.

Methods

beginConnect(string, string, string, CatalogsConnectOptionalParams)	Connects a catalog to enable syncing.
beginConnectAndWait(string, string, string, CatalogsConnectOptionalParams)	Connects a catalog to enable syncing.
beginCreateOrUpdate(string, string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Creates or updates a catalog.
beginCreateOrUpdateAndWait(string, string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Creates or updates a catalog.
beginDelete(string, string, string, CatalogsDeleteOptionalParams)	Deletes a catalog resource.
beginDeleteAndWait(string, string, string, CatalogsDeleteOptionalParams)	Deletes a catalog resource.
beginSync(string, string, string, CatalogsSyncOptionalParams)	Syncs templates for a template source.
beginSyncAndWait(string, string, string, CatalogsSyncOptionalParams)	Syncs templates for a template source.
beginUpdate(string, string, string, CatalogUpdate, CatalogsUpdateOptionalParams)	Partially updates a catalog.
beginUpdateAndWait(string, string, string, CatalogUpdate, CatalogsUpdateOptionalParams)	Partially updates a catalog.
get(string, string, string, CatalogsGetOptionalParams)	Gets a catalog
getSyncErrorDetails(string, string, string, CatalogsGetSyncErrorDetailsOptionalParams)	Gets catalog synchronization error details
listByDevCenter(string, string, CatalogsListByDevCenterOptionalParams)	Lists catalogs for a devcenter.

Method Details

beginConnect(string, string, string, CatalogsConnectOptionalParams)

Connects a catalog to enable syncing.

function beginConnect(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsConnectOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsConnectHeaders>, CatalogsConnectHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsConnectOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CatalogsConnectHeaders>, CatalogsConnectHeaders>>

beginConnectAndWait(string, string, string, CatalogsConnectOptionalParams)

Connects a catalog to enable syncing.

function beginConnectAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsConnectOptionalParams): Promise<CatalogsConnectHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsConnectOptionalParams

The options parameters.

Returns

Promise<CatalogsConnectHeaders>

beginCreateOrUpdate(string, string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

Creates or updates a catalog.

function beginCreateOrUpdate(resourceGroupName: string, devCenterName: string, catalogName: string, body: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

body

Catalog

Represents a catalog.

options

CatalogsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Catalog>, Catalog>>

beginCreateOrUpdateAndWait(string, string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

Creates or updates a catalog.

function beginCreateOrUpdateAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, body: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<Catalog>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

body

Catalog

Represents a catalog.

options

CatalogsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Catalog>

beginDelete(string, string, string, CatalogsDeleteOptionalParams)

Deletes a catalog resource.

function beginDelete(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsDeleteHeaders>, CatalogsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CatalogsDeleteHeaders>, CatalogsDeleteHeaders>>

beginDeleteAndWait(string, string, string, CatalogsDeleteOptionalParams)

Deletes a catalog resource.

function beginDeleteAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<CatalogsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsDeleteOptionalParams

The options parameters.

Returns

Promise<CatalogsDeleteHeaders>

beginSync(string, string, string, CatalogsSyncOptionalParams)

Syncs templates for a template source.

function beginSync(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsSyncHeaders>, CatalogsSyncHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsSyncOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<CatalogsSyncHeaders>, CatalogsSyncHeaders>>

beginSyncAndWait(string, string, string, CatalogsSyncOptionalParams)

Syncs templates for a template source.

function beginSyncAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<CatalogsSyncHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsSyncOptionalParams

The options parameters.

Returns

Promise<CatalogsSyncHeaders>

beginUpdate(string, string, string, CatalogUpdate, CatalogsUpdateOptionalParams)

Partially updates a catalog.

function beginUpdate(resourceGroupName: string, devCenterName: string, catalogName: string, body: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

body

CatalogUpdate

Updatable catalog properties.

options

CatalogsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Catalog>, Catalog>>

beginUpdateAndWait(string, string, string, CatalogUpdate, CatalogsUpdateOptionalParams)

Partially updates a catalog.

function beginUpdateAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, body: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<Catalog>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

body

CatalogUpdate

Updatable catalog properties.

options

CatalogsUpdateOptionalParams

The options parameters.

Returns

Promise<Catalog>

get(string, string, string, CatalogsGetOptionalParams)

Gets a catalog

function get(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsGetOptionalParams): Promise<Catalog>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsGetOptionalParams

The options parameters.

Returns

Promise<Catalog>

getSyncErrorDetails(string, string, string, CatalogsGetSyncErrorDetailsOptionalParams)

Gets catalog synchronization error details

function getSyncErrorDetails(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsGetSyncErrorDetailsOptionalParams): Promise<SyncErrorDetails>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

CatalogsGetSyncErrorDetailsOptionalParams

The options parameters.

Returns

Promise<SyncErrorDetails>

listByDevCenter(string, string, CatalogsListByDevCenterOptionalParams)

Lists catalogs for a devcenter.

function listByDevCenter(resourceGroupName: string, devCenterName: string, options?: CatalogsListByDevCenterOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

devCenterName

string

The name of the devcenter.

options

CatalogsListByDevCenterOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>