@datafire/azure_sql_backups

Client library for Azure SQL Database Backup

Installation and Usage

npm install --save @datafire/azure_sql_backups

let azure_sql_backups = require('@datafire/azure_sql_backups').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Provides read functionality for Azure SQL Database Backups

Actions

RecoverableDatabases_ListByServer

Gets a list of recoverable databases

azure_sql_backups.RecoverableDatabases_ListByServer({
  "api-version": "",
  "subscriptionId": "",
  "resourceGroupName": "",
  "serverName": ""
}, context)

Input

• input object
  • api-version required string: The API version to use for the request.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • resourceGroupName required 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 required string: The name of the server.

Output

• output RecoverableDatabaseListResult

RecoverableDatabases_Get

Gets a recoverable database, which is a resource representing a database's geo backup

azure_sql_backups.RecoverableDatabases_Get({
  "api-version": "",
  "subscriptionId": "",
  "resourceGroupName": "",
  "serverName": "",
  "databaseName": ""
}, context)

Input

• input object
  • api-version required string: The API version to use for the request.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • resourceGroupName required 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 required string: The name of the server.
  • databaseName required string: The name of the database

Output

• output RecoverableDatabase

RestorableDroppedDatabases_ListByServer

Gets a list of deleted databases that can be restored

azure_sql_backups.RestorableDroppedDatabases_ListByServer({
  "api-version": "",
  "subscriptionId": "",
  "resourceGroupName": "",
  "serverName": ""
}, context)

Input

• input object
  • api-version required string: The API version to use for the request.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • resourceGroupName required 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 required string: The name of the server.

Output

• output RestorableDroppedDatabaseListResult

RestorableDroppedDatabases_Get

Gets a deleted database that can be restored

azure_sql_backups.RestorableDroppedDatabases_Get({
  "api-version": "",
  "subscriptionId": "",
  "resourceGroupName": "",
  "serverName": "",
  "restorableDroppededDatabaseId": ""
}, context)

Input

• input object
  • api-version required string: The API version to use for the request.
  • subscriptionId required string: The subscription ID that identifies an Azure subscription.
  • resourceGroupName required 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 required string: The name of the server.
  • restorableDroppededDatabaseId required string: The id of the deleted database in the form of databaseName,deletionTimeInFileTimeFormat

Output

• output RestorableDroppedDatabase

Definitions

RecoverableDatabase

• RecoverableDatabase object: A recoverable database
  • properties RecoverableDatabaseProperties
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type.

RecoverableDatabaseListResult

• RecoverableDatabaseListResult object: The response to a list recoverable databases request
  • value required array: A list of recoverable databases
    • items RecoverableDatabase

RecoverableDatabaseProperties

• RecoverableDatabaseProperties object: The properties of a recoverable database
  • edition string: The edition of the database
  • elasticPoolName string: The elastic pool name of the database
  • lastAvailableBackupDate string: The last available backup date of the database (ISO8601 format)
  • serviceLevelObjective string: The service level objective name of the database

RestorableDroppedDatabase

• RestorableDroppedDatabase object: A restorable dropped database
  • location string: The geo-location where the resource lives
  • properties RestorableDroppedDatabaseProperties
  • id string: Resource ID.
  • name string: Resource name.
  • type string: Resource type.

RestorableDroppedDatabaseListResult

• RestorableDroppedDatabaseListResult object: The response to a list restorable dropped databases request
  • value required array: A list of restorable dropped databases
    • items RestorableDroppedDatabase

RestorableDroppedDatabaseProperties

• RestorableDroppedDatabaseProperties object: The properties of a restorable dropped database
  • creationDate string: The creation date of the database (ISO8601 format)
  • databaseName string: The name of the database
  • deletionDate string: The deletion date of the database (ISO8601 format)
  • earliestRestoreDate string: The earliest restore date of the database (ISO8601 format)
  • edition string: The edition of the database
  • elasticPoolName string: The elastic pool name of the database
  • maxSizeBytes string: The max size in bytes of the database
  • serviceLevelObjective string: The service level objective name of the database