Devices interface

Package:

@azure/arm-sphere

Interface representing a Devices.

Methods

beginCreateOrUpdate(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)	Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.
beginCreateOrUpdateAndWait(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)	Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.
beginDelete(string, string, string, string, string, DevicesDeleteOptionalParams)	Delete a Device
beginDeleteAndWait(string, string, string, string, string, DevicesDeleteOptionalParams)	Delete a Device
beginGenerateCapabilityImage(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)	Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.
beginGenerateCapabilityImageAndWait(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)	Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.
beginUpdate(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)	Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.
beginUpdateAndWait(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)	Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.
get(string, string, string, string, string, DevicesGetOptionalParams)	Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.
listByDeviceGroup(string, string, string, string, DevicesListByDeviceGroupOptionalParams)	List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Method Details

beginCreateOrUpdate(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)

Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.

function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

resource

Device

Resource create parameters.

options

DevicesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, string, string, Device, DevicesCreateOrUpdateOptionalParams)

Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.

function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, resource: Device, options?: DevicesCreateOrUpdateOptionalParams): Promise<Device>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

resource

Device

Resource create parameters.

options

DevicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Device>

beginDelete(string, string, string, string, string, DevicesDeleteOptionalParams)

Delete a Device

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

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

options

DevicesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, DevicesDeleteOptionalParams)

Delete a Device

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

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

options

DevicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginGenerateCapabilityImage(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)

Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.

function beginGenerateCapabilityImage(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SimplePollerLike<OperationState<SignedCapabilityImageResponse>, SignedCapabilityImageResponse>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

generateDeviceCapabilityRequest

GenerateCapabilityImageRequest

Generate capability image request body.

options

DevicesGenerateCapabilityImageOptionalParams

The options parameters.

Returns

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

beginGenerateCapabilityImageAndWait(string, string, string, string, string, GenerateCapabilityImageRequest, DevicesGenerateCapabilityImageOptionalParams)

Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.

function beginGenerateCapabilityImageAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, options?: DevicesGenerateCapabilityImageOptionalParams): Promise<SignedCapabilityImageResponse>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

generateDeviceCapabilityRequest

GenerateCapabilityImageRequest

Generate capability image request body.

options

DevicesGenerateCapabilityImageOptionalParams

The options parameters.

Returns

Promise<SignedCapabilityImageResponse>

beginUpdate(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)

Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.

function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Device>, Device>>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

properties

DeviceUpdate

The resource properties to be updated.

options

DevicesUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, string, DeviceUpdate, DevicesUpdateOptionalParams)

Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.

function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, properties: DeviceUpdate, options?: DevicesUpdateOptionalParams): Promise<Device>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

properties

DeviceUpdate

The resource properties to be updated.

options

DevicesUpdateOptionalParams

The options parameters.

Returns

Promise<Device>

get(string, string, string, string, string, DevicesGetOptionalParams)

Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.

function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, deviceName: string, options?: DevicesGetOptionalParams): Promise<Device>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

deviceName

string

Device name

options

DevicesGetOptionalParams

The options parameters.

Returns

Promise<Device>

listByDeviceGroup(string, string, string, string, DevicesListByDeviceGroupOptionalParams)

List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

function listByDeviceGroup(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DevicesListByDeviceGroupOptionalParams): PagedAsyncIterableIterator<Device, Device[], PageSettings>

Parameters

resourceGroupName

string

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

catalogName

string

Name of catalog

productName

string

Name of product.

deviceGroupName

string

Name of device group.

options

DevicesListByDeviceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Device, Device[], PageSettings>