DeviceGroups interface
Interface representing a DeviceGroups.
Methods
| begin |
Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only. |
| begin |
Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only. |
| begin |
Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| begin |
Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| count |
Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| get(string, string, string, string, Device |
Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name. |
| list |
List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name. |
Method Details
beginClaimDevices(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)
Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.
function beginClaimDevices(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, claimDevicesRequest: ClaimDevicesRequest, options?: DeviceGroupsClaimDevicesOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroupsClaimDevicesHeaders>, DeviceGroupsClaimDevicesHeaders>>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.
- claimDevicesRequest
- ClaimDevicesRequest
Bulk claim devices request body.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeviceGroupsClaimDevicesHeaders>, DeviceGroupsClaimDevicesHeaders>>
beginClaimDevicesAndWait(string, string, string, string, ClaimDevicesRequest, DeviceGroupsClaimDevicesOptionalParams)
Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.
function beginClaimDevicesAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, claimDevicesRequest: ClaimDevicesRequest, options?: DeviceGroupsClaimDevicesOptionalParams): Promise<DeviceGroupsClaimDevicesHeaders>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.
- claimDevicesRequest
- ClaimDevicesRequest
Bulk claim devices request body.
The options parameters.
Returns
Promise<DeviceGroupsClaimDevicesHeaders>
beginCreateOrUpdate(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)
Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginCreateOrUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, resource: DeviceGroup, options?: DeviceGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>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.
- resource
- DeviceGroup
Resource create parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>
beginCreateOrUpdateAndWait(string, string, string, string, DeviceGroup, DeviceGroupsCreateOrUpdateOptionalParams)
Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginCreateOrUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, resource: DeviceGroup, options?: DeviceGroupsCreateOrUpdateOptionalParams): Promise<DeviceGroup>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.
- resource
- DeviceGroup
Resource create parameters.
The options parameters.
Returns
Promise<DeviceGroup>
beginDelete(string, string, string, string, DeviceGroupsDeleteOptionalParams)
Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginDelete(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsDeleteOptionalParams): 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.
- options
- DeviceGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, DeviceGroupsDeleteOptionalParams)
Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginDeleteAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsDeleteOptionalParams): 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.
- options
- DeviceGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)
Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginUpdate(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, properties: DeviceGroupUpdate, options?: DeviceGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>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.
- properties
- DeviceGroupUpdate
The resource properties to be updated.
- options
- DeviceGroupsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<DeviceGroup>, DeviceGroup>>
beginUpdateAndWait(string, string, string, string, DeviceGroupUpdate, DeviceGroupsUpdateOptionalParams)
Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function beginUpdateAndWait(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, properties: DeviceGroupUpdate, options?: DeviceGroupsUpdateOptionalParams): Promise<DeviceGroup>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.
- properties
- DeviceGroupUpdate
The resource properties to be updated.
- options
- DeviceGroupsUpdateOptionalParams
The options parameters.
Returns
Promise<DeviceGroup>
countDevices(string, string, string, string, DeviceGroupsCountDevicesOptionalParams)
Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function countDevices(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsCountDevicesOptionalParams): Promise<CountDevicesResponse>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.
The options parameters.
Returns
Promise<CountDevicesResponse>
get(string, string, string, string, DeviceGroupsGetOptionalParams)
Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.
function get(resourceGroupName: string, catalogName: string, productName: string, deviceGroupName: string, options?: DeviceGroupsGetOptionalParams): Promise<DeviceGroup>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
- DeviceGroupsGetOptionalParams
The options parameters.
Returns
Promise<DeviceGroup>
listByProduct(string, string, string, DeviceGroupsListByProductOptionalParams)
List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.
function listByProduct(resourceGroupName: string, catalogName: string, productName: string, options?: DeviceGroupsListByProductOptionalParams): PagedAsyncIterableIterator<DeviceGroup, DeviceGroup[], 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.
The options parameters.