Share via


DistributedAvailabilityGroups interface

Interface representing a DistributedAvailabilityGroups.

Methods

beginCreateOrUpdate(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsCreateOrUpdateOptionalParams)

Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.

beginCreateOrUpdateAndWait(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsCreateOrUpdateOptionalParams)

Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.

beginDelete(string, string, string, DistributedAvailabilityGroupsDeleteOptionalParams)

Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

beginDeleteAndWait(string, string, string, DistributedAvailabilityGroupsDeleteOptionalParams)

Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

beginFailover(string, string, string, DistributedAvailabilityGroupsFailoverRequest, DistributedAvailabilityGroupsFailoverOptionalParams)

Performs requested failover type in this distributed availability group.

beginFailoverAndWait(string, string, string, DistributedAvailabilityGroupsFailoverRequest, DistributedAvailabilityGroupsFailoverOptionalParams)

Performs requested failover type in this distributed availability group.

beginSetRole(string, string, string, DistributedAvailabilityGroupSetRole, DistributedAvailabilityGroupsSetRoleOptionalParams)

Sets the role for managed instance in a distributed availability group.

beginSetRoleAndWait(string, string, string, DistributedAvailabilityGroupSetRole, DistributedAvailabilityGroupsSetRoleOptionalParams)

Sets the role for managed instance in a distributed availability group.

beginUpdate(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsUpdateOptionalParams)

Updates a distributed availability group replication mode.

beginUpdateAndWait(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsUpdateOptionalParams)

Updates a distributed availability group replication mode.

get(string, string, string, DistributedAvailabilityGroupsGetOptionalParams)

Gets a distributed availability group info.

listByInstance(string, string, DistributedAvailabilityGroupsListByInstanceOptionalParams)

Gets a list of a distributed availability groups in instance.

Method Details

beginCreateOrUpdate(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsCreateOrUpdateOptionalParams)

Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.

function beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroup, options?: DistributedAvailabilityGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroup

The distributed availability group info.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

beginCreateOrUpdateAndWait(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsCreateOrUpdateOptionalParams)

Creates a distributed availability group between Sql On-Prem and Sql Managed Instance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroup, options?: DistributedAvailabilityGroupsCreateOrUpdateOptionalParams): Promise<DistributedAvailabilityGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroup

The distributed availability group info.

Returns

beginDelete(string, string, string, DistributedAvailabilityGroupsDeleteOptionalParams)

Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

function beginDelete(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, options?: DistributedAvailabilityGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

options
DistributedAvailabilityGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, DistributedAvailabilityGroupsDeleteOptionalParams)

Drops a distributed availability group between Sql On-Prem and Sql Managed Instance.

function beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, options?: DistributedAvailabilityGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

options
DistributedAvailabilityGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailover(string, string, string, DistributedAvailabilityGroupsFailoverRequest, DistributedAvailabilityGroupsFailoverOptionalParams)

Performs requested failover type in this distributed availability group.

function beginFailover(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroupsFailoverRequest, options?: DistributedAvailabilityGroupsFailoverOptionalParams): Promise<SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroupsFailoverRequest

The distributed availability group failover request parameters.

options
DistributedAvailabilityGroupsFailoverOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

beginFailoverAndWait(string, string, string, DistributedAvailabilityGroupsFailoverRequest, DistributedAvailabilityGroupsFailoverOptionalParams)

Performs requested failover type in this distributed availability group.

function beginFailoverAndWait(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroupsFailoverRequest, options?: DistributedAvailabilityGroupsFailoverOptionalParams): Promise<DistributedAvailabilityGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroupsFailoverRequest

The distributed availability group failover request parameters.

options
DistributedAvailabilityGroupsFailoverOptionalParams

The options parameters.

Returns

beginSetRole(string, string, string, DistributedAvailabilityGroupSetRole, DistributedAvailabilityGroupsSetRoleOptionalParams)

Sets the role for managed instance in a distributed availability group.

function beginSetRole(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroupSetRole, options?: DistributedAvailabilityGroupsSetRoleOptionalParams): Promise<SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroupSetRole

The distributed availability group set role request parameters.

options
DistributedAvailabilityGroupsSetRoleOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

beginSetRoleAndWait(string, string, string, DistributedAvailabilityGroupSetRole, DistributedAvailabilityGroupsSetRoleOptionalParams)

Sets the role for managed instance in a distributed availability group.

function beginSetRoleAndWait(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroupSetRole, options?: DistributedAvailabilityGroupsSetRoleOptionalParams): Promise<DistributedAvailabilityGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroupSetRole

The distributed availability group set role request parameters.

options
DistributedAvailabilityGroupsSetRoleOptionalParams

The options parameters.

Returns

beginUpdate(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsUpdateOptionalParams)

Updates a distributed availability group replication mode.

function beginUpdate(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroup, options?: DistributedAvailabilityGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroup

The distributed availability group info.

options
DistributedAvailabilityGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<DistributedAvailabilityGroup>, DistributedAvailabilityGroup>>

beginUpdateAndWait(string, string, string, DistributedAvailabilityGroup, DistributedAvailabilityGroupsUpdateOptionalParams)

Updates a distributed availability group replication mode.

function beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, parameters: DistributedAvailabilityGroup, options?: DistributedAvailabilityGroupsUpdateOptionalParams): Promise<DistributedAvailabilityGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

parameters
DistributedAvailabilityGroup

The distributed availability group info.

options
DistributedAvailabilityGroupsUpdateOptionalParams

The options parameters.

Returns

get(string, string, string, DistributedAvailabilityGroupsGetOptionalParams)

Gets a distributed availability group info.

function get(resourceGroupName: string, managedInstanceName: string, distributedAvailabilityGroupName: string, options?: DistributedAvailabilityGroupsGetOptionalParams): Promise<DistributedAvailabilityGroup>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

distributedAvailabilityGroupName

string

The distributed availability group name.

options
DistributedAvailabilityGroupsGetOptionalParams

The options parameters.

Returns

listByInstance(string, string, DistributedAvailabilityGroupsListByInstanceOptionalParams)

Gets a list of a distributed availability groups in instance.

function listByInstance(resourceGroupName: string, managedInstanceName: string, options?: DistributedAvailabilityGroupsListByInstanceOptionalParams): PagedAsyncIterableIterator<DistributedAvailabilityGroup, DistributedAvailabilityGroup[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

managedInstanceName

string

The name of the managed instance.

Returns