Class IotOperationsBrokerAuthenticationCollection

A class representing a collection of IotOperationsBrokerAuthenticationResource and their operations. Each IotOperationsBrokerAuthenticationResource in the collection will belong to the same instance of IotOperationsBrokerResource. To get an IotOperationsBrokerAuthenticationCollection instance call the GetIotOperationsBrokerAuthentications method from an instance of IotOperationsBrokerResource.

Inheritance
Azure.ResourceManager.ArmCollection
IotOperationsBrokerAuthenticationCollection
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.IotOperations.dll
Syntax
public class IotOperationsBrokerAuthenticationCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource>

Constructors

IotOperationsBrokerAuthenticationCollection()

Initializes a new instance of the IotOperationsBrokerAuthenticationCollection class for mocking.

Declaration
protected IotOperationsBrokerAuthenticationCollection ();

Methods

CreateOrUpdate(WaitUntil, String, IotOperationsBrokerAuthenticationData, CancellationToken)

Create a BrokerAuthenticationResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_CreateOrUpdate
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string authenticationName, Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationData data, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
System.String authenticationName

Name of Instance broker authentication resource.
IotOperationsBrokerAuthenticationData data

Resource create parameters.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.ResourceManager.ArmOperation<IotOperationsBrokerAuthenticationResource>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName or data is null.

CreateOrUpdateAsync(WaitUntil, String, IotOperationsBrokerAuthenticationData, CancellationToken)

Create a BrokerAuthenticationResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_CreateOrUpdate
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string authenticationName, Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationData data, System.Threading.CancellationToken cancellationToken = null);
Parameters
Azure.WaitUntil waitUntil

Azure.WaitUntil.Completed if the method should wait to return until the long-running operation has completed on the service; Azure.WaitUntil.Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
System.String authenticationName

Name of Instance broker authentication resource.
IotOperationsBrokerAuthenticationData data

Resource create parameters.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<IotOperationsBrokerAuthenticationResource>>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName or data is null.

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.Response<bool> Exists (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<System.Boolean>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<System.Boolean>>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

Get(String, CancellationToken)

Get a BrokerAuthenticationResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> Get (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Response<IotOperationsBrokerAuthenticationResource>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

GetAll(CancellationToken)

List BrokerAuthenticationResource resources by BrokerResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications
  • Operation IdBrokerAuthenticationResource_ListByResourceGroup
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.Pageable<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> GetAll (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.Pageable<IotOperationsBrokerAuthenticationResource>

A collection of IotOperationsBrokerAuthenticationResource that may take multiple service requests to iterate over.

GetAllAsync(CancellationToken)

List BrokerAuthenticationResource resources by BrokerResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications
  • Operation IdBrokerAuthenticationResource_ListByResourceGroup
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.AsyncPageable<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> GetAllAsync (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.AsyncPageable<IotOperationsBrokerAuthenticationResource>

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

GetAsync(String, CancellationToken)

Get a BrokerAuthenticationResource

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource>> GetAsync (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.Response<IotOperationsBrokerAuthenticationResource>>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
public virtual Azure.NullableResponse<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> GetIfExists (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
Azure.NullableResponse<IotOperationsBrokerAuthenticationResource>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
  • Operation IdBrokerAuthenticationResource_Get
  • Default Api Version2025-07-01-preview
  • ResourceIotOperationsBrokerAuthenticationResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource>> GetIfExistsAsync (string authenticationName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String authenticationName

Name of Instance broker authentication resource.
System.Threading.CancellationToken cancellationToken

The cancellation token to use.
Returns
System.Threading.Tasks.Task<Azure.NullableResponse<IotOperationsBrokerAuthenticationResource>>

Exceptions
System.ArgumentException

authenticationName is an empty string, and was expected to be non-empty.
System.ArgumentNullException

authenticationName is null.

Explicit Interface Implementations

IAsyncEnumerable<IotOperationsBrokerAuthenticationResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

Declaration
System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> IAsyncEnumerable<IotOperationsBrokerAuthenticationResource>.GetAsyncEnumerator (System.Threading.CancellationToken cancellationToken);
Parameters
System.Threading.CancellationToken cancellationToken

A System.Threading.CancellationToken that may be used to cancel the asynchronous iteration.
Returns
System.Collections.Generic.IAsyncEnumerator<IotOperationsBrokerAuthenticationResource>

An enumerator that can be used to iterate asynchronously through the collection.

IEnumerable<IotOperationsBrokerAuthenticationResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration
System.Collections.Generic.IEnumerator<Azure.ResourceManager.IotOperations.IotOperationsBrokerAuthenticationResource> IEnumerable<IotOperationsBrokerAuthenticationResource>.GetEnumerator ();
Returns
System.Collections.Generic.IEnumerator<IotOperationsBrokerAuthenticationResource>

An enumerator that can be used to iterate through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Declaration
System.Collections.IEnumerator IEnumerable.GetEnumerator ();
Returns
System.Collections.IEnumerator

An System.Collections.IEnumerator object that can be used to iterate through the collection.