Microsoft Azure SQL Database Disaster Recovery Configurations allow users to set up a failover environment in case of a disaster or outage. This includes configuring geo-replication to replicate data to a secondary region, setting up automatic failover to switch to the secondary region in case of an outage, and configuring point-in-time restore to recover data to a specific point in time.
swagger: '2.0'
info:
title: Microsoft Azure Azure SQL Database disaster recovery configurations
description: >-
Provides create, read, update, delete, and failover functionality for Azure
SQL Database disaster recovery configurations.
version: '2014-04-01'
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration
: get:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsList
description: Lists a server's disaster recovery configuration.
x-ms-examples:
List Replication links:
$ref: ./examples/DisasterRecoveryConfigurationList.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DisasterRecoveryConfigurationListResult'
x-ms-pageable:
nextLinkName:
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}
: delete:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsDelete
description: Deletes a disaster recovery configuration.
x-ms-long-running-operation: true
x-ms-examples:
Delete a disaster recovery configuration:
$ref: ./examples/DisasterRecoveryConfigurationDelete.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- name: disasterRecoveryConfigurationName
in: path
required: true
type: string
description: The name of the disaster recovery configuration to be deleted.
responses:
'200':
description: OK
'202':
description: Accepted
'204':
description: NoContent
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration Disasterrecoveryconfigurationname
put:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsCreateorupdate
description: Creates or updates a disaster recovery configuration.
x-ms-long-running-operation: true
x-ms-examples:
Update a disaster recovery configuration:
$ref: ./examples/DisasterRecoveryConfigurationCreateOrUpdate.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- name: disasterRecoveryConfigurationName
in: path
required: true
type: string
description: >-
The name of the disaster recovery configuration to be
created/updated.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DisasterRecoveryConfiguration'
'201':
description: Created
schema:
$ref: '#/definitions/DisasterRecoveryConfiguration'
'202':
description: Accepted
schema:
$ref: '#/definitions/DisasterRecoveryConfiguration'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration Disasterrecoveryconfigurationname
get:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsGet
description: Gets a disaster recovery configuration.
x-ms-examples:
Get a disaster recovery configuration:
$ref: ./examples/DisasterRecoveryConfigurationGet.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- name: disasterRecoveryConfigurationName
in: path
required: true
type: string
description: The name of the disaster recovery configuration.
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DisasterRecoveryConfiguration'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration Disasterrecoveryconfigurationname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}/failover
: post:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsFailover
description: Fails over from the current primary server to this server.
x-ms-examples:
Failover a disaster recovery configuration:
$ref: ./examples/DisasterRecoveryConfigurationFailover.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- name: disasterRecoveryConfigurationName
in: path
required: true
type: string
description: The name of the disaster recovery configuration to failover.
responses:
'202':
description: Accepted
'204':
description: No Content
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration Disasterrecoveryconfigurationname Failover
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}/forceFailoverAllowDataLoss
: post:
tags:
- DisasterRecoveryConfigurations
operationId: microsoftAzureDisasterrecoveryconfigurationsFailoverallowdataloss
description: >-
Fails over from the current primary server to this server. This
operation might result in data loss.
x-ms-examples:
Failover a disaster recovery configuration:
$ref: ./examples/DisasterRecoveryConfigurationFailover.json
parameters:
- $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
- $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
- $ref: '#/parameters/ServerNameParameter'
- name: disasterRecoveryConfigurationName
in: path
required: true
type: string
description: >-
The name of the disaster recovery configuration to failover
forcefully.
responses:
'202':
description: Accepted
'204':
description: No Content
x-ms-long-running-operation: true
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Disasterrecoveryconfiguration Disasterrecoveryconfigurationname Forcefailoverallowdataloss
definitions:
DisasterRecoveryConfigurationProperties:
properties:
status:
readOnly: true
type: string
description: The status of the disaster recovery configuration.
enum:
- Creating
- Ready
- FailingOver
- Dropping
x-ms-enum:
modelAsString: true
name: DisasterRecoveryConfigurationStatus
autoFailover:
type: string
description: Whether or not failover can be done automatically.
enum:
- 'Off'
- 'On'
x-ms-enum:
modelAsString: true
name: DisasterRecoveryConfigurationAutoFailover
failoverPolicy:
type: string
description: How aggressive the automatic failover should be.
enum:
- Manual
- Automatic
x-ms-enum:
modelAsString: true
name: DisasterRecoveryConfigurationFailoverPolicy
partnerServerId:
type: string
description: Id of the partner server.
logicalServerName:
readOnly: true
type: string
description: Logical name of the server.
partnerLogicalServerName:
readOnly: true
type: string
description: Logical name of the partner server.
role:
readOnly: true
type: string
description: The role of the current server in the disaster recovery configuration.
enum:
- None
- Primary
- Secondary
x-ms-enum:
modelAsString: true
name: DisasterRecoveryConfigurationRole
required:
- autoFailover
- failoverPolicy
- partnerServerId
description: Represents the properties of a disaster recovery configuration.
DisasterRecoveryConfiguration:
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/DisasterRecoveryConfigurationProperties'
description: The properties representing the resource.
type:
readOnly: true
type: string
description: Type of resource this is.
location:
type: string
description: >-
Location of the server that contains this disaster recovery
configuration.
readOnly: true
required:
- properties
allOf:
- $ref: ../../../common/v1/types.json#/definitions/ProxyResource
description: Represents a disaster recovery configuration.
DisasterRecoveryConfigurationListResult:
properties:
value:
type: array
items:
$ref: '#/definitions/DisasterRecoveryConfiguration'
description: The list of disaster recovery configurations housed under the server.
description: Represents the response to a List disaster recovery configuration request.
parameters:
ServerNameParameter:
name: serverName
in: path
required: true
type: string
description: The name of the server.
x-ms-parameter-location: method
DisasterRecoveryConfigurationNameParameter:
name: disasterRecoveryConfigName
in: path
required: true
type: string
description: The name of the disaster recovery configuration.
x-ms-parameter-location: method
securityDefinitions:
azure_auth:
type: oauth2
description: Azure Active Directory OAuth2 Flow
flow: implicit
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
scopes:
user_impersonation: impersonate your user account
tags:
- name: DisasterRecoveryConfigurations