Catalogs interface
Interface representing a Catalogs.
Methods
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<void>, void>>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<SimplePollerLike<OperationState<void>, void>>
beginConnectAndWait(string, string, string, CatalogsConnectOptionalParams)
Connects a catalog to enable syncing.
function beginConnectAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsConnectOptionalParams): Promise<void>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<void>
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.
The options parameters.
Returns
Promise<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.
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<void>, void>>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<SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, CatalogsDeleteOptionalParams)
Deletes a catalog resource.
function beginDeleteAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<void>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<void>
beginSync(string, string, string, CatalogsSyncOptionalParams)
Syncs templates for a template source.
function beginSync(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>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<SimplePollerLike<OperationState<void>, void>>
beginSyncAndWait(string, string, string, CatalogsSyncOptionalParams)
Syncs templates for a template source.
function beginSyncAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<void>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<void>
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<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.
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.
The options parameters.
Returns
Azure SDK for JavaScript
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for