Package version:

Interface Catalogs

Interface representing a Catalogs.

Hierarchy

Catalogs

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginSync beginSyncAndWait beginUpdate beginUpdateAndWait get listByDevCenter

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, devCenterName: string, catalogName: string, body: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Catalog>, Catalog>>
Creates or updates a 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.
- Optional options: CatalogsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Catalog>, Catalog>>
- Defined in operationsInterfaces/catalogs.ts:60

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, body: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<Catalog>
Creates or updates a 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.
- Optional options: CatalogsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<Catalog>
- Defined in operationsInterfaces/catalogs.ts:80

beginDelete

beginDelete(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a catalog resource.
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.
- Optional options: CatalogsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/catalogs.ts:129

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<void>
Deletes a catalog resource.
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.
- Optional options: CatalogsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/catalogs.ts:142

beginSync

beginSync(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Syncs templates for a template source.
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.
- Optional options: CatalogsSyncOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/catalogs.ts:155

beginSyncAndWait

beginSyncAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsSyncOptionalParams): Promise<void>
Syncs templates for a template source.
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.
- Optional options: CatalogsSyncOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/catalogs.ts:168

beginUpdate

beginUpdate(resourceGroupName: string, devCenterName: string, catalogName: string, body: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<PollerLike<PollOperationState<Catalog>, Catalog>>
Partially updates a 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.
- Optional options: CatalogsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<Catalog>, Catalog>>
- Defined in operationsInterfaces/catalogs.ts:95

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, devCenterName: string, catalogName: string, body: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<Catalog>
Partially updates a 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.
- Optional options: CatalogsUpdateOptionalParams
  
  The options parameters.
Returns Promise<Catalog>
- Defined in operationsInterfaces/catalogs.ts:115

get

get(resourceGroupName: string, devCenterName: string, catalogName: string, options?: CatalogsGetOptionalParams): Promise<Catalog>
Gets a 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.
- Optional options: CatalogsGetOptionalParams
  
  The options parameters.
Returns Promise<Catalog>
- Defined in operationsInterfaces/catalogs.ts:46

listByDevCenter

listByDevCenter(resourceGroupName: string, devCenterName: string, options?: CatalogsListByDevCenterOptionalParams): PagedAsyncIterableIterator<Catalog>
Lists catalogs for a devcenter.
Parameters
- resourceGroupName: string
  
  The name of the resource group. The name is case insensitive.
- devCenterName: string
  
  The name of the devcenter.
- Optional options: CatalogsListByDevCenterOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<Catalog>
- Defined in operationsInterfaces/catalogs.ts:34

Interface Catalogs

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

body: Catalog

Optional options: CatalogsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Catalog>, Catalog>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

body: Catalog

Optional options: CatalogsCreateOrUpdateOptionalParams

Returns Promise<Catalog>

beginDelete

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

Optional options: CatalogsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

Optional options: CatalogsDeleteOptionalParams

Returns Promise<void>

beginSync

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

Optional options: CatalogsSyncOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginSyncAndWait

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

Optional options: CatalogsSyncOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

body: CatalogUpdate

Optional options: CatalogsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<Catalog>, Catalog>>

beginUpdateAndWait

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

body: CatalogUpdate

Optional options: CatalogsUpdateOptionalParams

Returns Promise<Catalog>

get

Parameters

resourceGroupName: string

devCenterName: string

catalogName: string

Optional options: CatalogsGetOptionalParams

Returns Promise<Catalog>

listByDevCenter

Parameters

resourceGroupName: string

devCenterName: string

Optional options: CatalogsListByDevCenterOptionalParams

Returns PagedAsyncIterableIterator<Catalog>

Settings

Member Visibility

`Optional` options: CatalogsCreateOrUpdateOptionalParams

`Optional` options: CatalogsCreateOrUpdateOptionalParams

`Optional` options: CatalogsDeleteOptionalParams

`Optional` options: CatalogsDeleteOptionalParams

`Optional` options: CatalogsSyncOptionalParams

`Optional` options: CatalogsSyncOptionalParams

`Optional` options: CatalogsUpdateOptionalParams

`Optional` options: CatalogsUpdateOptionalParams

`Optional` options: CatalogsGetOptionalParams

`Optional` options: CatalogsListByDevCenterOptionalParams