BackupsLongTermRetention interface
Interface representing a BackupsLongTermRetention.
Methods
| begin |
Initiates a long term retention backup. |
| begin |
Initiates a long term retention backup. |
| check |
Performs all checks required for a long term retention backup operation to succeed. |
| get(string, string, string, Backups |
Gets the results of a long retention backup operation for a server. |
| list |
Lists the results of the long term retention backup operations for a server. |
Method Details
beginStart(string, string, BackupsLongTermRetentionRequest, BackupsLongTermRetentionStartOptionalParams)
Initiates a long term retention backup.
function beginStart(resourceGroupName: string, serverName: string, parameters: BackupsLongTermRetentionRequest, options?: BackupsLongTermRetentionStartOptionalParams): Promise<SimplePollerLike<OperationState<BackupsLongTermRetentionStartResponse>, BackupsLongTermRetentionStartResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- BackupsLongTermRetentionRequest
Request body for operation
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupsLongTermRetentionStartResponse>, BackupsLongTermRetentionStartResponse>>
beginStartAndWait(string, string, BackupsLongTermRetentionRequest, BackupsLongTermRetentionStartOptionalParams)
Initiates a long term retention backup.
function beginStartAndWait(resourceGroupName: string, serverName: string, parameters: BackupsLongTermRetentionRequest, options?: BackupsLongTermRetentionStartOptionalParams): Promise<BackupsLongTermRetentionStartResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- BackupsLongTermRetentionRequest
Request body for operation
The options parameters.
Returns
checkPrerequisites(string, string, LtrPreBackupRequest, BackupsLongTermRetentionCheckPrerequisitesOptionalParams)
Performs all checks required for a long term retention backup operation to succeed.
function checkPrerequisites(resourceGroupName: string, serverName: string, parameters: LtrPreBackupRequest, options?: BackupsLongTermRetentionCheckPrerequisitesOptionalParams): Promise<BackupsLongTermRetentionCheckPrerequisitesResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- LtrPreBackupRequest
Request body for operation
The options parameters.
Returns
get(string, string, string, BackupsLongTermRetentionGetOptionalParams)
Gets the results of a long retention backup operation for a server.
function get(resourceGroupName: string, serverName: string, backupName: string, options?: BackupsLongTermRetentionGetOptionalParams): Promise<BackupsLongTermRetentionOperation>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- backupName
-
string
The name of the backup.
The options parameters.
Returns
Promise<BackupsLongTermRetentionOperation>
listByServer(string, string, BackupsLongTermRetentionListByServerOptionalParams)
Lists the results of the long term retention backup operations for a server.
function listByServer(resourceGroupName: string, serverName: string, options?: BackupsLongTermRetentionListByServerOptionalParams): PagedAsyncIterableIterator<BackupsLongTermRetentionOperation, BackupsLongTermRetentionOperation[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
The options parameters.