CosmosDBForPostgreSqlClusterResource Class

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.3

Source:: CosmosDBForPostgreSqlClusterResource.cs

Source:: CosmosDBForPostgreSqlClusterResource.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.

A class representing a CosmosDBForPostgreSqlCluster along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CosmosDBForPostgreSqlClusterResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCosmosDBForPostgreSqlClusters method.

public class CosmosDBForPostgreSqlClusterResource : Azure.ResourceManager.ArmResource

public class CosmosDBForPostgreSqlClusterResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterData>

type CosmosDBForPostgreSqlClusterResource = class
    inherit ArmResource

type CosmosDBForPostgreSqlClusterResource = class
    inherit ArmResource
    interface IJsonModel<CosmosDBForPostgreSqlClusterData>
    interface IPersistableModel<CosmosDBForPostgreSqlClusterData>

Public Class CosmosDBForPostgreSqlClusterResource
Inherits ArmResource

Public Class CosmosDBForPostgreSqlClusterResource
Inherits ArmResource
Implements IJsonModel(Of CosmosDBForPostgreSqlClusterData), IPersistableModel(Of CosmosDBForPostgreSqlClusterData)

Inheritance: Object

ArmResource
CosmosDBForPostgreSqlClusterResource

Implements: IJsonModel<CosmosDBForPostgreSqlClusterData> IPersistableModel<CosmosDBForPostgreSqlClusterData> IPersistableModel<T>

Constructors

Name	Description
CosmosDBForPostgreSqlClusterResource()	Initializes a new instance of CosmosDBForPostgreSqlClusterResource for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
AddTag(String, String, CancellationToken)	Add a tag to the current resource.
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource.
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier for this resource.
Delete(WaitUntil, CancellationToken)	Deletes a cluster together with servers in it. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}. Operation Id. : Clusters_Delete. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
DeleteAsync(WaitUntil, CancellationToken)	Deletes a cluster together with servers in it. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}. Operation Id. : Clusters_Delete. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
Get(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. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
GetAsync(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. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetCosmosDBForPostgreSqlClusterServer(String, CancellationToken)	Gets information about a server in cluster.
GetCosmosDBForPostgreSqlClusterServerAsync(String, CancellationToken)	Gets information about a server in cluster.
GetCosmosDBForPostgreSqlClusterServers()	Gets a collection of CosmosDBForPostgreSqlClusterServers in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlConfiguration(String, CancellationToken)	Gets information of a configuration for coordinator and nodes.
GetCosmosDBForPostgreSqlConfigurationAsync(String, CancellationToken)	Gets information of a configuration for coordinator and nodes.
GetCosmosDBForPostgreSqlConfigurations()	Gets a collection of CosmosDBForPostgreSqlConfigurations in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlCoordinatorConfiguration(String, CancellationToken)	Gets information of a configuration for coordinator.
GetCosmosDBForPostgreSqlCoordinatorConfigurationAsync(String, CancellationToken)	Gets information of a configuration for coordinator.
GetCosmosDBForPostgreSqlCoordinatorConfigurations()	Gets a collection of CosmosDBForPostgreSqlCoordinatorConfigurations in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlFirewallRule(String, CancellationToken)	Gets information about a cluster firewall rule.
GetCosmosDBForPostgreSqlFirewallRuleAsync(String, CancellationToken)	Gets information about a cluster firewall rule.
GetCosmosDBForPostgreSqlFirewallRules()	Gets a collection of CosmosDBForPostgreSqlFirewallRules in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlNodeConfiguration(String, CancellationToken)	Gets information of a configuration for worker nodes.
GetCosmosDBForPostgreSqlNodeConfigurationAsync(String, CancellationToken)	Gets information of a configuration for worker nodes.
GetCosmosDBForPostgreSqlNodeConfigurations()	Gets a collection of CosmosDBForPostgreSqlNodeConfigurations in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlPrivateEndpointConnection(String, CancellationToken)	Gets private endpoint connection.
GetCosmosDBForPostgreSqlPrivateEndpointConnectionAsync(String, CancellationToken)	Gets private endpoint connection.
GetCosmosDBForPostgreSqlPrivateEndpointConnections()	Gets a collection of CosmosDBForPostgreSqlPrivateEndpointConnections in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlPrivateLinkResource(String, CancellationToken)	Gets a private link resource for cluster.
GetCosmosDBForPostgreSqlPrivateLinkResourceAsync(String, CancellationToken)	Gets a private link resource for cluster.
GetCosmosDBForPostgreSqlPrivateLinkResources()	Gets a collection of CosmosDBForPostgreSqlPrivateLinkResources in the CosmosDBForPostgreSqlClusterResource.
GetCosmosDBForPostgreSqlRole(String, CancellationToken)	Gets information about a cluster role.
GetCosmosDBForPostgreSqlRoleAsync(String, CancellationToken)	Gets information about a cluster role.
GetCosmosDBForPostgreSqlRoles()	Gets a collection of CosmosDBForPostgreSqlRoles in the CosmosDBForPostgreSqlClusterResource.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
PromoteReadReplica(WaitUntil, CosmosDBForPostgreSqlPromoteRequestContent, CancellationToken)	Promotes read replica cluster to an independent read-write cluster. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/promote. Operation Id. : Clusters_PromoteReadReplica. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
PromoteReadReplicaAsync(WaitUntil, CosmosDBForPostgreSqlPromoteRequestContent, CancellationToken)	Promotes read replica cluster to an independent read-write cluster. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/promote. Operation Id. : Clusters_PromoteReadReplica. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource.
Restart(WaitUntil, CancellationToken)	Restarts all nodes in the cluster. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/restart. Operation Id. : Clusters_Restart. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
RestartAsync(WaitUntil, CancellationToken)	Restarts all nodes in the cluster. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/restart. Operation Id. : Clusters_Restart. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
Start(WaitUntil, CancellationToken)	Starts stopped compute on all cluster nodes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/start. Operation Id. : Clusters_Start. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
StartAsync(WaitUntil, CancellationToken)	Starts stopped compute on all cluster nodes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/start. Operation Id. : Clusters_Start. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
Stop(WaitUntil, CancellationToken)	Stops compute on all cluster nodes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/stop. Operation Id. : Clusters_Stop. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
StopAsync(WaitUntil, CancellationToken)	Stops compute on all cluster nodes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/stop. Operation Id. : Clusters_Stop. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, CosmosDBForPostgreSqlClusterPatch, CancellationToken)	Updates an existing cluster. The request body can contain one or several properties from the cluster definition. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}. Operation Id. : Clusters_Update. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.
UpdateAsync(WaitUntil, CosmosDBForPostgreSqlClusterPatch, CancellationToken)	Updates an existing cluster. The request body can contain one or several properties from the cluster definition. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}. Operation Id. : Clusters_Update. Default Api Version. : 2023-03-02-preview. Resource. : CosmosDBForPostgreSqlClusterResource.

Explicit Interface Implementations

Name	Description
IJsonModel<CosmosDBForPostgreSqlClusterData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CosmosDBForPostgreSqlClusterData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CosmosDBForPostgreSqlClusterData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CosmosDBForPostgreSqlClusterData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CosmosDBForPostgreSqlClusterData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?