Share via

DbSystemProperties interface

Package:
@azure/arm-oracledatabase

DbSystem resource model.

Extends
DbSystemBaseProperties

Properties

adminPassword

A 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 -.
databaseEdition

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require EnterpriseEditionExtremePerformance.
dbVersion

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
pdbName

The 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.
source

The source of the database for creating a new database.

Inherited Properties

clusterName

The 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.
computeCount

The number of compute servers for the DB system.
computeModel

The 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.
dataStorageSizeInGbs

The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.
dbSystemOptions

The DB system options.
diskRedundancy

The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
displayName

The user-friendly name for the DB system. The name does not have to be unique.
domainV2

The domain name for the DB system.
gridImageOcid

The OCID of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE.
hostname

The hostname for the DB system.
initialDataStorageSizeInGb

Size 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.
licenseModelV2

The Oracle license model that applies to all the databases on the DB system. The default is LicenseIncluded.
lifecycleDetails

Additional information about the current lifecycle state.
lifecycleState

The current state of the DB system.
listenerPort

The port number configured for the listener on the DB system.
memorySizeInGbs

Memory allocated to the DB system, in gigabytes.
networkAnchorId

Azure Network Anchor ID
nodeCount

The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
ocid

The OCID of the DB system.
ociUrl

HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.
provisioningState

dbSystem provisioning state
resourceAnchorId

Azure Resource Anchor ID
scanDnsName

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
scanIps

The 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.
shape

The 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.
sshPublicKeys

The public key portion of one or more key pairs used for SSH access to the DB system.
storageVolumePerformanceMode

The block storage volume performance level. Valid values are Balanced and HighPerformance. See Block Volume Performance for more information.
timeZone

The time zone of the DB system, e.g., UTC, to set the timeZone as UTC.
version

The Oracle Database version of the DB system.

Property Details

adminPassword

A 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 -.

adminPassword?: string

Property Value

string

databaseEdition

The Oracle Database Edition that applies to all the databases on the DB system. Exadata DB systems and 2-node RAC DB systems require EnterpriseEditionExtremePerformance.

databaseEdition: string

Property Value

string

dbVersion

A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.

dbVersion: string

Property Value

string

pdbName

The 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.

pdbName?: string

Property Value

string

source

The source of the database for creating a new database.

source: "None"

Property Value

"None"

Inherited Property Details

clusterName

The 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.

clusterName?: string

Property Value

string

Inherited From DbSystemBaseProperties.clusterName

computeCount

The number of compute servers for the DB system.

computeCount?: number

Property Value

number

Inherited From DbSystemBaseProperties.computeCount

computeModel

The 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.

computeModel?: string

Property Value

string

Inherited From DbSystemBaseProperties.computeModel

dataStorageSizeInGbs

The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.

dataStorageSizeInGbs?: number

Property Value

number

Inherited From DbSystemBaseProperties.dataStorageSizeInGbs

dbSystemOptions

The DB system options.

dbSystemOptions?: DbSystemOptions

Property Value

DbSystemOptions

Inherited From DbSystemBaseProperties.dbSystemOptions

diskRedundancy

The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

diskRedundancy?: string

Property Value

string

Inherited From DbSystemBaseProperties.diskRedundancy

displayName

The user-friendly name for the DB system. The name does not have to be unique.

displayName?: string

Property Value

string

Inherited From DbSystemBaseProperties.displayName

domainV2

The domain name for the DB system.

domainV2?: string

Property Value

string

Inherited From DbSystemBaseProperties.domainV2

gridImageOcid

The OCID of a grid infrastructure software image. This is a database software image of the type GRID_IMAGE.

gridImageOcid?: string

Property Value

string

Inherited From DbSystemBaseProperties.gridImageOcid

hostname

The hostname for the DB system.

hostname: string

Property Value

string

Inherited From DbSystemBaseProperties.hostname

initialDataStorageSizeInGb

Size 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.

initialDataStorageSizeInGb?: number

Property Value

number

Inherited From DbSystemBaseProperties.initialDataStorageSizeInGb

licenseModelV2

The Oracle license model that applies to all the databases on the DB system. The default is LicenseIncluded.

licenseModelV2?: string

Property Value

string

Inherited From DbSystemBaseProperties.licenseModelV2

lifecycleDetails

Additional information about the current lifecycle state.

lifecycleDetails?: string

Property Value

string

Inherited From DbSystemBaseProperties.lifecycleDetails

lifecycleState

The current state of the DB system.

lifecycleState?: string

Property Value

string

Inherited From DbSystemBaseProperties.lifecycleState

listenerPort

The port number configured for the listener on the DB system.

listenerPort?: number

Property Value

number

Inherited From DbSystemBaseProperties.listenerPort

memorySizeInGbs

Memory allocated to the DB system, in gigabytes.

memorySizeInGbs?: number

Property Value

number

Inherited From DbSystemBaseProperties.memorySizeInGbs

networkAnchorId

Azure Network Anchor ID

networkAnchorId: string

Property Value

string

Inherited From DbSystemBaseProperties.networkAnchorId

nodeCount

The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.

nodeCount?: number

Property Value

number

Inherited From DbSystemBaseProperties.nodeCount

ocid

The OCID of the DB system.

ocid?: string

Property Value

string

Inherited From DbSystemBaseProperties.ocid

ociUrl

HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.

ociUrl?: string

Property Value

string

Inherited From DbSystemBaseProperties.ociUrl

provisioningState

dbSystem provisioning state

provisioningState?: string

Property Value

string

Inherited From DbSystemBaseProperties.provisioningState

resourceAnchorId

Azure Resource Anchor ID

resourceAnchorId: string

Property Value

string

Inherited From DbSystemBaseProperties.resourceAnchorId

scanDnsName

The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.

scanDnsName?: string

Property Value

string

Inherited From DbSystemBaseProperties.scanDnsName

scanIps

The 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.

scanIps?: string[]

Property Value

string[]

Inherited From DbSystemBaseProperties.scanIps

shape

The 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.

shape: string

Property Value

string

Inherited From DbSystemBaseProperties.shape

sshPublicKeys

The public key portion of one or more key pairs used for SSH access to the DB system.

sshPublicKeys: string[]

Property Value

string[]

Inherited From DbSystemBaseProperties.sshPublicKeys

storageVolumePerformanceMode

The block storage volume performance level. Valid values are Balanced and HighPerformance. See Block Volume Performance for more information.

storageVolumePerformanceMode?: string

Property Value

string

Inherited From DbSystemBaseProperties.storageVolumePerformanceMode

timeZone

The time zone of the DB system, e.g., UTC, to set the timeZone as UTC.

timeZone?: string

Property Value

string

Inherited From DbSystemBaseProperties.timeZone

version

The Oracle Database version of the DB system.

version?: string

Property Value

string

Inherited From DbSystemBaseProperties.version