SphereCatalogResource.GetDeviceGroupsAsync Method

Definition

List the device groups for the catalog.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups
  • Operation Id: Catalogs_ListDeviceGroups
  • Default Api Version: 2024-04-01
  • Resource: SphereCatalogResource
public virtual Azure.AsyncPageable<Azure.ResourceManager.Sphere.SphereDeviceGroupResource> GetDeviceGroupsAsync (Azure.ResourceManager.Sphere.Models.ListSphereDeviceGroupsContent content, string filter = default, int? top = default, int? skip = default, int? maxpagesize = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDeviceGroupsAsync : Azure.ResourceManager.Sphere.Models.ListSphereDeviceGroupsContent * string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sphere.SphereDeviceGroupResource>
override this.GetDeviceGroupsAsync : Azure.ResourceManager.Sphere.Models.ListSphereDeviceGroupsContent * string * Nullable<int> * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Sphere.SphereDeviceGroupResource>
Public Overridable Function GetDeviceGroupsAsync (content As ListSphereDeviceGroupsContent, Optional filter As String = Nothing, Optional top As Nullable(Of Integer) = Nothing, Optional skip As Nullable(Of Integer) = Nothing, Optional maxpagesize As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SphereDeviceGroupResource)

Parameters

content
ListSphereDeviceGroupsContent

List device groups for catalog.

filter
String

Filter the result list using the given expression.

top
Nullable<Int32>

The number of result items to return.

skip
Nullable<Int32>

The number of result items to skip.

maxpagesize
Nullable<Int32>

The maximum number of result items per page.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

An async collection of SphereDeviceGroupResource that may take multiple service requests to iterate over.

Exceptions

content is null.

Applies to