IotHubDescriptionCollection Class
Definition
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 IotHubDescriptionResource and their operations. Each IotHubDescriptionResource in the collection will belong to the same instance of ResourceGroupResource. To get an IotHubDescriptionCollection instance call the GetIotHubDescriptions method from an instance of ResourceGroupResource.
public class IotHubDescriptionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.IotHub.IotHubDescriptionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotHub.IotHubDescriptionResource>type IotHubDescriptionCollection = class
inherit ArmCollection
interface seq<IotHubDescriptionResource>
interface IEnumerable
interface IAsyncEnumerable<IotHubDescriptionResource>Public Class IotHubDescriptionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of IotHubDescriptionResource), IEnumerable(Of IotHubDescriptionResource)- Inheritance
- Implements
Constructors
| IotHubDescriptionCollection() |
Initializes a new instance of the IotHubDescriptionCollection 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, IotHubDescriptionData, String, CancellationToken) |
Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
|
| CreateOrUpdateAsync(WaitUntil, String, IotHubDescriptionData, String, CancellationToken) |
Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub. If certain properties are missing in the JSON, updating IoT Hub may cause these values to fallback to default, which may lead to unexpected behavior.
|
| Exists(String, CancellationToken) |
Checks to see if the resource exists in azure.
|
| ExistsAsync(String, CancellationToken) |
Checks to see if the resource exists in azure.
|
| Get(String, CancellationToken) |
Get the non-security related metadata of an IoT hub.
|
| GetAll(CancellationToken) |
Get all the IoT hubs in a resource group.
|
| GetAllAsync(CancellationToken) |
Get all the IoT hubs in a resource group.
|
| GetAsync(String, CancellationToken) |
Get the non-security related metadata of an IoT hub.
|
| GetIfExists(String, CancellationToken) |
Tries to get details for this resource from the service.
|
| GetIfExistsAsync(String, CancellationToken) |
Tries to get details for this resource from the service.
|
| 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<IotHubDescriptionResource>.GetAsyncEnumerator(CancellationToken) |
Returns an enumerator that iterates asynchronously through the collection. |
| IEnumerable.GetEnumerator() |
Returns an enumerator that iterates through a collection. |
| IEnumerable<IotHubDescriptionResource>.GetEnumerator() |
Returns an enumerator that iterates through the collection. |
