BackupShortTermRetentionPolicies interface
Interface representing a BackupShortTermRetentionPolicies.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, BackupShortTermRetentionPolicy, BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams)
Updates a database's short term retention policy.
function beginCreateOrUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>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.
- policyName
-
string
The policy name. Should always be "default".
- parameters
- BackupShortTermRetentionPolicy
The short term retention policy info.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
beginCreateOrUpdateAndWait(string, string, string, string, BackupShortTermRetentionPolicy, BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams)
Updates a database's short term retention policy.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<BackupShortTermRetentionPolicy>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.
- policyName
-
string
The policy name. Should always be "default".
- parameters
- BackupShortTermRetentionPolicy
The short term retention policy info.
The options parameters.
Returns
Promise<BackupShortTermRetentionPolicy>
beginUpdate(string, string, string, string, BackupShortTermRetentionPolicy, BackupShortTermRetentionPoliciesUpdateOptionalParams)
Updates a database's short term retention policy.
function beginUpdate(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>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.
- policyName
-
string
The policy name. Should always be "default".
- parameters
- BackupShortTermRetentionPolicy
The short term retention policy info.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<BackupShortTermRetentionPolicy>, BackupShortTermRetentionPolicy>>
beginUpdateAndWait(string, string, string, string, BackupShortTermRetentionPolicy, BackupShortTermRetentionPoliciesUpdateOptionalParams)
Updates a database's short term retention policy.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, parameters: BackupShortTermRetentionPolicy, options?: BackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<BackupShortTermRetentionPolicy>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.
- policyName
-
string
The policy name. Should always be "default".
- parameters
- BackupShortTermRetentionPolicy
The short term retention policy info.
The options parameters.
Returns
Promise<BackupShortTermRetentionPolicy>
get(string, string, string, string, BackupShortTermRetentionPoliciesGetOptionalParams)
Gets a database's short term retention policy.
function get(resourceGroupName: string, serverName: string, databaseName: string, policyName: string, options?: BackupShortTermRetentionPoliciesGetOptionalParams): Promise<BackupShortTermRetentionPolicy>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.
- policyName
-
string
The policy name. Should always be "default".
The options parameters.
Returns
Promise<BackupShortTermRetentionPolicy>
listByDatabase(string, string, string, BackupShortTermRetentionPoliciesListByDatabaseOptionalParams)
Gets a database's short term retention policy.
function listByDatabase(resourceGroupName: string, serverName: string, databaseName: string, options?: BackupShortTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<BackupShortTermRetentionPolicy, BackupShortTermRetentionPolicy[], 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.
The options parameters.