Catalogs interface

Package:

@azure/arm-sphere

Interface representing a Catalogs.

Methods

beginCreateOrUpdate(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Create a Catalog
beginCreateOrUpdateAndWait(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)	Create a Catalog
beginDelete(string, string, CatalogsDeleteOptionalParams)	Delete a Catalog
beginDeleteAndWait(string, string, CatalogsDeleteOptionalParams)	Delete a Catalog
beginUploadImage(string, string, Image_2, CatalogsUploadImageOptionalParams)	Creates an image. Use this action when the image ID is unknown.
beginUploadImageAndWait(string, string, Image_2, CatalogsUploadImageOptionalParams)	Creates an image. Use this action when the image ID is unknown.
countDevices(string, string, CatalogsCountDevicesOptionalParams)	Counts devices in catalog.
get(string, string, CatalogsGetOptionalParams)	Get a Catalog
listByResourceGroup(string, CatalogsListByResourceGroupOptionalParams)	List Catalog resources by resource group
listBySubscription(CatalogsListBySubscriptionOptionalParams)	List Catalog resources by subscription ID
listDeployments(string, string, CatalogsListDeploymentsOptionalParams)	Lists deployments for catalog.
listDeviceGroups(string, string, ListDeviceGroupsRequest, CatalogsListDeviceGroupsOptionalParams)	List the device groups for the catalog.
listDeviceInsights(string, string, CatalogsListDeviceInsightsOptionalParams)	Lists device insights for catalog.
listDevices(string, string, CatalogsListDevicesOptionalParams)	Lists devices for catalog.
update(string, string, CatalogUpdate, CatalogsUpdateOptionalParams)	Update a Catalog

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.

options

CatalogsCreateOrUpdateOptionalParams

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.

options

CatalogsCreateOrUpdateOptionalParams

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>

beginUploadImage(string, string, Image_2, CatalogsUploadImageOptionalParams)

Creates an image. Use this action when the image ID is unknown.

function beginUploadImage(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<SimplePollerLike<OperationState<CatalogsUploadImageHeaders>, CatalogsUploadImageHeaders>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

uploadImageRequest

Image

Image upload request body.

options

CatalogsUploadImageOptionalParams

The options parameters.

Returns

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

beginUploadImageAndWait(string, string, Image_2, CatalogsUploadImageOptionalParams)

Creates an image. Use this action when the image ID is unknown.

function beginUploadImageAndWait(resourceGroupName: string, catalogName: string, uploadImageRequest: Image_2, options?: CatalogsUploadImageOptionalParams): Promise<CatalogsUploadImageHeaders>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

uploadImageRequest

Image

Image upload request body.

options

CatalogsUploadImageOptionalParams

The options parameters.

Returns

Promise<CatalogsUploadImageHeaders>

countDevices(string, string, CatalogsCountDevicesOptionalParams)

Counts devices in catalog.

function countDevices(resourceGroupName: string, catalogName: string, options?: CatalogsCountDevicesOptionalParams): Promise<CountDevicesResponse>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

options

CatalogsCountDevicesOptionalParams

The options parameters.

Returns

Promise<CountDevicesResponse>

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.

options

CatalogsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

listBySubscription(CatalogsListBySubscriptionOptionalParams)

List Catalog resources by subscription ID

function listBySubscription(options?: CatalogsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

Parameters

options

CatalogsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

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

options

CatalogsListDeploymentsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

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.

options

CatalogsListDeviceGroupsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>

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

options

CatalogsListDeviceInsightsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeviceInsight, DeviceInsight[], PageSettings>

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

options

CatalogsListDevicesOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Device, Device[], PageSettings>

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>