ProjectCatalogs interface
Interface representing a ProjectCatalogs.
Methods
Method Details
beginConnect(string, string, string, ProjectCatalogsConnectOptionalParams)
Connects a project catalog to enable syncing.
function beginConnect(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsConnectOptionalParams): Promise<SimplePollerLike<OperationState<ProjectCatalogsConnectHeaders>, ProjectCatalogsConnectHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ProjectCatalogsConnectHeaders>, ProjectCatalogsConnectHeaders>>
beginConnectAndWait(string, string, string, ProjectCatalogsConnectOptionalParams)
Connects a project catalog to enable syncing.
function beginConnectAndWait(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsConnectOptionalParams): Promise<ProjectCatalogsConnectHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<ProjectCatalogsConnectHeaders>
beginCreateOrUpdate(string, string, string, Catalog, ProjectCatalogsCreateOrUpdateOptionalParams)
Creates or updates a project catalog.
function beginCreateOrUpdate(resourceGroupName: string, projectName: string, catalogName: string, body: Catalog, options?: ProjectCatalogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
- body
- Catalog
Represents a catalog.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Catalog>, Catalog>>
beginCreateOrUpdateAndWait(string, string, string, Catalog, ProjectCatalogsCreateOrUpdateOptionalParams)
Creates or updates a project catalog.
function beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, catalogName: string, body: Catalog, options?: ProjectCatalogsCreateOrUpdateOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
- body
- Catalog
Represents a catalog.
The options parameters.
Returns
Promise<Catalog>
beginDelete(string, string, string, ProjectCatalogsDeleteOptionalParams)
Deletes a project catalog resource.
function beginDelete(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ProjectCatalogsDeleteHeaders>, ProjectCatalogsDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ProjectCatalogsDeleteHeaders>, ProjectCatalogsDeleteHeaders>>
beginDeleteAndWait(string, string, string, ProjectCatalogsDeleteOptionalParams)
Deletes a project catalog resource.
function beginDeleteAndWait(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsDeleteOptionalParams): Promise<ProjectCatalogsDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<ProjectCatalogsDeleteHeaders>
beginPatch(string, string, string, CatalogUpdate, ProjectCatalogsPatchOptionalParams)
Partially updates a project catalog.
function beginPatch(resourceGroupName: string, projectName: string, catalogName: string, body: CatalogUpdate, options?: ProjectCatalogsPatchOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
- body
- CatalogUpdate
Updatable project catalog properties.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Catalog>, Catalog>>
beginPatchAndWait(string, string, string, CatalogUpdate, ProjectCatalogsPatchOptionalParams)
Partially updates a project catalog.
function beginPatchAndWait(resourceGroupName: string, projectName: string, catalogName: string, body: CatalogUpdate, options?: ProjectCatalogsPatchOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
- body
- CatalogUpdate
Updatable project catalog properties.
The options parameters.
Returns
Promise<Catalog>
beginSync(string, string, string, ProjectCatalogsSyncOptionalParams)
Syncs templates for a template source.
function beginSync(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsSyncOptionalParams): Promise<SimplePollerLike<OperationState<ProjectCatalogsSyncHeaders>, ProjectCatalogsSyncHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<ProjectCatalogsSyncHeaders>, ProjectCatalogsSyncHeaders>>
beginSyncAndWait(string, string, string, ProjectCatalogsSyncOptionalParams)
Syncs templates for a template source.
function beginSyncAndWait(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsSyncOptionalParams): Promise<ProjectCatalogsSyncHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<ProjectCatalogsSyncHeaders>
get(string, string, string, ProjectCatalogsGetOptionalParams)
Gets an associated project catalog.
function get(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsGetOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
- options
- ProjectCatalogsGetOptionalParams
The options parameters.
Returns
Promise<Catalog>
getSyncErrorDetails(string, string, string, ProjectCatalogsGetSyncErrorDetailsOptionalParams)
Gets project catalog synchronization error details
function getSyncErrorDetails(resourceGroupName: string, projectName: string, catalogName: string, options?: ProjectCatalogsGetSyncErrorDetailsOptionalParams): Promise<SyncErrorDetails>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
- catalogName
-
string
The name of the Catalog.
The options parameters.
Returns
Promise<SyncErrorDetails>
list(string, string, ProjectCatalogsListOptionalParams)
Lists the catalogs associated with a project.
function list(resourceGroupName: string, projectName: string, options?: ProjectCatalogsListOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- projectName
-
string
The name of the project.
The options parameters.