Share via


CosmosDBForPostgreSqlExtensions.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 static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>> GetCosmosDBForPostgreSqlClusterAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBForPostgreSqlClusterAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>>
<Extension()>
Public Function GetCosmosDBForPostgreSqlClusterAsync (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CosmosDBForPostgreSqlClusterResource))

Parameters

resourceGroupResource
ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

clusterName
String

The name of the cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

resourceGroupResource or clusterName is null.

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

Applies to