Class HealthcareApisIotConnectorCollection

A class representing a collection of HealthcareApisIotConnectorResource and their operations. Each HealthcareApisIotConnectorResource in the collection will belong to the same instance of HealthcareApisWorkspaceResource. To get a HealthcareApisIotConnectorCollection instance call the GetHealthcareApisIotConnectors method from an instance of HealthcareApisWorkspaceResource.

Inheritance
Azure.ResourceManager.ArmCollection
HealthcareApisIotConnectorCollection
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.HealthcareApis.dll
Syntax
public class HealthcareApisIotConnectorCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource>

Constructors

HealthcareApisIotConnectorCollection()

Initializes a new instance of the HealthcareApisIotConnectorCollection class for mocking.

Declaration
protected HealthcareApisIotConnectorCollection ();

Methods

CreateOrUpdate(WaitUntil, String, HealthcareApisIotConnectorData, CancellationToken)

Creates or updates an IoT Connector resource with the specified parameters.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_CreateOrUpdate
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.ResourceManager.ArmOperation<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> CreateOrUpdate (Azure.WaitUntil waitUntil, string iotConnectorName, Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorData 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 iotConnectorName

The name of IoT Connector resource.
HealthcareApisIotConnectorData data

The parameters for creating or updating an IoT Connectors resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName or data is null.

CreateOrUpdateAsync(WaitUntil, String, HealthcareApisIotConnectorData, CancellationToken)

Creates or updates an IoT Connector resource with the specified parameters.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_CreateOrUpdate
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.ResourceManager.ArmOperation<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource>> CreateOrUpdateAsync (Azure.WaitUntil waitUntil, string iotConnectorName, Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorData 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 iotConnectorName

The name of IoT Connector resource.
HealthcareApisIotConnectorData data

The parameters for creating or updating an IoT Connectors resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName or data is null.

Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.Response<bool> Exists (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<bool>> ExistsAsync (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

Get(String, CancellationToken)

Gets the properties of the specified IoT Connector.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> Get (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

GetAll(CancellationToken)

Lists all IoT Connectors for the given workspace

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors
  • Operation IdIotConnectors_ListByWorkspace
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.Pageable<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> GetAll (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

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

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

GetAllAsync(CancellationToken)

Lists all IoT Connectors for the given workspace

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors
  • Operation IdIotConnectors_ListByWorkspace
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.AsyncPageable<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> GetAllAsync (System.Threading.CancellationToken cancellationToken = null);
Parameters
System.Threading.CancellationToken cancellationToken

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

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

GetAsync(String, CancellationToken)

Gets the properties of the specified IoT Connector.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource>> GetAsync (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
public virtual Azure.NullableResponse<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> GetIfExists (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}
  • Operation IdIotConnectors_Get
  • Default Api Version2024-03-31
  • ResourceHealthcareApisIotConnectorResource
Declaration
[System.Diagnostics.DebuggerStepThrough]
public virtual System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource>> GetIfExistsAsync (string iotConnectorName, System.Threading.CancellationToken cancellationToken = null);
Parameters
System.String iotConnectorName

The name of IoT Connector resource.
System.Threading.CancellationToken cancellationToken

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

Exceptions
System.ArgumentException

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

iotConnectorName is null.

Explicit Interface Implementations

IAsyncEnumerable<HealthcareApisIotConnectorResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

Declaration
System.Collections.Generic.IAsyncEnumerator<Azure.ResourceManager.HealthcareApis.HealthcareApisIotConnectorResource> IAsyncEnumerable<HealthcareApisIotConnectorResource>.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<HealthcareApisIotConnectorResource>

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

IEnumerable<HealthcareApisIotConnectorResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

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

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.