DeviceGroupsClient Interface

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

public interface DeviceGroupsClient

An instance of this class provides access to all the operations defined in DeviceGroupsClient.

Method Summary

Modifier and Type Method and Description
abstract SyncPoller<PollResult<Void>,Void> beginClaimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest)

Bulk claims the devices.
abstract SyncPoller<PollResult<Void>,Void> beginClaimDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName, ClaimDevicesRequest claimDevicesRequest, Context context)

Bulk claims the devices.
abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginCreateOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource)

Create a DeviceGroup.
abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginCreateOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource, Context context)

Create a DeviceGroup.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

Delete a DeviceGroup.
abstract SyncPoller<PollResult<Void>,Void> beginDelete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)

Delete a DeviceGroup.
abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties)

Update a DeviceGroup.
abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties, Context context)

Update a DeviceGroup.
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 CountDevicesResponseInner countDevices(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

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

Counts devices in device group.
abstract DeviceGroupInner createOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource)

Create a DeviceGroup.
abstract DeviceGroupInner createOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource, Context context)

Create a DeviceGroup.
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 DeviceGroupInner get(String resourceGroupName, String catalogName, String productName, String deviceGroupName)

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

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

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

List DeviceGroup resources by Product.
abstract DeviceGroupInner update(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties)

Update a DeviceGroup.
abstract DeviceGroupInner update(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties, Context context)

Update a DeviceGroup.

Method Details

beginClaimDevices

public abstract SyncPoller<PollResult<Void>,Void> beginClaimDevices(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginClaimDevices

public abstract SyncPoller<PollResult<Void>,Void> beginClaimDevices(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginCreateOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource)

Create 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.
resource - Resource create parameters.

Returns:

the SyncPoller<T,U> for polling of an device group resource belonging to a product resource.

beginCreateOrUpdate

public abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginCreateOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource, Context context)

Create 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.
resource - Resource create parameters.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an device group resource belonging to a product resource.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginDelete

public abstract SyncPoller<PollResult<Void>,Void> beginDelete(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.

Returns:

the SyncPoller<T,U> for polling of long-running operation.

beginUpdate

public abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties)

Update 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.
properties - The resource properties to be updated.

Returns:

the SyncPoller<T,U> for polling of an device group resource belonging to a product resource.

beginUpdate

public abstract SyncPoller<PollResult<DeviceGroupInner>,DeviceGroupInner> beginUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties, Context context)

Update 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.
properties - The resource properties to be updated.
context - The context to associate with this operation.

Returns:

the SyncPoller<T,U> for polling of an device group resource belonging to a product resource.

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 CountDevicesResponseInner 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<CountDevicesResponseInner> 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>.

createOrUpdate

public abstract DeviceGroupInner createOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource)

Create 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.
resource - Resource create parameters.

Returns:

an device group resource belonging to a product resource.

createOrUpdate

public abstract DeviceGroupInner createOrUpdate(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupInner resource, Context context)

Create 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.
resource - Resource create parameters.
context - The context to associate with this operation.

Returns:

an device group resource belonging to a product resource.

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.

get

public abstract DeviceGroupInner 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.

getWithResponse

public abstract Response<DeviceGroupInner> 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<DeviceGroupInner> 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<DeviceGroupInner> 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>.

update

public abstract DeviceGroupInner update(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties)

Update 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.
properties - The resource properties to be updated.

Returns:

an device group resource belonging to a product resource.

update

public abstract DeviceGroupInner update(String resourceGroupName, String catalogName, String productName, String deviceGroupName, DeviceGroupUpdate properties, Context context)

Update 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.
properties - The resource properties to be updated.
context - The context to associate with this operation.

Returns:

an device group resource belonging to a product resource.

Applies to