ConfluentOrganizationResource.GetClustersAsync Method

Definition

Namespace:

Azure.ResourceManager.Confluent

Assembly:

Azure.ResourceManager.Confluent.dll

Package:

Azure.ResourceManager.Confluent v1.2.0

Source:

ConfluentOrganizationResource.cs

Lists of all the clusters in a environment

• Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters
• Operation Id: Organization_ListClusters
• Default Api Version: 2024-02-13
• Resource: ConfluentOrganizationResource

public virtual Azure.AsyncPageable<Azure.ResourceManager.Confluent.Models.SCClusterRecord> GetClustersAsync (string environmentId, int? pageSize = default, string pageToken = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetClustersAsync : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Confluent.Models.SCClusterRecord>
override this.GetClustersAsync : string * Nullable<int> * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Confluent.Models.SCClusterRecord>

Public Overridable Function GetClustersAsync (environmentId As String, Optional pageSize As Nullable(Of Integer) = Nothing, Optional pageToken As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of SCClusterRecord)

Parameters

environmentId

String

Confluent environment id.

pageSize

Nullable<Int32>

Pagination size.

pageToken

String

An opaque pagination token to fetch the next set of records.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

AsyncPageable<SCClusterRecord>

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

Exceptions

ArgumentException

environmentId is an empty string, and was expected to be non-empty.

ArgumentNullException

environmentId is null.