DeviceGroups interface

套件:

@azure/arm-sphere

代表 DeviceGroups 的介面。

方法

beginClaimDevices(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)	大量宣告裝置。 僅將裝置大量宣告至目錄時，請針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』。
beginClaimDevicesAndWait(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)	大量宣告裝置。 僅將裝置大量宣告至目錄時，請針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』。
beginCreateOrUpdate(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)	建立 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
beginCreateOrUpdateAndWait(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)	建立 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
beginDelete(string, string, string, string, DeviceGroupsDeleteOptionalParams)	刪除 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
beginDeleteAndWait(string, string, string, string, DeviceGroupsDeleteOptionalParams)	刪除 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
beginUpdate(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)	更新 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
beginUpdateAndWait(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)	更新 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
countDevices(string, string, string, string, DeviceGroupsCountDevicesOptionalParams)	計算裝置群組中的裝置。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
get(string, string, string, string, DeviceGroupsGetOptionalParams)	取得 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。
listByProduct(string, string, string, DeviceGroupsListByProductOptionalParams)	依產品列出 DeviceGroup 資源。 '.default' 和 '.unassigned' 是系統定義的值，無法用於產品名稱。

方法詳細資料

beginClaimDevices(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)

大量宣告裝置。 僅將裝置大量宣告至目錄時，請針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』。

function beginClaimDevices(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, claimDevicesRequest: ClaimDevicesRequest, options?: DeviceGroupsClaimDevicesOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroupsClaimDevicesHeaders>, DeviceGroupsClaimDevicesHeaders>>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

claimDevicesRequest

ClaimDevicesRequest

大量宣告裝置要求本文。

options

DeviceGroupsClaimDevicesOptionalParams

選項參數。

傳回

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

beginClaimDevicesAndWait(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)

大量宣告裝置。 僅將裝置大量宣告至目錄時，請針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』。

function beginClaimDevicesAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, claimDevicesRequest: ClaimDevicesRequest, options?: DeviceGroupsClaimDevicesOptionalParams): Promise<DeviceGroupsClaimDevicesHeaders>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

claimDevicesRequest

ClaimDevicesRequest

大量宣告裝置要求本文。

options

DeviceGroupsClaimDevicesOptionalParams

選項參數。

傳回

Promise<DeviceGroupsClaimDevicesHeaders>

beginCreateOrUpdate(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)

建立 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, resource: DeviceGroup, options?: DeviceGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

resource

DeviceGroup

資源建立參數。

options

DeviceGroupsCreateOrUpdateOptionalParams

選項參數。

傳回

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

beginCreateOrUpdateAndWait(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)

建立 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, resource: DeviceGroup, options?: DeviceGroupsCreateOrUpdateOptionalParams): Promise<DeviceGroup>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

resource

DeviceGroup

資源建立參數。

options

DeviceGroupsCreateOrUpdateOptionalParams

選項參數。

傳回

Promise<DeviceGroup>

beginDelete(string, string, string, string, DeviceGroupsDeleteOptionalParams)

刪除 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

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

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

options

DeviceGroupsDeleteOptionalParams

選項參數。

傳回

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

beginDeleteAndWait(string, string, string, string, DeviceGroupsDeleteOptionalParams)

刪除 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsDeleteOptionalParams): Promise<void>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

options

DeviceGroupsDeleteOptionalParams

選項參數。

傳回

Promise<void>

beginUpdate(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)

更新 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, properties: DeviceGroupUpdate, options?: DeviceGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

properties

DeviceGroupUpdate

要更新的資源屬性。

options

DeviceGroupsUpdateOptionalParams

選項參數。

傳回

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

beginUpdateAndWait(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)

更新 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, properties: DeviceGroupUpdate, options?: DeviceGroupsUpdateOptionalParams): Promise<DeviceGroup>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

properties

DeviceGroupUpdate

要更新的資源屬性。

options

DeviceGroupsUpdateOptionalParams

選項參數。

傳回

Promise<DeviceGroup>

countDevices(string, string, string, string, DeviceGroupsCountDevicesOptionalParams)

計算裝置群組中的裝置。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function countDevices(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsCountDevicesOptionalParams): Promise<CountDevicesResponse>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

options

DeviceGroupsCountDevicesOptionalParams

選項參數。

傳回

Promise<CountDevicesResponse>

get(string, string, string, string, DeviceGroupsGetOptionalParams)

取得 DeviceGroup。 '.default' 和 '.unassigned' 是系統定義的值，不能用於產品或裝置組名。

function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsGetOptionalParams): Promise<DeviceGroup>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

deviceGroupName

string

裝置群組的名稱。

options

DeviceGroupsGetOptionalParams

選項參數。

傳回

Promise<DeviceGroup>

listByProduct(string, string, string, DeviceGroupsListByProductOptionalParams)

依產品列出 DeviceGroup 資源。 '.default' 和 '.unassigned' 是系統定義的值，無法用於產品名稱。

function listByProduct(resourceGroupName: string, catalogName: string, productName: string, options?: DeviceGroupsListByProductOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>

參數

resourceGroupName

string

資源群組的名稱。 名稱不區分大小寫。

catalogName

string

目錄的名稱

productName

string

產品名稱。

options

DeviceGroupsListByProductOptionalParams

選項參數。

傳回

PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], PageSettings>