Share via

RestorePoints interface

  • Reference
Package:
@azure/arm-sql

Interface representing a RestorePoints.

Methods

beginCreate(string, string, string, CreateDatabaseRestorePointDefinition, RestorePointsCreateOptionalParams)

Creates a restore point for a data warehouse.
beginCreateAndWait(string, string, string, CreateDatabaseRestorePointDefinition, RestorePointsCreateOptionalParams)

Creates a restore point for a data warehouse.
delete(string, string, string, string, RestorePointsDeleteOptionalParams)

Deletes a restore point.
get(string, string, string, string, RestorePointsGetOptionalParams)

Gets a restore point.
listByDatabase(string, string, string, RestorePointsListByDatabaseOptionalParams)

Gets a list of database restore points.

Method Details

beginCreate(string, string, string, CreateDatabaseRestorePointDefinition, RestorePointsCreateOptionalParams)

Creates a restore point for a data warehouse.

function beginCreate(resourceGroupName: string, serverName: string, databaseName: string, parameters: CreateDatabaseRestorePointDefinition, options?: RestorePointsCreateOptionalParams): Promise<SimplePollerLike<OperationState<RestorePoint>, RestorePoint>>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

parameters
CreateDatabaseRestorePointDefinition

The definition for creating the restore point of this database.

options
RestorePointsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, CreateDatabaseRestorePointDefinition, RestorePointsCreateOptionalParams)

Creates a restore point for a data warehouse.

function beginCreateAndWait(resourceGroupName: string, serverName: string, databaseName: string, parameters: CreateDatabaseRestorePointDefinition, options?: RestorePointsCreateOptionalParams): Promise<RestorePoint>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

parameters
CreateDatabaseRestorePointDefinition

The definition for creating the restore point of this database.

options
RestorePointsCreateOptionalParams

The options parameters.

Returns

Promise<RestorePoint>

delete(string, string, string, string, RestorePointsDeleteOptionalParams)

Deletes a restore point.

function delete(resourceGroupName: string, serverName: string, databaseName: string, restorePointName: string, options?: RestorePointsDeleteOptionalParams): 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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

restorePointName

string

The name of the restore point.

options
RestorePointsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, RestorePointsGetOptionalParams)

Gets a restore point.

function get(resourceGroupName: string, serverName: string, databaseName: string, restorePointName: string, options?: RestorePointsGetOptionalParams): Promise<RestorePoint>

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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

restorePointName

string

The name of the restore point.

options
RestorePointsGetOptionalParams

The options parameters.

Returns

Promise<RestorePoint>

listByDatabase(string, string, string, RestorePointsListByDatabaseOptionalParams)

Gets a list of database restore points.

function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: RestorePointsListByDatabaseOptionalParams): PagedAsyncIterableIterator<RestorePoint, RestorePoint[], 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.

serverName

string

The name of the server.

databaseName

string

The name of the database.

options
RestorePointsListByDatabaseOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<RestorePoint, RestorePoint[], PageSettings>