CosmosDBForPostgreSqlClusterResource Class
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.
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 GetCosmosDBForPostgreSqlClusterResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCosmosDBForPostgreSqlCluster method.
public class CosmosDBForPostgreSqlClusterResource : Azure.ResourceManager.ArmResource
type CosmosDBForPostgreSqlClusterResource = class
inherit ArmResource
Public Class CosmosDBForPostgreSqlClusterResource
Inherits ArmResource
- Inheritance
Constructors
CosmosDBForPostgreSqlClusterResource() |
Initializes a new instance of the CosmosDBForPostgreSqlClusterResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
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
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 of a CosmosDBForPostgreSqlClusterResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes a cluster together with servers in it.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes a cluster together with servers in it.
|
Get(CancellationToken) |
Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
|
GetAsync(CancellationToken) |
Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.
|
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 CosmosDBForPostgreSqlClusterServerResources in the CosmosDBForPostgreSqlCluster. |
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 CosmosDBForPostgreSqlConfigurationResources in the CosmosDBForPostgreSqlCluster. |
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 CosmosDBForPostgreSqlCoordinatorConfigurationResources in the CosmosDBForPostgreSqlCluster. |
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 CosmosDBForPostgreSqlFirewallRuleResources in the CosmosDBForPostgreSqlCluster. |
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 CosmosDBForPostgreSqlNodeConfigurationResources in the CosmosDBForPostgreSqlCluster. |
GetCosmosDBForPostgreSqlPrivateEndpointConnection(String, CancellationToken) |
Gets private endpoint connection.
|
GetCosmosDBForPostgreSqlPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets private endpoint connection.
|
GetCosmosDBForPostgreSqlPrivateEndpointConnections() |
Gets a collection of CosmosDBForPostgreSqlPrivateEndpointConnectionResources in the CosmosDBForPostgreSqlCluster. |
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 CosmosDBForPostgreSqlCluster. |
GetCosmosDBForPostgreSqlRole(String, CancellationToken) |
Gets information about a cluster role.
|
GetCosmosDBForPostgreSqlRoleAsync(String, CancellationToken) |
Gets information about a cluster role.
|
GetCosmosDBForPostgreSqlRoles() |
Gets a collection of CosmosDBForPostgreSqlRoleResources in the CosmosDBForPostgreSqlCluster. |
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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, CancellationToken) |
Promotes read replica cluster to an independent read-write cluster.
|
PromoteReadReplicaAsync(WaitUntil, CancellationToken) |
Promotes read replica cluster to an independent read-write cluster.
|
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.
|
RestartAsync(WaitUntil, CancellationToken) |
Restarts all nodes in the cluster.
|
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.
|
StartAsync(WaitUntil, CancellationToken) |
Starts stopped compute on all cluster nodes.
|
Stop(WaitUntil, CancellationToken) |
Stops compute on all cluster nodes.
|
StopAsync(WaitUntil, CancellationToken) |
Stops compute on all cluster nodes.
|
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.
|
UpdateAsync(WaitUntil, CosmosDBForPostgreSqlClusterPatch, CancellationToken) |
Updates an existing cluster. The request body can contain one or several properties from the cluster definition.
|
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
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 RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
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 RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
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 RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
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 RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
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 RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
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 RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
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. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |
Applies to
Azure SDK for .NET