Devices interface
代表裝置的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)
建立裝置。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,僅向目錄宣告裝置。
function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- resource
- Device
資源建立參數。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Device>, Device>>
beginCreateOrUpdateAndWait(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)
建立裝置。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,僅向目錄宣告裝置。
function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<Device>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- resource
- Device
資源建立參數。
選項參數。
傳回
Promise<Device>
beginDelete(string, string, string, string, string, DevicesDeleteOptionalParams)
刪除裝置
function beginDelete(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- options
- DevicesDeleteOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, string, DevicesDeleteOptionalParams)
刪除裝置
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesDeleteOptionalParams): Promise<void>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- options
- DevicesDeleteOptionalParams
選項參數。
傳回
Promise<void>
beginGenerateCapabilityImage(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)
產生裝置的功能映像。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,為不屬於特定裝置群組和產品的裝置產生映像。
function beginGenerateCapabilityImage(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SimplePollerLike<OperationState<SignedCapabilityImageResponse>, SignedCapabilityImageResponse>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- generateDeviceCapabilityRequest
- GenerateCapabilityImageRequest
產生功能映像要求本文。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<SignedCapabilityImageResponse>, SignedCapabilityImageResponse>>
beginGenerateCapabilityImageAndWait(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)
產生裝置的功能映像。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,為不屬於特定裝置群組和產品的裝置產生映像。
function beginGenerateCapabilityImageAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SignedCapabilityImageResponse>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- generateDeviceCapabilityRequest
- GenerateCapabilityImageRequest
產生功能映像要求本文。
選項參數。
傳回
Promise<SignedCapabilityImageResponse>
beginUpdate(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)
更新裝置。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,將裝置移至類別目錄層級。
function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- properties
- DeviceUpdate
要更新的資源屬性。
- options
- DevicesUpdateOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<Device>, Device>>
beginUpdateAndWait(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)
更新裝置。 針對裝置群組和產品名稱使用 『.unassigned』 或 『.default』,將裝置移至類別目錄層級。
function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<Device>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- properties
- DeviceUpdate
要更新的資源屬性。
- options
- DevicesUpdateOptionalParams
選項參數。
傳回
Promise<Device>
get(string, string, string, string, string, DevicesGetOptionalParams)
取得裝置。 當裝置不屬於裝置群組和產品時,請使用 『.unassigned』 或 『.default』 作為裝置群組和產品名稱。
function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesGetOptionalParams): Promise<Device>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
- deviceName
-
string
裝置名稱
- options
- DevicesGetOptionalParams
選項參數。
傳回
Promise<Device>
listByDeviceGroup(string, string, string, string, DevicesListByDeviceGroupOptionalParams)
列出 DeviceGroup 的裝置資源。 '.default' 和 '.unassigned' 是系統定義的值,不能用於產品或裝置組名。
function listByDeviceGroup(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DevicesListByDeviceGroupOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>
參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- catalogName
-
string
目錄的名稱
- productName
-
string
產品名稱。
- deviceGroupName
-
string
裝置群組的名稱。
選項參數。