Skip to main content

autonomous_databases

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

Overview

Nameautonomous_databases
TypeResource
Idazure_isv.oracledatabase.autonomous_databases

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
actualUsedDataStorageSizeInTbsnumberThe current amount of storage in use for user and system data, in terabytes (TB).
adminPasswordstringAdmin password.
allocatedStorageSizeInTbsnumberThe amount of storage currently allocated for the database tables and billed for, rounded up.
apexDetailsobjectInformation about Oracle APEX Application Development.
autonomousDatabaseIdstringAutonomous Database ID.
autonomousMaintenanceScheduleTypestringThe maintenance schedule type of the Autonomous Database Serverless. Known values are: "Early" and "Regular". (Early, Regular)
availableUpgradeVersionsarrayList of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty.
backupRetentionPeriodInDaysintegerRetention period, in days, for long-term backups.
characterSetstringThe character set for the autonomous database.
computeCountnumberThe compute amount (CPUs) available to the database.
computeModelstringThe compute model of the Autonomous Database. Known values are: "ECPU" and "OCPU". (ECPU, OCPU)
connectionStringsobjectThe connection string used to connect to the Autonomous Database.
connectionUrlsobjectThe URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance within your VCN or that has a direct connection to your VCN.
cpuCoreCountintegerThe number of CPU cores to be made available to the database.
customerContactsarrayCustomer Contacts.
dataBaseTypestringDatabase type to be created. Required. Known values are: "Regular", "Clone", "CloneFromBackupTimestamp", and "CrossRegionDisasterRecovery".
dataSafeStatusstringStatus of the Data Safe registration for this Autonomous Database. Known values are: "Registering", "Registered", "Deregistering", "NotRegistered", and "Failed". (Registering, Registered, Deregistering, NotRegistered, Failed)
dataStorageSizeInGbsintegerThe size, in gigabytes, of the data volume that will be created and attached to the database.
dataStorageSizeInTbsintegerThe quantity of data in the database, in terabytes.
databaseEditionstringThe Oracle Database Edition that applies to the Autonomous databases. Known values are: "StandardEdition" and "EnterpriseEdition". (StandardEdition, EnterpriseEdition)
dbVersionstringA valid Oracle Database version for Autonomous Database.
dbWorkloadstringThe Autonomous Database workload type. Known values are: "OLTP", "DW", "AJD", and "APEX". (OLTP, DW, AJD, APEX)
displayNamestringThe user-friendly name for the Autonomous Database.
failedDataRecoveryInSecondsintegerIndicates the number of seconds of data loss for a Data Guard failover.
inMemoryAreaInGbsintegerThe area assigned to In-Memory tables in Autonomous Database.
isAutoScalingEnabledbooleanIndicates if auto scaling is enabled for the Autonomous Database CPU core count.
isAutoScalingForStorageEnabledbooleanIndicates if auto scaling is enabled for the Autonomous Database storage.
isLocalDataGuardEnabledbooleanIndicates whether the Autonomous Database has local or called in-region Data Guard enabled.
isMtlsConnectionRequiredbooleanSpecifies if the Autonomous Database requires mTLS connections.
isPreviewbooleanIndicates if the Autonomous Database version is a preview version.
isPreviewVersionWithServiceTermsAcceptedbooleanSpecifies if the Autonomous Database preview version is being provisioned.
isRemoteDataGuardEnabledbooleanIndicates whether the Autonomous Database has Cross Region Data Guard enabled.
licenseModelstringThe Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. Known values are: "LicenseIncluded" and "BringYourOwnLicense". (LicenseIncluded, BringYourOwnLicense)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringViews lifecycleState. Known values are: "Provisioning", "Available", "Stopping", "Stopped", "Starting", "Terminating", "Terminated", "Unavailable", "RestoreInProgress", "RestoreFailed", "BackupInProgress", "ScaleInProgress", "AvailableNeedsAttention", "Updating", "MaintenanceInProgress", "Restarting", "Recreating", "RoleChangeInProgress", "Upgrading", "Inaccessible", and "Standby". (Provisioning, Available, Stopping, Stopped, Starting, Terminating, Terminated, Unavailable, RestoreInProgress, RestoreFailed, BackupInProgress, ScaleInProgress, AvailableNeedsAttention, Updating, MaintenanceInProgress, Restarting, Recreating, RoleChangeInProgress, Upgrading, Inaccessible, Standby)
localAdgAutoFailoverMaxDataLossLimitintegerParameter that allows users to select an acceptable maximum data loss limit in seconds, up to which Automatic Failover will be triggered when necessary for a Local Autonomous Data Guard.
localDisasterRecoveryTypestringIndicates the local disaster recovery (DR) type of the Autonomous Database Serverless instance.Autonomous Data Guard (ADG) DR type provides business critical DR with a faster recovery time objective (RTO) during failover or switchover.Backup-based DR type provides lower cost DR with a slower RTO during failover or switchover. Known values are: "Adg" and "BackupBased". (Adg, BackupBased)
localStandbyDbobjectLocal Autonomous Disaster Recovery standby database details.
locationstringThe geo-location where the resource lives. Required.
longTermBackupScheduleobjectDetails for the long-term backup schedule.
memoryPerOracleComputeUnitInGbsintegerThe amount of memory (in GBs) enabled per ECPU or OCPU.
ncharacterSetstringThe character set for the Autonomous Database.
nextLongTermBackupTimeStampstring (date-time)The date and time when the next long-term backup would be created.
ociUrlstringHTTPS link to OCI resources exposed to Azure Customer via Azure Interface.
ocidstringDatabase ocid.
openModestringIndicates the Autonomous Database mode. Known values are: "ReadOnly" and "ReadWrite". (ReadOnly, ReadWrite)
operationsInsightsStatusstringStatus of Operations Insights for this Autonomous Database. Known values are: "Enabling", "Enabled", "Disabling", "NotEnabled", "FailedEnabling", and "FailedDisabling". (Enabling, Enabled, Disabling, NotEnabled, FailedEnabling, FailedDisabling)
peerDbIdstringThe Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database.
peerDbIdsarrayThe list of Azure resource IDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. Note that for Autonomous Database Serverless instances, standby databases located in the same region as the source primary database do not have Azure IDs.
permissionLevelstringThe Autonomous Database permission level. Known values are: "Restricted" and "Unrestricted". (Restricted, Unrestricted)
privateEndpointstringThe private endpoint for the resource.
privateEndpointIpstringThe private endpoint Ip address for the resource.
privateEndpointLabelstringThe resource's private endpoint label.
provisionableCpusarrayAn array of CPU values that an Autonomous Database can be scaled to.
provisioningStatestringAzure resource provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
remoteDisasterRecoveryConfigurationobjectIndicates remote disaster recovery configuration.
rolestringThe Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. Known values are: "Primary", "Standby", "DisabledStandby", "BackupCopy", and "SnapshotStandby". (Primary, Standby, DisabledStandby, BackupCopy, SnapshotStandby)
scheduledOperationsListarrayThe list of scheduled operations.
serviceConsoleUrlstringThe URL of the Service Console for the Autonomous Database.
sqlWebDeveloperUrlstringThe SQL Web Developer URL for the Oracle Autonomous Database.
subnetIdstringClient subnet.
supportedRegionsToCloneToarrayThe list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database.
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
timeCreatedstring (date-time)The date and time that the database was created.
timeDataGuardRoleChangedstringThe date and time the Autonomous Data Guard role was switched for the Autonomous Database.
timeDeletionOfFreeAutonomousDatabasestringThe date and time the Always Free database will be automatically deleted because of inactivity.
timeDisasterRecoveryRoleChangedstring (date-time)The date and time the Disaster Recovery role was switched for the standby Autonomous Database.
timeLocalDataGuardEnabledstringThe date and time that Autonomous Data Guard was enabled for an Autonomous Database where the standby was provisioned in the same region as the primary database.
timeMaintenanceBeginstring (date-time)The date and time when maintenance will begin.
timeMaintenanceEndstring (date-time)The date and time when maintenance will end.
timeOfLastFailoverstringThe timestamp of the last failover operation.
timeOfLastRefreshstringThe date and time when last refresh happened.
timeOfLastRefreshPointstringThe refresh point timestamp (UTC).
timeOfLastSwitchoverstringThe timestamp of the last switchover operation for the Autonomous Database.
timeReclamationOfFreeAutonomousDatabasestringThe date and time the Always Free database will be stopped because of inactivity.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
usedDataStorageSizeInGbsintegerThe storage space consumed by Autonomous Database in GBs.
usedDataStorageSizeInTbsintegerThe amount of storage that has been used, in terabytes.
vnetIdstringVNET for network connectivity.
whitelistedIpsarrayThe client IP access control list (ACL). This is an array of CIDR notations and/or IP addresses. Values should be separate strings, separated by commas. Example: ['1.1.1.1','1.1.1.0/24','1.1.2.25'].

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, autonomousdatabasename, subscription_idGet a AutonomousDatabase.
list_by_resource_groupselectresource_group_name, subscription_idList AutonomousDatabase resources by resource group.
list_by_subscriptionselectsubscription_idList AutonomousDatabase resources by subscription ID.
create_or_updateinsertresource_group_name, autonomousdatabasename, subscription_id, locationCreate a AutonomousDatabase.
updateupdateresource_group_name, autonomousdatabasename, subscription_idUpdate a AutonomousDatabase.
create_or_updatereplaceresource_group_name, autonomousdatabasename, subscription_id, locationCreate a AutonomousDatabase.
deletedeleteresource_group_name, autonomousdatabasename, subscription_idDelete a AutonomousDatabase.
switchoverexecresource_group_name, autonomousdatabasename, subscription_idPerform switchover action on Autonomous Database.
failoverexecresource_group_name, autonomousdatabasename, subscription_idPerform failover action on Autonomous Database.
generate_walletexecresource_group_name, autonomousdatabasename, subscription_id, passwordGenerate wallet action on Autonomous Database.
restoreexecresource_group_name, autonomousdatabasename, subscription_id, timestampRestores an Autonomous Database based on the provided request parameters.
shrinkexecresource_group_name, autonomousdatabasename, subscription_idThis operation shrinks the current allocated storage down to the current actual used data storage.
change_disaster_recovery_configurationexecresource_group_name, autonomousdatabasename, subscription_idPerform ChangeDisasterRecoveryConfiguration action on Autonomous Database.
actionexecresource_group_name, autonomousdatabasename, subscription_id, actionPerform Lifecycle Management Action on Autonomous Database.

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.

