getFailoverGroup

A failover group. API Version: 2020-11-01-preview.

Using getFailoverGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFailoverGroup(args: GetFailoverGroupArgs, opts?: InvokeOptions): Promise<GetFailoverGroupResult>
function getFailoverGroupOutput(args: GetFailoverGroupOutputArgs, opts?: InvokeOptions): Output<GetFailoverGroupResult>
def get_failover_group(failover_group_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       server_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFailoverGroupResult
def get_failover_group_output(failover_group_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       server_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFailoverGroupResult]
func LookupFailoverGroup(ctx *Context, args *LookupFailoverGroupArgs, opts ...InvokeOption) (*LookupFailoverGroupResult, error)
func LookupFailoverGroupOutput(ctx *Context, args *LookupFailoverGroupOutputArgs, opts ...InvokeOption) LookupFailoverGroupResultOutput

> Note: This function is named LookupFailoverGroup in the Go SDK.

public static class GetFailoverGroup 
{
    public static Task<GetFailoverGroupResult> InvokeAsync(GetFailoverGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetFailoverGroupResult> Invoke(GetFailoverGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetFailoverGroupResult> getFailoverGroup(GetFailoverGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:sql:getFailoverGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

FailoverGroupName string

The name of the failover group.

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.

ServerName string

The name of the server containing the failover group.

FailoverGroupName string

The name of the failover group.

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.

ServerName string

The name of the server containing the failover group.

failoverGroupName String

The name of the failover group.

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.

serverName String

The name of the server containing the failover group.

failoverGroupName string

The name of the failover group.

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.

serverName string

The name of the server containing the failover group.

failover_group_name str

The name of the failover group.

resource_group_name str

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

server_name str

The name of the server containing the failover group.

failoverGroupName String

The name of the failover group.

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.

serverName String

The name of the server containing the failover group.

getFailoverGroup Result

The following output properties are available:

Id string

Resource ID.

Location string

Resource location.

Name string

Resource name.

PartnerServers List<Pulumi.AzureNative.Sql.Outputs.PartnerInfoResponse>

List of partner server information for the failover group.

ReadWriteEndpoint Pulumi.AzureNative.Sql.Outputs.FailoverGroupReadWriteEndpointResponse

Read-write endpoint of the failover group instance.

ReplicationRole string

Local replication role of the failover group instance.

ReplicationState string

Replication state of the failover group instance.

Type string

Resource type.

Databases List<string>

List of databases in the failover group.

ReadOnlyEndpoint Pulumi.AzureNative.Sql.Outputs.FailoverGroupReadOnlyEndpointResponse

Read-only endpoint of the failover group instance.

Tags Dictionary<string, string>

Resource tags.

Id string

Resource ID.

Location string

Resource location.

Name string

Resource name.

PartnerServers []PartnerInfoResponse

List of partner server information for the failover group.

ReadWriteEndpoint FailoverGroupReadWriteEndpointResponse

Read-write endpoint of the failover group instance.

ReplicationRole string

Local replication role of the failover group instance.

ReplicationState string

Replication state of the failover group instance.

Type string

Resource type.

Databases []string

List of databases in the failover group.

ReadOnlyEndpoint FailoverGroupReadOnlyEndpointResponse

Read-only endpoint of the failover group instance.

Tags map[string]string

Resource tags.

id String

Resource ID.

location String

Resource location.

name String

Resource name.

partnerServers List<PartnerInfoResponse>

List of partner server information for the failover group.

readWriteEndpoint FailoverGroupReadWriteEndpointResponse

Read-write endpoint of the failover group instance.

replicationRole String

Local replication role of the failover group instance.

replicationState String

Replication state of the failover group instance.

type String

Resource type.

databases List<String>

List of databases in the failover group.

readOnlyEndpoint FailoverGroupReadOnlyEndpointResponse

Read-only endpoint of the failover group instance.

tags Map<String,String>

Resource tags.

id string

Resource ID.

location string

Resource location.

name string

Resource name.

partnerServers PartnerInfoResponse[]

List of partner server information for the failover group.

readWriteEndpoint FailoverGroupReadWriteEndpointResponse

Read-write endpoint of the failover group instance.

replicationRole string

Local replication role of the failover group instance.

replicationState string

Replication state of the failover group instance.

type string

Resource type.

databases string[]

List of databases in the failover group.

readOnlyEndpoint FailoverGroupReadOnlyEndpointResponse

Read-only endpoint of the failover group instance.

tags {[key: string]: string}

Resource tags.

id str

Resource ID.

location str

Resource location.

name str

Resource name.

partner_servers Sequence[PartnerInfoResponse]

List of partner server information for the failover group.

read_write_endpoint FailoverGroupReadWriteEndpointResponse

Read-write endpoint of the failover group instance.

replication_role str

Local replication role of the failover group instance.

replication_state str

Replication state of the failover group instance.

type str

Resource type.

databases Sequence[str]

List of databases in the failover group.

read_only_endpoint FailoverGroupReadOnlyEndpointResponse

Read-only endpoint of the failover group instance.

tags Mapping[str, str]

Resource tags.

id String

Resource ID.

location String

Resource location.

name String

Resource name.

partnerServers List<Property Map>

List of partner server information for the failover group.

readWriteEndpoint Property Map

Read-write endpoint of the failover group instance.

replicationRole String

Local replication role of the failover group instance.

replicationState String

Replication state of the failover group instance.

type String

Resource type.

databases List<String>

List of databases in the failover group.

readOnlyEndpoint Property Map

Read-only endpoint of the failover group instance.

tags Map<String>

Resource tags.

Supporting Types

FailoverGroupReadOnlyEndpointResponse

FailoverPolicy string

Failover policy of the read-only endpoint for the failover group.

FailoverPolicy string

Failover policy of the read-only endpoint for the failover group.

failoverPolicy String

Failover policy of the read-only endpoint for the failover group.

failoverPolicy string

Failover policy of the read-only endpoint for the failover group.

failover_policy str

Failover policy of the read-only endpoint for the failover group.

failoverPolicy String

Failover policy of the read-only endpoint for the failover group.

FailoverGroupReadWriteEndpointResponse

FailoverPolicy string

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

FailoverWithDataLossGracePeriodMinutes int

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

FailoverPolicy string

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

FailoverWithDataLossGracePeriodMinutes int

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverPolicy String

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverWithDataLossGracePeriodMinutes Integer

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverPolicy string

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverWithDataLossGracePeriodMinutes number

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failover_policy str

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failover_with_data_loss_grace_period_minutes int

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverPolicy String

Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

failoverWithDataLossGracePeriodMinutes Number

Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required.

PartnerInfoResponse

Id string

Resource identifier of the partner server.

Location string

Geo location of the partner server.

ReplicationRole string

Replication role of the partner server.

Id string

Resource identifier of the partner server.

Location string

Geo location of the partner server.

ReplicationRole string

Replication role of the partner server.

id String

Resource identifier of the partner server.

location String

Geo location of the partner server.

replicationRole String

Replication role of the partner server.

id string

Resource identifier of the partner server.

location string

Geo location of the partner server.

replicationRole string

Replication role of the partner server.

id str

Resource identifier of the partner server.

location str

Geo location of the partner server.

replication_role str

Replication role of the partner server.

id String

Resource identifier of the partner server.

location String

Geo location of the partner server.

replicationRole String

Replication role of the partner server.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0