Skip to main content

db_systems

Creates, updates, deletes, gets or lists a db_systems resource.

Overview​

Namedb_systems
TypeResource
Idazure_isv.oracledatabase.db_systems

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.
adminPasswordstringA strong password for SYS, SYSTEM, and PDB Admin. The password must be at least nine characters and contain at least two uppercase, two lowercase, two numbers, and two special characters. The special characters must be _, #, or -.
clusterNamestringThe cluster name for Exadata and 2-node RAC virtual machine DB systems. The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.
computeCountintegerThe number of compute servers for the DB system.
computeModelstringThe compute model for Base Database Service. This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. The ECPU compute model is the recommended model, and the OCPU compute model is legacy. Known values are: "ECPU" and "OCPU". (ECPU, OCPU)
dataStorageSizeInGbsintegerThe data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.
databaseEditionstringThe Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require EnterpriseEditionExtremePerformance. Required. Known values are: "StandardEdition", "EnterpriseEdition", "EnterpriseEditionHighPerformance", "EnterpriseEditionExtreme", and "EnterpriseEditionDeveloper". (StandardEdition, EnterpriseEdition, EnterpriseEditionHighPerformance, EnterpriseEditionExtreme, EnterpriseEditionDeveloper)
dbSystemOptionsobjectThe DB system options.
dbVersionstringA valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation. Required.
diskRedundancystringThe type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. Known values are: "High" and "Normal". (High, Normal)
displayNamestringThe user-friendly name for the DB system. The name does not have to be unique.
domainstringThe domain name for the DB system.
gridImageOcidstringThe OCID of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE.
hostnamestringThe hostname for the DB system. Required.
initialDataStorageSizeInGbintegerSize in GB of the initial data volume that will be created and attached to a virtual machine DB system. You can scale up storage after provisioning, as needed. Note that the total storage size attached will be more than the amount you specify to allow for REDO/RECO space and software volume.
licenseModelstringThe Oracle license model that applies to all the databases on the DB system. The default is LicenseIncluded. Known values are: "LicenseIncluded" and "BringYourOwnLicense". (LicenseIncluded, BringYourOwnLicense)
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the DB system. Known values are: "Provisioning", "Available", "Updating", "Terminating", "Terminated", "Failed", "Migrated", "MaintenanceInProgress", "NeedsAttention", and "Upgrading". (Provisioning, Available, Updating, Terminating, Terminated, Failed, Migrated, MaintenanceInProgress, NeedsAttention, Upgrading)
listenerPortintegerThe port number configured for the listener on the DB system.
locationstringThe geo-location where the resource lives. Required.
memorySizeInGbsintegerMemory allocated to the DB system, in gigabytes.
networkAnchorIdstringAzure Network Anchor ID. Required.
nodeCountintegerThe number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
ociUrlstringHTTPS link to OCI resources exposed to Azure Customer via Azure Interface.
ocidstringThe OCID of the DB system.
pdbNamestringThe name of the pluggable database. The name must begin with an alphabetic character and can contain a maximum of thirty alphanumeric characters. Special characters are not permitted. Pluggable database should not be same as database name.
provisioningStatestringdbSystem provisioning state. Known values are: "Succeeded", "Failed", "Canceled", and "Provisioning". (Succeeded, Failed, Canceled, Provisioning)
resourceAnchorIdstringAzure Resource Anchor ID. Required.
scanDnsNamestringThe FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIpsarrayThe list of Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster. Note: For a single-node DB system, this list is empty.
shapestringThe shape of the DB system. The shape determines resources to allocate to the DB system. For virtual machine shapes, the number of CPU cores and memory. For bare metal and Exadata shapes, the number of CPU cores, storage, and memory. Required.
sourcestringThe source of the database for creating a new database. Required. for creating a new database.
sshPublicKeysarrayThe public key portion of one or more key pairs used for SSH access to the DB system. Required.
storageVolumePerformanceModestringThe block storage volume performance level. Valid values are Balanced and HighPerformance. See Block Volume Performance _ for more information. Known values are: "Balanced" and "HighPerformance". (Balanced, HighPerformance)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
timeZonestringThe time zone of the DB system, e.g., UTC, to set the timeZone as UTC.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
versionstringThe Oracle Database version of the DB system.
zonesarrayThe availability zones.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, db_system_name, subscription_idGet a DbSystem.
list_by_resource_groupselectresource_group_name, subscription_idList DbSystem resources by resource group.
list_by_subscriptionselectsubscription_idList DbSystem resources by subscription ID.
create_or_updateinsertresource_group_name, db_system_name, subscription_id, locationCreate a DbSystem.
updateupdateresource_group_name, db_system_name, subscription_idUpdate a DbSystem.
create_or_updatereplaceresource_group_name, db_system_name, subscription_id, locationCreate a DbSystem.
deletedeleteresource_group_name, db_system_name, subscription_idDelete a DbSystem.

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
db_system_namestringThe name of the DbSystem. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring

SELECT examples​

Get a DbSystem.

SELECT
id,
name,
adminPassword,
clusterName,
computeCount,
computeModel,
dataStorageSizeInGbs,
databaseEdition,
dbSystemOptions,
dbVersion,
diskRedundancy,
displayName,
domain,
gridImageOcid,
hostname,
initialDataStorageSizeInGb,
licenseModel,
lifecycleDetails,
lifecycleState,
listenerPort,
location,
memorySizeInGbs,
networkAnchorId,
nodeCount,
ociUrl,
ocid,
pdbName,
provisioningState,
resourceAnchorId,
scanDnsName,
scanIps,
shape,
source,
sshPublicKeys,
storageVolumePerformanceMode,
systemData,
tags,
timeZone,
type,
version,
zones
FROM azure_isv.oracledatabase.db_systems
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND db_system_name = '{{ db_system_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a DbSystem.

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

UPDATE examples​

Update a DbSystem.

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

REPLACE examples​

Create a DbSystem.

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

DELETE examples​

Delete a DbSystem.

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