autonomous_database_backups

Creates, updates, deletes, gets or lists an autonomous_database_backups resource.

Overview

Name	autonomous_database_backups
Type	Resource
Id	azure_isv.oracledatabase.autonomous_database_backups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autonomousDatabaseOcid	string	The OCID of the Autonomous Database.
backupType	string	The type of backup. Known values are: "Incremental", "Full", and "LongTerm". (Incremental, Full, LongTerm)
databaseSizeInTbs	number	The size of the database in terabytes at the time the backup was taken.
dbVersion	string	A valid Oracle Database version for Autonomous Database.
displayName	string	The user-friendly name for the backup. The name does not have to be unique.
isAutomatic	boolean	Indicates whether the backup is user-initiated or automatic.
isRestorable	boolean	Indicates whether the backup can be used to restore the associated Autonomous Database.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the backup. Known values are: "Creating", "Active", "Deleting", "Failed", and "Updating". (Creating, Active, Deleting, Failed, Updating)
ocid	string	The OCID of the Autonomous Database backup.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
retentionPeriodInDays	integer	Retention period, in days.
sizeInTbs	number	The backup size in terabytes (TB).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeAvailableTil	string (date-time)	Timestamp until when the backup will be available.
timeEnded	string	The date and time the backup completed.
timeStarted	string	The date and time the backup started.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_parent

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
autonomousDatabaseOcid	string	The OCID of the Autonomous Database.
backupType	string	The type of backup. Known values are: "Incremental", "Full", and "LongTerm". (Incremental, Full, LongTerm)
databaseSizeInTbs	number	The size of the database in terabytes at the time the backup was taken.
dbVersion	string	A valid Oracle Database version for Autonomous Database.
displayName	string	The user-friendly name for the backup. The name does not have to be unique.
isAutomatic	boolean	Indicates whether the backup is user-initiated or automatic.
isRestorable	boolean	Indicates whether the backup can be used to restore the associated Autonomous Database.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the backup. Known values are: "Creating", "Active", "Deleting", "Failed", and "Updating". (Creating, Active, Deleting, Failed, Updating)
ocid	string	The OCID of the Autonomous Database backup.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
retentionPeriodInDays	integer	Retention period, in days.
sizeInTbs	number	The backup size in terabytes (TB).
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeAvailableTil	string (date-time)	Timestamp until when the backup will be available.
timeEnded	string	The date and time the backup completed.
timeStarted	string	The date and time the backup started.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, autonomousdatabasename, adbbackupid, subscription_id		Get a AutonomousDatabaseBackup.
list_by_parent	select	resource_group_name, autonomousdatabasename, subscription_id		List AutonomousDatabaseBackup resources by AutonomousDatabase.
create_or_update	insert	resource_group_name, autonomousdatabasename, adbbackupid, subscription_id		Create a AutonomousDatabaseBackup.
update	update	resource_group_name, autonomousdatabasename, adbbackupid, subscription_id		Update a AutonomousDatabaseBackup.
create_or_update	replace	resource_group_name, autonomousdatabasename, adbbackupid, subscription_id		Create a AutonomousDatabaseBackup.
delete	delete	resource_group_name, autonomousdatabasename, adbbackupid, subscription_id		Delete a AutonomousDatabaseBackup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
adbbackupid	string	AutonomousDatabaseBackup id. Required.
autonomousdatabasename	string	The database name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a AutonomousDatabaseBackup.

SELECT
id,
name,
autonomousDatabaseOcid,
backupType,
databaseSizeInTbs,
dbVersion,
displayName,
isAutomatic,
isRestorable,
lifecycleDetails,
lifecycleState,
ocid,
provisioningState,
retentionPeriodInDays,
sizeInTbs,
systemData,
timeAvailableTil,
timeEnded,
timeStarted,
type
FROM azure_isv.oracledatabase.autonomous_database_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' -- required
AND adbbackupid = '{{ adbbackupid }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List AutonomousDatabaseBackup resources by AutonomousDatabase.

SELECT
id,
name,
autonomousDatabaseOcid,
backupType,
databaseSizeInTbs,
dbVersion,
displayName,
isAutomatic,
isRestorable,
lifecycleDetails,
lifecycleState,
ocid,
provisioningState,
retentionPeriodInDays,
sizeInTbs,
systemData,
timeAvailableTil,
timeEnded,
timeStarted,
type
FROM azure_isv.oracledatabase.autonomous_database_backups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a AutonomousDatabaseBackup.

INSERT INTO azure_isv.oracledatabase.autonomous_database_backups (
properties,
resource_group_name,
autonomousdatabasename,
adbbackupid,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ autonomousdatabasename }}',
'{{ adbbackupid }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: autonomous_database_backups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: autonomousdatabasename
    value: "{{ autonomousdatabasename }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: adbbackupid
    value: "{{ adbbackupid }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the autonomous_database_backups resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      autonomousDatabaseOcid: "{{ autonomousDatabaseOcid }}"
      databaseSizeInTbs: {{ databaseSizeInTbs }}
      dbVersion: "{{ dbVersion }}"
      displayName: "{{ displayName }}"
      ocid: "{{ ocid }}"
      isAutomatic: {{ isAutomatic }}
      isRestorable: {{ isRestorable }}
      lifecycleDetails: "{{ lifecycleDetails }}"
      lifecycleState: "{{ lifecycleState }}"
      retentionPeriodInDays: {{ retentionPeriodInDays }}
      sizeInTbs: {{ sizeInTbs }}
      timeAvailableTil: "{{ timeAvailableTil }}"
      timeStarted: "{{ timeStarted }}"
      timeEnded: "{{ timeEnded }}"
      backupType: "{{ backupType }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a AutonomousDatabaseBackup.

UPDATE azure_isv.oracledatabase.autonomous_database_backups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' --required
AND adbbackupid = '{{ adbbackupid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a AutonomousDatabaseBackup.

REPLACE azure_isv.oracledatabase.autonomous_database_backups
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' --required
AND adbbackupid = '{{ adbbackupid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a AutonomousDatabaseBackup.

DELETE FROM azure_isv.oracledatabase.autonomous_database_backups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' --required
AND adbbackupid = '{{ adbbackupid }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;