NameDatatypeDescription
autonomousdatabasenamestringThe database name. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples

Get a AutonomousDatabase.

SELECT
id,
name,
actualUsedDataStorageSizeInTbs,
adminPassword,
allocatedStorageSizeInTbs,
apexDetails,
autonomousDatabaseId,
autonomousMaintenanceScheduleType,
availableUpgradeVersions,
backupRetentionPeriodInDays,
characterSet,
computeCount,
computeModel,
connectionStrings,
connectionUrls,
cpuCoreCount,
customerContacts,
dataBaseType,
dataSafeStatus,
dataStorageSizeInGbs,
dataStorageSizeInTbs,
databaseEdition,
dbVersion,
dbWorkload,
displayName,
failedDataRecoveryInSeconds,
inMemoryAreaInGbs,
isAutoScalingEnabled,
isAutoScalingForStorageEnabled,
isLocalDataGuardEnabled,
isMtlsConnectionRequired,
isPreview,
isPreviewVersionWithServiceTermsAccepted,
isRemoteDataGuardEnabled,
licenseModel,
lifecycleDetails,
lifecycleState,
localAdgAutoFailoverMaxDataLossLimit,
localDisasterRecoveryType,
localStandbyDb,
location,
longTermBackupSchedule,
memoryPerOracleComputeUnitInGbs,
ncharacterSet,
nextLongTermBackupTimeStamp,
ociUrl,
ocid,
openMode,
operationsInsightsStatus,
peerDbId,
peerDbIds,
permissionLevel,
privateEndpoint,
privateEndpointIp,
privateEndpointLabel,
provisionableCpus,
provisioningState,
remoteDisasterRecoveryConfiguration,
role,
scheduledOperationsList,
serviceConsoleUrl,
sqlWebDeveloperUrl,
subnetId,
supportedRegionsToCloneTo,
systemData,
tags,
timeCreated,
timeDataGuardRoleChanged,
timeDeletionOfFreeAutonomousDatabase,
timeDisasterRecoveryRoleChanged,
timeLocalDataGuardEnabled,
timeMaintenanceBegin,
timeMaintenanceEnd,
timeOfLastFailover,
timeOfLastRefresh,
timeOfLastRefreshPoint,
timeOfLastSwitchover,
timeReclamationOfFreeAutonomousDatabase,
type,
usedDataStorageSizeInGbs,
usedDataStorageSizeInTbs,
vnetId,
whitelistedIps
FROM azure_isv.oracledatabase.autonomous_databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND autonomousdatabasename = '{{ autonomousdatabasename }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

Create a AutonomousDatabase.

INSERT INTO azure_isv.oracledatabase.autonomous_databases (
tags,
location,
properties,
resource_group_name,
autonomousdatabasename,
subscription_id
)
SELECT
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ autonomousdatabasename }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

UPDATE examples

Update a AutonomousDatabase.

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

REPLACE examples

Create a AutonomousDatabase.

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

DELETE examples

Delete a AutonomousDatabase.

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

Lifecycle Methods

Perform switchover action on Autonomous Database.

EXEC azure_isv.oracledatabase.autonomous_databases.switchover 
@resource_group_name='{{ resource_group_name }}' --required,
@autonomousdatabasename='{{ autonomousdatabasename }}' --required,
@subscription_id='{{ subscription_id }}' --required
@@json=
'{
"peerDbId": "{{ peerDbId }}",
"peerDbOcid": "{{ peerDbOcid }}",
"peerDbLocation": "{{ peerDbLocation }}"
}'
;