CosmosDBForPostgreSqlExtensions.GetCosmosDBForPostgreSqlCluster Method
Definition
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. <item> Mocking. To mock this method, please mock GetCosmosDBForPostgreSqlCluster(String, CancellationToken) instead. </item>
public static Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource> GetCosmosDBForPostgreSqlCluster(this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string clusterName, System.Threading.CancellationToken cancellationToken = default);
static member GetCosmosDBForPostgreSqlCluster : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>
<Extension()>
Public Function GetCosmosDBForPostgreSqlCluster (resourceGroupResource As ResourceGroupResource, clusterName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CosmosDBForPostgreSqlClusterResource)
Parameters
- resourceGroupResource
- ResourceGroupResource
The ResourceGroupResource the method will execute against.
- 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.
resourceGroupResource is null.