Package version:

Interface ManagedBackupShortTermRetentionPolicies

Interface representing a ManagedBackupShortTermRetentionPolicies.

Hierarchy

ManagedBackupShortTermRetentionPolicies

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginUpdate beginUpdateAndWait get listByDatabase

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedBackupShortTermRetentionPolicy, options?: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>
Updates a managed database's short term retention policy.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name. Should always be "default".
- parameters: ManagedBackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:66

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedBackupShortTermRetentionPolicy, options?: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams): Promise<ManagedBackupShortTermRetentionPolicy>
Updates a managed database's short term retention policy.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name. Should always be "default".
- parameters: ManagedBackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedBackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:91

beginUpdate

beginUpdate(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedBackupShortTermRetentionPolicy, options?: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>
Updates a managed database's short term retention policy.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name. Should always be "default".
- parameters: ManagedBackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:109

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, parameters: ManagedBackupShortTermRetentionPolicy, options?: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams): Promise<ManagedBackupShortTermRetentionPolicy>
Updates a managed database's short term retention policy.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name. Should always be "default".
- parameters: ManagedBackupShortTermRetentionPolicy
  
  The short term retention policy info.
- Optional options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedBackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:132

get

get(resourceGroupName: string, managedInstanceName: string, databaseName: string, policyName: string, options?: ManagedBackupShortTermRetentionPoliciesGetOptionalParams): Promise<ManagedBackupShortTermRetentionPolicy>
Gets a managed database's short term retention policy.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- policyName: string
  
  The policy name.
- Optional options: ManagedBackupShortTermRetentionPoliciesGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedBackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:49

listByDatabase

listByDatabase(resourceGroupName: string, managedInstanceName: string, databaseName: string, options?: ManagedBackupShortTermRetentionPoliciesListByDatabaseOptionalParams): PagedAsyncIterableIterator<ManagedBackupShortTermRetentionPolicy>
Gets a managed database's short term retention policy list.
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.
- managedInstanceName: string
  
  The name of the managed instance.
- databaseName: string
  
  The name of the database.
- Optional options: ManagedBackupShortTermRetentionPoliciesListByDatabaseOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedBackupShortTermRetentionPolicy>
- Defined in operationsInterfaces/managedBackupShortTermRetentionPolicies.ts:34

Interface ManagedBackupShortTermRetentionPolicies

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedBackupShortTermRetentionPolicy

Optional options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedBackupShortTermRetentionPolicy

Optional options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

Returns Promise<ManagedBackupShortTermRetentionPolicy>

beginUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedBackupShortTermRetentionPolicy

Optional options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ManagedBackupShortTermRetentionPolicy>, ManagedBackupShortTermRetentionPolicy>>

beginUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

parameters: ManagedBackupShortTermRetentionPolicy

Optional options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams

Returns Promise<ManagedBackupShortTermRetentionPolicy>

get

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

policyName: string

Optional options: ManagedBackupShortTermRetentionPoliciesGetOptionalParams

Returns Promise<ManagedBackupShortTermRetentionPolicy>

listByDatabase

Parameters

resourceGroupName: string

managedInstanceName: string

databaseName: string

Optional options: ManagedBackupShortTermRetentionPoliciesListByDatabaseOptionalParams

Returns PagedAsyncIterableIterator<ManagedBackupShortTermRetentionPolicy>

Settings

Member Visibility

Theme

`Optional` options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: ManagedBackupShortTermRetentionPoliciesCreateOrUpdateOptionalParams

`Optional` options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams

`Optional` options: ManagedBackupShortTermRetentionPoliciesUpdateOptionalParams

`Optional` options: ManagedBackupShortTermRetentionPoliciesGetOptionalParams

`Optional` options: ManagedBackupShortTermRetentionPoliciesListByDatabaseOptionalParams