CosmosDBForPostgreSqlExtensions.GetCosmosDBForPostgreSqlClusterAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.CosmosDBForPostgreSql

Assembly:: Azure.ResourceManager.CosmosDBForPostgreSql.dll

Package:: Azure.ResourceManager.CosmosDBForPostgreSql v1.0.0

Package:: Azure.ResourceManager.CosmosDBForPostgreSql v1.1.0-beta.1

Source:: CosmosDBForPostgreSqlExtensions.cs

Source:: CosmosDBForPostgreSqlExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

Task<Response<CosmosDBForPostgreSqlClusterResource>>

Exceptions

ArgumentNullException

resourceGroupResource or clusterName is null.

ArgumentException

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

Applies to