openapi-directory/api/azure.com/sql-disasterRecoveryConfigurations.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Provides create, read, update, delete, and failover functionality for Azure SQL Database disaster recovery configurations.","title":"Azure SQL Database disaster recovery configurations","version":"2014-04-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/disasterRecoveryConfigurations.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-disasterRecoveryConfigurations","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration":{"get":{"description":"Lists a server's disaster recovery configuration.","operationId":"DisasterRecoveryConfigurations_List","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List Replication links":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List Replication links":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List Replication links":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisasterRecoveryConfigurationListResult"},"examples":{"List Replication links":{"$ref":"#/components/examples/List_Replication_links"}}}}}},"tags":["DisasterRecoveryConfigurations"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}":{"delete":{"description":"Deletes a disaster recovery configuration.","operationId":"DisasterRecoveryConfigurations_Delete","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Delete a disaster recovery configuration":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Delete a disaster recovery configuration":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a disaster recovery configuration":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the disaster recovery configuration to be deleted.","in":"path","name":"disasterRecoveryConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Delete a disaster recovery configuration":{"value":"Default"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"Accepted"},"204":{"description":"NoContent"}},"tags":["DisasterRecoveryConfigurations"],"x-ms-long-running-operation":true},"get":{"description":"Gets a disaster recovery configuration.","operationId":"DisasterRecoveryConfigurations_Get","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get a disaster recovery configuration":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get a disaster recovery configuration":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get a disaster recovery configuration":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the disaster recovery configuration.","in":"path","name":"disasterRecoveryConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Get a disaster recovery configuration":{"value":"Default"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisasterRecoveryConfiguration"},"examples":{"Get a disaster recovery configuration":{"$ref":"#/components/examples/Get_a_disaster_recovery_configuration"}}}}}},"tags":["DisasterRecoveryConfigurations"]},"put":{"description":"Creates or updates a disaster recovery configuration.","operationId":"DisasterRecoveryConfigurations_CreateOrUpdate","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Update a disaster recovery configuration":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Update a disaster recovery configuration":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Update a disaster recovery configuration":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the disaster recovery configuration to be created/updated.","in":"path","name":"disasterRecoveryConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Update a disaster recovery configuration":{"value":"Default"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisasterRecoveryConfiguration"},"examples":{"Update a disaster recovery configuration":{"$ref":"#/components/examples/Update_a_disaster_recovery_configuration"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisasterRecoveryConfiguration"},"examples":{"Update a disaster recovery configuration":{"$ref":"#/components/examples/Update_a_disaster_recovery_configuration"}}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisasterRecoveryConfiguration"},"examples":{"Update a disaster recovery configuration":{"$ref":"#/components/examples/Update_a_disaster_recovery_configuration"}}}}}},"tags":["DisasterRecoveryConfigurations"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}/failover":{"post":{"description":"Fails over from the current primary server to this server.","operationId":"DisasterRecoveryConfigurations_Failover","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the disaster recovery configuration to failover.","in":"path","name":"disasterRecoveryConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"Default"}}}],"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"}},"tags":["DisasterRecoveryConfigurations"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/disasterRecoveryConfiguration/{disasterRecoveryConfigurationName}/forceFailoverAllowDataLoss":{"post":{"description":"Fails over from the current primary server to this server. This operation might result in data loss.","operationId":"DisasterRecoveryConfigurations_FailoverAllowDataLoss","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"00000000-1111-2222-3333-444444444444"}}},{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"sqlcrudtest-4799"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the disaster recovery configuration to failover forcefully.","in":"path","name":"disasterRecoveryConfigurationName","required":true,"schema":{"type":"string"},"examples":{"Failover a disaster recovery configuration":{"value":"Default"}}}],"responses":{"202":{"description":"Accepted"},"204":{"description":"No Content"}},"tags":["DisasterRecoveryConfigurations"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_Replication_links":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default","location":"West US","name":"Default","properties":{"autoFailover":"On","failoverPolicy":"Automatic","logicalServerName":"sqlcrudtest-5961","partnerLogicalServerName":"sqlcrudtest-5962","partnerServerId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5962","role":"Primary","status":"Ready"},"type":"Microsoft.Sql/servers/disasterRecoveryConfigurations"}]}},"Get_a_disaster_recovery_configuration":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default","location":"West US","name":"Default","properties":{"autoFailover":"On","failoverPolicy":"Automatic","logicalServerName":"sqlcrudtest-5961","partnerLogicalServerName":"sqlcrudtest-5962","partnerServerId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5962","role":"Primary","status":"Ready"},"type":"Microsoft.Sql/servers/disasterRecoveryConfigurations"}},"Update_a_disaster_recovery_configuration":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/testdw/geoBackupPolicies/Default","location":"West US","name":"Default","properties":{"autoFailover":"On","failoverPolicy":"Automatic","logicalServerName":"sqlcrudtest-5961","partnerLogicalServerName":"sqlcrudtest-5962","partnerServerId":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-5962","role":"Primary","status":"Ready"},"type":"Microsoft.Sql/servers/disasterRecoveryConfigurations"}}},"parameters":{"DisasterRecoveryConfigurationNameParameter":{"description":"The name of the disaster recovery configuration.","in":"path","name":"disasterRecoveryConfigName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List Replication links":{"value":"sqlcrudtest-5961"},"Delete a disaster recovery configuration":{"value":"sqlcrudtest-5961"},"Get a disaster recovery configuration":{"value":"sqlcrudtest-5961"},"Update a disaster recovery configuration":{"value":"sqlcrudtest-5961"},"Failover a disaster recovery configuration":{"value":"sqlcrudtest-5962"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"DisasterRecoveryConfiguration":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Represents a disaster recovery configuration.","properties":{"location":{"description":"Location of the server that contains this disaster recovery configuration.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/DisasterRecoveryConfigurationProperties"},"type":{"description":"Type of resource this is.","readOnly":true,"type":"string"}},"required":["properties"]},"DisasterRecoveryConfigurationListResult":{"description":"Represents the response to a List disaster recovery configuration request.","properties":{"value":{"description":"The list of disaster recovery configurations housed under the server.","items":{"$ref":"#/components/schemas/DisasterRecoveryConfiguration"},"type":"array"}}},"DisasterRecoveryConfigurationProperties":{"description":"Represents the properties of a disaster recovery configuration.","properties":{"autoFailover":{"description":"Whether or not failover can be done automatically.","enum":["Off","On"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"DisasterRecoveryConfigurationAutoFailover"}},"failoverPolicy":{"description":"How aggressive the automatic failover should be.","enum":["Manual","Automatic"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"DisasterRecoveryConfigurationFailoverPolicy"}},"logicalServerName":{"description":"Logical name of the server.","readOnly":true,"type":"string"},"partnerLogicalServerName":{"description":"Logical name of the partner server.","readOnly":true,"type":"string"},"partnerServerId":{"description":"Id of the partner server.","type":"string"},"role":{"description":"The role of the current server in the disaster recovery configuration.","enum":["None","Primary","Secondary"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"DisasterRecoveryConfigurationRole"}},"status":{"description":"The status of the disaster recovery configuration.","enum":["Creating","Ready","FailingOver","Dropping"],"readOnly":true,"type":"string","x-ms-enum":{"modelAsString":true,"name":"DisasterRecoveryConfigurationStatus"}}},"required":["autoFailover","failoverPolicy","partnerServerId"]}}}}