Share via


CosmosDBForPostgreSqlClusterCollection Class

Definition

A class representing a collection of CosmosDBForPostgreSqlClusterResource and their operations. Each CosmosDBForPostgreSqlClusterResource in the collection will belong to the same instance of ResourceGroupResource. To get a CosmosDBForPostgreSqlClusterCollection instance call the GetCosmosDBForPostgreSqlClusters method from an instance of ResourceGroupResource.

public class CosmosDBForPostgreSqlClusterCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterResource>
type CosmosDBForPostgreSqlClusterCollection = class
    inherit ArmCollection
    interface seq<CosmosDBForPostgreSqlClusterResource>
    interface IEnumerable
    interface IAsyncEnumerable<CosmosDBForPostgreSqlClusterResource>
Public Class CosmosDBForPostgreSqlClusterCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of CosmosDBForPostgreSqlClusterResource), IEnumerable(Of CosmosDBForPostgreSqlClusterResource)
Inheritance
CosmosDBForPostgreSqlClusterCollection
Implements

Constructors

CosmosDBForPostgreSqlClusterCollection()

Initializes a new instance of the CosmosDBForPostgreSqlClusterCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, CosmosDBForPostgreSqlClusterData, CancellationToken)

Creates a new cluster with servers.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Create
CreateOrUpdateAsync(WaitUntil, String, CosmosDBForPostgreSqlClusterData, CancellationToken)

Creates a new cluster with servers.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Create
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
Get(String, CancellationToken)

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
GetAll(CancellationToken)

Lists all clusters in a resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2
  • Operation Id: Clusters_ListByResourceGroup
GetAllAsync(CancellationToken)

Lists all clusters in a resource group.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2
  • Operation Id: Clusters_ListByResourceGroup
GetAsync(String, CancellationToken)

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
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
  • Operation Id: Clusters_Get
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<CosmosDBForPostgreSqlClusterResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<CosmosDBForPostgreSqlClusterResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to