SphereDeviceGroupResource.GetSphereDeviceAsync Method

Definition

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.

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

Parameters

deviceName
String

Device name.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

deviceName is null.

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

Applies to