SphereProductResource.GetSphereDeviceGroup(String, CancellationToken) Method

Definition

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}
  • Operation Id: DeviceGroups_Get
  • Default Api Version: 2024-04-01
  • Resource: SphereDeviceGroupResource
public virtual Azure.Response<Azure.ResourceManager.Sphere.SphereDeviceGroupResource> GetSphereDeviceGroup (string deviceGroupName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSphereDeviceGroup : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sphere.SphereDeviceGroupResource>
override this.GetSphereDeviceGroup : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.Sphere.SphereDeviceGroupResource>
Public Overridable Function GetSphereDeviceGroup (deviceGroupName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SphereDeviceGroupResource)

Parameters

deviceGroupName
String

Name of device group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

deviceGroupName is null.

deviceGroupName is an empty string, and was expected to be non-empty.

Applies to