DeviceGroups Interface

Package:
com.azure.resourcemanager.sphere.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-sphere:1.1.0

public interface DeviceGroups

Resource collection API of DeviceGroups.

Method Summary

Modifier and Type Method and Description
abstract void claimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest)

Bulk claims the devices.
abstract void claimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest, Context context)

Bulk claims the devices.
abstract CountDevicesResponse countDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Counts devices in device group.
abstract Response<CountDevicesResponse> countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Counts devices in device group.
abstract Blank define(String name)

Begins definition for a new DeviceGroup resource.
abstract void delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Delete a DeviceGroup.
abstract void delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Delete a DeviceGroup.
abstract void deleteById(String id)

Delete a DeviceGroup.
abstract void deleteByIdWithResponse(String id, Context context)

Delete a DeviceGroup.
abstract DeviceGroup get(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Get a DeviceGroup.
abstract DeviceGroup getById(String id)

Get a DeviceGroup.
abstract Response<DeviceGroup> getByIdWithResponse(String id, Context context)

Get a DeviceGroup.
abstract Response<DeviceGroup> getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Get a DeviceGroup.
abstract PagedIterable<DeviceGroup> listByProduct(String resourceGroupName, String catalogName, String productName)

List DeviceGroup resources by Product.
abstract PagedIterable<DeviceGroup> listByProduct(String resourceGroupName, String catalogName, String productName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)

List DeviceGroup resources by Product.

Method Details

claimDevices

public abstract void claimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest)

Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.
claimDevicesRequest - Bulk claim devices request body.

claimDevices

public abstract void claimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest, Context context)

Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.
claimDevicesRequest - Bulk claim devices request body.
context - The context to associate with this operation.

countDevices

public abstract CountDevicesResponse countDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.

Returns:

response to the action call for count devices in a catalog.

countDevicesWithResponse

public abstract Response<CountDevicesResponse> countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.
context - The context to associate with this operation.

Returns:

response to the action call for count devices in a catalog along with Response<T>.

define

public abstract DeviceGroup.DefinitionStages.Blank define(String name)

Begins definition for a new DeviceGroup resource.

Parameters:

name - resource name.

Returns:

the first stage of the new DeviceGroup definition.

delete

public abstract void delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.

delete

public abstract void delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract DeviceGroup get(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.

Returns:

a DeviceGroup.

getById

public abstract DeviceGroup getById(String id)

Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

id - the resource ID.

Returns:

a DeviceGroup along with Response<T>.

getByIdWithResponse

public abstract Response<DeviceGroup> getByIdWithResponse(String id, Context context)

Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

a DeviceGroup along with Response<T>.

getWithResponse

public abstract Response<DeviceGroup> getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
deviceGroupName - Name of device group.
context - The context to associate with this operation.

Returns:

a DeviceGroup along with Response<T>.

listByProduct

public abstract PagedIterable<DeviceGroup> listByProduct(String resourceGroupName, String catalogName, String productName)

List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.

Returns:

the response of a DeviceGroup list operation as paginated response with PagedIterable<T>.

listByProduct

public abstract PagedIterable<DeviceGroup> listByProduct(String resourceGroupName, String catalogName, String productName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)

List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
catalogName - Name of catalog.
productName - Name of product.
filter - Filter the result list using the given expression.
top - The number of result items to return.
skip - The number of result items to skip.
maxpagesize - The maximum number of result items per page.
context - The context to associate with this operation.

Returns:

the response of a DeviceGroup list operation as paginated response with PagedIterable<T>.

Applies to