ClustersOperations interface

Package:
@azure/arm-horizondb

Interface representing a Clusters operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
beginFailover
beginFailoverAndWait
beginUpdate
beginUpdateAndWait
createOrReplace

Creates a new HorizonDB cluster or replaces an existing cluster. PointInTimeRestore creates the new Cluster resource and hydrates its service-owned database storage from an available source backup. It does not clone source pools, Pool-scoped endpoints, firewall rules, parameter-group associations, or other child resources. The new Cluster receives its service-generated Cluster-scoped Endpoint named cluster. For restore, postgreSqlVersion must be omitted because the service obtains it from backup metadata; all other new-cluster configuration comes from the request or service defaults. Same-location restore requires and honors pointInTimeUtc and allows creationSourceClusterLocation to be omitted. Cross-location restore requires creationSourceClusterLocation to identify the source cluster's Azure location and requires pointInTimeUtc, but ignores the supplied timestamp and restores the latest available backup. Cross-location responses omit pointInTimeUtc.
delete

Deletes a HorizonDB cluster, its Cluster-scoped Endpoint, and all remaining child resources. For an accepted deletion, the long-running operation remains nonterminal until physical deletion completes and point GET returns 404 Not Found.
failover

Triggers failover within the cluster's designated read-write pool. HorizonDB selects the replacement node using the same eligibility and node-selection rules as automatic failover. The request fails with 409 Conflict when the designated pool is not eligible for failover or another conflicting operation is in progress.
get

Gets information about a HorizonDB cluster.
listByResourceGroup

Lists all HorizonDB clusters in a resource group.
listBySubscription

Lists all HorizonDB clusters in a subscription.
update

Updates an existing HorizonDB cluster.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => Promise<Cluster>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => Promise<void>

beginFailover

Warning

This API is now deprecated.

use failover instead

beginFailover: (resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginFailoverAndWait

Warning

This API is now deprecated.

use failover instead

beginFailoverAndWait: (resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => Promise<Cluster>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

Property Value

(resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Cluster>, Cluster>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => Promise<Cluster>

createOrReplace

Creates a new HorizonDB cluster or replaces an existing cluster. PointInTimeRestore creates the new Cluster resource and hydrates its service-owned database storage from an available source backup. It does not clone source pools, Pool-scoped endpoints, firewall rules, parameter-group associations, or other child resources. The new Cluster receives its service-generated Cluster-scoped Endpoint named cluster. For restore, postgreSqlVersion must be omitted because the service obtains it from backup metadata; all other new-cluster configuration comes from the request or service defaults. Same-location restore requires and honors pointInTimeUtc and allows creationSourceClusterLocation to be omitted. Cross-location restore requires creationSourceClusterLocation to identify the source cluster's Azure location and requires pointInTimeUtc, but ignores the supplied timestamp and restores the latest available backup. Cross-location responses omit pointInTimeUtc.

createOrReplace: (resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, resource: ClusterCreateOrUpdate, options?: ClustersCreateOrReplaceOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

delete

Deletes a HorizonDB cluster, its Cluster-scoped Endpoint, and all remaining child resources. For an accepted deletion, the long-running operation remains nonterminal until physical deletion completes and point GET returns 404 Not Found.

delete: (resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersDeleteOptionalParams) => PollerLike<OperationState<void>, void>

failover

Triggers failover within the cluster's designated read-write pool. HorizonDB selects the replacement node using the same eligibility and node-selection rules as automatic failover. The request fails with 409 Conflict when the designated pool is not eligible for failover or another conflicting operation is in progress.

failover: (resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersFailoverOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

get

Gets information about a HorizonDB cluster.

get: (resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams) => Promise<Cluster>

Property Value

(resourceGroupName: string, clusterName: string, options?: ClustersGetOptionalParams) => Promise<Cluster>

listByResourceGroup

Lists all HorizonDB clusters in a resource group.

listByResourceGroup: (resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Property Value

(resourceGroupName: string, options?: ClustersListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

listBySubscription

Lists all HorizonDB clusters in a subscription.

listBySubscription: (options?: ClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

Property Value

(options?: ClustersListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Cluster, Cluster[], PageSettings>

update

Updates an existing HorizonDB cluster.

update: (resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>

Property Value

(resourceGroupName: string, clusterName: string, properties: ClusterForPatchUpdateUpdate, options?: ClustersUpdateOptionalParams) => PollerLike<OperationState<Cluster>, Cluster>