Share via


CosmosDBForPostgreSqlClusterCollection.Get(String, CancellationToken) 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 Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource> Get (string clusterName, System.Threading.CancellationToken cancellationToken = default);
abstract member Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>
override this.Get : string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>
Public Overridable Function Get (clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBForPostgreSqlClusterResource)

Parameters

clusterName
String

The name of the cluster.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

clusterName is null.

Applies to