你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Catalogs interface

表示目录的接口。

方法详细信息

beginCreateOrUpdate(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

创建目录

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Catalog>, Catalog>>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

resource
Catalog

资源创建参数。

options
CatalogsCreateOrUpdateOptionalParams

选项参数。

返回

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

beginCreateOrUpdateAndWait(string, string, Catalog, CatalogsCreateOrUpdateOptionalParams)

创建目录

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, resource: Catalog, options?: CatalogsCreateOrUpdateOptionalParams): Promise<Catalog>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

resource
Catalog

资源创建参数。

options
CatalogsCreateOrUpdateOptionalParams

选项参数。

返回

Promise<Catalog>

beginDelete(string, string, CatalogsDeleteOptionalParams)

删除目录

function beginDelete(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsDeleteOptionalParams

选项参数。

返回

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

beginDeleteAndWait(string, string, CatalogsDeleteOptionalParams)

删除目录

function beginDeleteAndWait(resourceGroupName: string, catalogName: string, options?: CatalogsDeleteOptionalParams): Promise<void>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsDeleteOptionalParams

选项参数。

返回

Promise<void>

beginUploadImage(string, string, Image_2, CatalogsUploadImageOptionalParams)

创建映像。 当映像 ID 未知时,请使用此作。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

uploadImageRequest
Image

图像上传请求正文。

options
CatalogsUploadImageOptionalParams

选项参数。

返回

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

beginUploadImageAndWait(string, string, Image_2, CatalogsUploadImageOptionalParams)

创建映像。 当映像 ID 未知时,请使用此作。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

uploadImageRequest
Image

图像上传请求正文。

options
CatalogsUploadImageOptionalParams

选项参数。

返回

countDevices(string, string, CatalogsCountDevicesOptionalParams)

对目录中的设备进行计数。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsCountDevicesOptionalParams

选项参数。

返回

get(string, string, CatalogsGetOptionalParams)

获取目录

function get(resourceGroupName: string, catalogName: string, options?: CatalogsGetOptionalParams): Promise<Catalog>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsGetOptionalParams

选项参数。

返回

Promise<Catalog>

listByResourceGroup(string, CatalogsListByResourceGroupOptionalParams)

按资源组列出目录资源

function listByResourceGroup(resourceGroupName: string, options?: CatalogsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Catalog, Catalog[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

返回

listBySubscription(CatalogsListBySubscriptionOptionalParams)

按订阅 ID 列出目录资源

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

参数

返回

listDeployments(string, string, CatalogsListDeploymentsOptionalParams)

列出目录的部署。

function listDeployments(resourceGroupName: string, catalogName: string, options?: CatalogsListDeploymentsOptionalParams): PagedAsyncIterableIterator<Deployment, Deployment[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsListDeploymentsOptionalParams

选项参数。

返回

listDeviceGroups(string, string, ListDeviceGroupsRequest, CatalogsListDeviceGroupsOptionalParams)

列出目录的设备组。

function listDeviceGroups(resourceGroupName: string, catalogName: string, listDeviceGroupsRequest: ListDeviceGroupsRequest, options?: CatalogsListDeviceGroupsOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

listDeviceGroupsRequest
ListDeviceGroupsRequest

列出目录的设备组。

options
CatalogsListDeviceGroupsOptionalParams

选项参数。

返回

listDeviceInsights(string, string, CatalogsListDeviceInsightsOptionalParams)

列出目录的设备见解。

function listDeviceInsights(resourceGroupName: string, catalogName: string, options?: CatalogsListDeviceInsightsOptionalParams): PagedAsyncIterableIterator<DeviceInsight, DeviceInsight[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

返回

listDevices(string, string, CatalogsListDevicesOptionalParams)

列出目录的设备。

function listDevices(resourceGroupName: string, catalogName: string, options?: CatalogsListDevicesOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

options
CatalogsListDevicesOptionalParams

选项参数。

返回

update(string, string, CatalogUpdate, CatalogsUpdateOptionalParams)

更新目录

function update(resourceGroupName: string, catalogName: string, properties: CatalogUpdate, options?: CatalogsUpdateOptionalParams): Promise<Catalog>

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

catalogName

string

目录名称

properties
CatalogUpdate

要更新的资源属性。

options
CatalogsUpdateOptionalParams

选项参数。

返回

Promise<Catalog>