Catalogs interface
Interface representing a Catalogs.
Methods
Method Details
beginCreateOrUpdate(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)
Create a Catalog
function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- resource
- Catalog
Resource create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<Catalog>, Catalog>>
beginCreateOrUpdateAndWait(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)
Create a Catalog
function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- resource
- Catalog
Resource create parameters.
The options parameters.
Returns
Promise<Catalog>
beginDelete(string, string, CatalogsDeleteOptionalParams)
Delete a Catalog
function beginDelete(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- options
- CatalogsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, CatalogsDeleteOptionalParams)
Delete a Catalog
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- options
- CatalogsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
countDevices(string, string, CatalogsCountDevicesOptionalParams)
Counts devices in catalog.
function countDevices(resourceGroupName: string, catalogName: string, options?: CatalogsCountDevicesOptionalParams): Promise<CountDeviceResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
The options parameters.
Returns
Promise<CountDeviceResponse>
get(string, string, CatalogsGetOptionalParams)
Get a Catalog
function get(resourceGroupName: string, catalogName: string, options?: CatalogsGetOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- options
- CatalogsGetOptionalParams
The options parameters.
Returns
Promise<Catalog>
listByResourceGroup(string, CatalogsListByResourceGroupOptionalParams)
List Catalog resources by resource group
function listByResourceGroup(resourceGroupName: string, options?: CatalogsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
The options parameters.
Returns
listBySubscription(CatalogsListBySubscriptionOptionalParams)
List Catalog resources by subscription ID
function listBySubscription(options?: CatalogsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>Parameters
The options parameters.
Returns
listDeployments(string, string, CatalogsListDeploymentsOptionalParams)
Lists deployments for catalog.
function listDeployments(resourceGroupName: string, catalogName: string, options?: CatalogsListDeploymentsOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
The options parameters.
Returns
listDeviceGroups(string, string, ListDeviceGroupsRequest, CatalogsListDeviceGroupsOptionalParams)
List the device groups for the catalog.
function listDeviceGroups(resourceGroupName: string, catalogName: string, listDeviceGroupsRequest: ListDeviceGroupsRequest, options?: CatalogsListDeviceGroupsOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- listDeviceGroupsRequest
- ListDeviceGroupsRequest
List device groups for catalog.
The options parameters.
Returns
listDeviceInsights(string, string, CatalogsListDeviceInsightsOptionalParams)
Lists device insights for catalog.
function listDeviceInsights(resourceGroupName: string, catalogName: string, options?: CatalogsListDeviceInsightsOptionalParams): PagedAsyncIterableIterator<DeviceInsight, DeviceInsight[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
The options parameters.
Returns
listDevices(string, string, CatalogsListDevicesOptionalParams)
Lists devices for catalog.
function listDevices(resourceGroupName: string, catalogName: string, options?: CatalogsListDevicesOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
The options parameters.
Returns
update(string, string, CatalogUpdate, CatalogsUpdateOptionalParams)
Update a Catalog
function update(resourceGroupName: string, catalogName: string, properties: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<Catalog>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- catalogName
-
string
Name of catalog
- properties
- CatalogUpdate
The resource properties to be updated.
- options
- CatalogsUpdateOptionalParams
The options parameters.
Returns
Promise<Catalog>
