Share via


MockableCosmosDBForPostgreSqlResourceGroupResource.GetCosmosDBForPostgreSqlClusterAsync Method

Definition

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>> GetCosmosDBForPostgreSqlClusterAsync (string clusterName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCosmosDBForPostgreSqlClusterAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>>
override this.GetCosmosDBForPostgreSqlClusterAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>>
Public Overridable Function GetCosmosDBForPostgreSqlClusterAsync (clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBForPostgreSqlClusterResource))

Parameters

clusterName
String

The name of the cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

clusterName is null.

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

Applies to