SphereDeviceCollection Class

Reference

Definition

Namespace:: Azure.ResourceManager.Sphere

Assembly:: Azure.ResourceManager.Sphere.dll

Package:: Azure.ResourceManager.Sphere v1.0.0

Package:: Azure.ResourceManager.Sphere v1.0.0-beta.2

Source:: SphereDeviceCollection.cs

Source:: SphereDeviceCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class representing a collection of SphereDeviceResource and their operations. Each SphereDeviceResource in the collection will belong to the same instance of SphereDeviceGroupResource. To get a SphereDeviceCollection instance call the GetSphereDevices method from an instance of SphereDeviceGroupResource.

public class SphereDeviceCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Sphere.SphereDeviceResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Sphere.SphereDeviceResource>

type SphereDeviceCollection = class
    inherit ArmCollection
    interface seq<SphereDeviceResource>
    interface IEnumerable
    interface IAsyncEnumerable<SphereDeviceResource>

Public Class SphereDeviceCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of SphereDeviceResource), IEnumerable(Of SphereDeviceResource)

Inheritance: Object

ArmCollection
SphereDeviceCollection

Implements: IAsyncEnumerable<SphereDeviceResource> IEnumerable<SphereDeviceResource> IEnumerable

Constructors

SphereDeviceCollection()

Initializes a new instance of the SphereDeviceCollection class for mocking.

Properties

Client	Gets the ArmClient this resource client was created from. (Inherited from ArmCollection)
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmCollection)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmCollection)
Id	Gets the resource identifier. (Inherited from ArmCollection)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, SphereDeviceData, CancellationToken)	Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName} Operation Id: Devices_CreateOrUpdate Default Api Version: 2024-04-01 Resource: SphereDeviceResource
CreateOrUpdateAsync(WaitUntil, String, SphereDeviceData, CancellationToken)	Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName} Operation Id: Devices_CreateOrUpdate Default Api Version: 2024-04-01 Resource: SphereDeviceResource
Exists(String, CancellationToken)	Checks to see if the resource exists in azure. 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
ExistsAsync(String, CancellationToken)	Checks to see if the resource exists in azure. 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
Get(String, CancellationToken)	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
GetAll(CancellationToken)	List Device resources by 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}/devices Operation Id: Devices_ListByDeviceGroup Default Api Version: 2024-04-01 Resource: SphereDeviceResource
GetAllAsync(CancellationToken)	List Device resources by 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}/devices Operation Id: Devices_ListByDeviceGroup Default Api Version: 2024-04-01 Resource: SphereDeviceResource
GetAsync(String, CancellationToken)	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
GetIfExists(String, CancellationToken)	Tries to get details for this resource from the service. 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
GetIfExistsAsync(String, CancellationToken)	Tries to get details for this resource from the service. 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
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<SphereDeviceResource>.GetAsyncEnumerator(CancellationToken)	Returns an enumerator that iterates asynchronously through the collection.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
IEnumerable<SphereDeviceResource>.GetEnumerator()	Returns an enumerator that iterates through the collection.

Applies to

Share via