Oracle.Database (stable:2025-03-01)

2025/04/15 • 88 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Oracle.Database/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_ListBySubscription (new)
Description :  List AutonomousDatabase resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/autonomousDatabases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDatabase items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_ListBySubscription (new)
Description :  List CloudExadataInfrastructure resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/cloudExadataInfrastructures
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CloudExadataInfrastructure items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_ListBySubscription (new)
Description :  List CloudVmCluster resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/cloudVmClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CloudVmCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_ListBySubscription (new)
Description :  List ExadbVmCluster resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/exadbVmClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExadbVmCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_ListBySubscription (new)
Description :  List ExascaleDbStorageVault resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/exascaleDbStorageVaults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExascaleDbStorageVault items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseCharacterSets_ListByLocation (new)
Description :  List AutonomousDatabaseCharacterSet resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDatabaseCharacterSet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
characterSet:
{
Description: The Oracle Autonomous Database supported character sets. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseCharacterSets_Get (new)
Description :  Get a AutonomousDatabaseCharacterSet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseCharacterSets/{adbscharsetname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
adbscharsetname:
{
Description: AutonomousDatabaseCharacterSet name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
characterSet:
{
Description: The Oracle Autonomous Database supported character sets. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseNationalCharacterSets_ListByLocation (new)
Description :  List AutonomousDatabaseNationalCharacterSet resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDatabaseNationalCharacterSet items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
characterSet:
{
Description: The Oracle Autonomous Database supported national character sets. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseNationalCharacterSets_Get (new)
Description :  Get a AutonomousDatabaseNationalCharacterSet
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDatabaseNationalCharacterSets/{adbsncharsetname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
adbsncharsetname:
{
Description: AutonomousDatabaseNationalCharacterSets name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
characterSet:
{
Description: The Oracle Autonomous Database supported national character sets. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseVersions_ListByLocation (new)
Description :  List AutonomousDbVersion resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDbVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: Supported Autonomous Db versions. ,
Required: True ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
isDefaultForFree:
{
Description: True if this version of the Oracle Database software's default is free. ,
Required: False ,
}
boolean ,
isDefaultForPaid:
{
Description: True if this version of the Oracle Database software's default is paid. ,
Required: False ,
}
boolean ,
isFreeTierEnabled:
{
Description: True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases. ,
Required: False ,
}
boolean ,
isPaidEnabled:
{
Description: True if this version of the Oracle Database software has payments enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseVersions_Get (new)
Description :  Get a AutonomousDbVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/autonomousDbVersions/{autonomousdbversionsname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
autonomousdbversionsname:
{
Description: AutonomousDbVersion name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: Supported Autonomous Db versions. ,
Required: True ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
isDefaultForFree:
{
Description: True if this version of the Oracle Database software's default is free. ,
Required: False ,
}
boolean ,
isDefaultForPaid:
{
Description: True if this version of the Oracle Database software's default is paid. ,
Required: False ,
}
boolean ,
isFreeTierEnabled:
{
Description: True if this version of the Oracle Database software can be used for Always-Free Autonomous Databases. ,
Required: False ,
}
boolean ,
isPaidEnabled:
{
Description: True if this version of the Oracle Database software has payments enabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbSystemShapes_ListByLocation (new)
Description :  List DbSystemShape resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
zone:
{
Description: Filters the result for the given Azure Availability Zone ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DbSystemShape items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
shapeFamily:
{
Description: The family of the shape used for the DB system. ,
Required: False ,
}
string ,
shapeName:
{
Description: The shape used for the DB system. ,
Required: True ,
}
string ,
availableCoreCount:
{
Description: The maximum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: True ,
}
integer ,
minimumCoreCount:
{
Description: The minimum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
runtimeMinimumCoreCount:
{
Description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
coreCountIncrement:
{
Description: The discrete number by which the CPU core count for this shape can be increased or decreased. ,
Format: int32 ,
Required: False ,
}
integer ,
minStorageCount:
{
Description: The minimum number of Exadata storage servers available for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
maxStorageCount:
{
Description: The maximum number of Exadata storage servers available for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDataStoragePerServerInTbs:
{
Description: The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: double ,
Required: False ,
}
number ,
availableMemoryPerNodeInGbs:
{
Description: The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbNodePerNodeInGbs:
{
Description: The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
minCoreCountPerNode:
{
Description: The minimum number of CPU cores that can be enabled per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableMemoryInGbs:
{
Description: The maximum memory that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemoryPerNodeInGbs:
{
Description: The minimum memory that need be allocated per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbNodeStorageInGbs:
{
Description: The maximum Db Node storage that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minDbNodeStoragePerNodeInGbs:
{
Description: The minimum Db Node storage that need be allocated per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDataStorageInTbs:
{
Description: The maximum DATA storage that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minDataStorageInTbs:
{
Description: The minimum data storage that need be allocated for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumNodeCount:
{
Description: The minimum number of database nodes available for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumNodeCount:
{
Description: The maximum number of database nodes available for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableCoreCountPerNode:
{
Description: The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
areServerTypesSupported:
{
Description: Indicates if the shape supports database and storage server types ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the shape used for the DB system ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbSystemShapes_Get (new)
Description :  Get a DbSystemShape
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dbSystemShapes/{dbsystemshapename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
dbsystemshapename:
{
Description: DbSystemShape name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
shapeFamily:
{
Description: The family of the shape used for the DB system. ,
Required: False ,
}
string ,
shapeName:
{
Description: The shape used for the DB system. ,
Required: True ,
}
string ,
availableCoreCount:
{
Description: The maximum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: True ,
}
integer ,
minimumCoreCount:
{
Description: The minimum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
runtimeMinimumCoreCount:
{
Description: The runtime minimum number of CPU cores that can be enabled on the DB system for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
coreCountIncrement:
{
Description: The discrete number by which the CPU core count for this shape can be increased or decreased. ,
Format: int32 ,
Required: False ,
}
integer ,
minStorageCount:
{
Description: The minimum number of Exadata storage servers available for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
maxStorageCount:
{
Description: The maximum number of Exadata storage servers available for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDataStoragePerServerInTbs:
{
Description: The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: double ,
Required: False ,
}
number ,
availableMemoryPerNodeInGbs:
{
Description: The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbNodePerNodeInGbs:
{
Description: The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
minCoreCountPerNode:
{
Description: The minimum number of CPU cores that can be enabled per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableMemoryInGbs:
{
Description: The maximum memory that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minMemoryPerNodeInGbs:
{
Description: The minimum memory that need be allocated per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbNodeStorageInGbs:
{
Description: The maximum Db Node storage that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minDbNodeStoragePerNodeInGbs:
{
Description: The minimum Db Node storage that need be allocated per node for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDataStorageInTbs:
{
Description: The maximum DATA storage that can be enabled for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minDataStorageInTbs:
{
Description: The minimum data storage that need be allocated for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
minimumNodeCount:
{
Description: The minimum number of database nodes available for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumNodeCount:
{
Description: The maximum number of database nodes available for this shape. ,
Format: int32 ,
Required: False ,
}
integer ,
availableCoreCountPerNode:
{
Description: The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape and ExaCC Elastic shapes. ,
Format: int32 ,
Required: False ,
}
integer ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
areServerTypesSupported:
{
Description: Indicates if the shape supports database and storage server types ,
Required: False ,
}
boolean ,
displayName:
{
Description: The display name of the shape used for the DB system ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsPrivateViews_ListByLocation (new)
Description :  List DnsPrivateView resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DnsPrivateView items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: The OCID of the view ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the view resource ,
Required: True ,
}
string ,
isProtected:
{
Description: A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ,
Required: True ,
}
boolean ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Active: DNS Private View is active ,
Deleted: DNS Private View is deleted ,
Deleting: DNS Private View is deleting ,
Updating: DNS Private View is updating ,
}
,
Required: True ,
}
enum ,
self:
{
Description: The canonical absolute URL of the resource. ,
Required: True ,
}
string ,
timeCreated:
{
Description: views timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
timeUpdated:
{
Description: views timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsPrivateViews_Get (new)
Description :  Get a DnsPrivateView
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateViews/{dnsprivateviewocid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
dnsprivateviewocid:
{
Description: DnsPrivateView OCID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: The OCID of the view ,
Required: True ,
}
string ,
displayName:
{
Description: The display name of the view resource ,
Required: True ,
}
string ,
isProtected:
{
Description: A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ,
Required: True ,
}
boolean ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Active: DNS Private View is active ,
Deleted: DNS Private View is deleted ,
Deleting: DNS Private View is deleting ,
Updating: DNS Private View is updating ,
}
,
Required: True ,
}
enum ,
self:
{
Description: The canonical absolute URL of the resource. ,
Required: True ,
}
string ,
timeCreated:
{
Description: views timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
timeUpdated:
{
Description: views timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsPrivateZones_ListByLocation (new)
Description :  List DnsPrivateZone resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DnsPrivateZone items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: The OCID of the Zone ,
Required: True ,
}
string ,
isProtected:
{
Description: A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ,
Required: True ,
}
boolean ,
lifecycleState:
{
Description: Zones lifecycleState ,
Enum:
{
Active: DNS Private Zones is active ,
Creating: DNS Private Zones is creating ,
Deleted: DNS Private Zones is deleted ,
Deleting: DNS Private Zones is deleting ,
Updating: DNS Private Zones is updating ,
}
,
Required: True ,
}
enum ,
self:
{
Description: The canonical absolute URL of the resource. ,
Required: True ,
}
string ,
serial:
{
Description: The current serial of the zone. As seen in the zone's SOA record. ,
Format: int32 ,
Required: True ,
}
integer ,
version:
{
Description: Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived. ,
Required: True ,
}
string ,
viewId:
{
Description: The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view. ,
Required: False ,
}
string ,
zoneType:
{
Description: The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. ,
Enum:
{
Primary: Primary zone ,
Secondary: Secondary zone ,
}
,
Required: True ,
}
enum ,
timeCreated:
{
Description: Zones timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DnsPrivateZones_Get (new)
Description :  Get a DnsPrivateZone
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/dnsPrivateZones/{dnsprivatezonename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
dnsprivatezonename:
{
Description: DnsPrivateZone name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: The OCID of the Zone ,
Required: True ,
}
string ,
isProtected:
{
Description: A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed. ,
Required: True ,
}
boolean ,
lifecycleState:
{
Description: Zones lifecycleState ,
Enum:
{
Active: DNS Private Zones is active ,
Creating: DNS Private Zones is creating ,
Deleted: DNS Private Zones is deleted ,
Deleting: DNS Private Zones is deleting ,
Updating: DNS Private Zones is updating ,
}
,
Required: True ,
}
enum ,
self:
{
Description: The canonical absolute URL of the resource. ,
Required: True ,
}
string ,
serial:
{
Description: The current serial of the zone. As seen in the zone's SOA record. ,
Format: int32 ,
Required: True ,
}
integer ,
version:
{
Description: Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone's SOA record is derived. ,
Required: True ,
}
string ,
viewId:
{
Description: The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view. ,
Required: False ,
}
string ,
zoneType:
{
Description: The type of the zone. Must be either PRIMARY or SECONDARY. SECONDARY is only supported for GLOBAL zones. ,
Enum:
{
Primary: Primary zone ,
Secondary: Secondary zone ,
}
,
Required: True ,
}
enum ,
timeCreated:
{
Description: Zones timeCreated ,
Format: date-time ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FlexComponents_ListByParent (new)
Description :  List FlexComponent resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/flexComponents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
shape:
{
Description: If provided, filters the results for the given shape ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FlexComponent items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
minimumCoreCount:
{
Description: The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The maximum number of CPU cores that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbStorageInGbs:
{
Description: The maximum storage that can be enabled on the Storage Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
runtimeMinimumCoreCount:
{
Description: The runtime minimum number of CPU cores that can be enabled for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The name of the DB system shape for this Flex Component. ,
Required: False ,
}
string ,
availableMemoryInGbs:
{
Description: The maximum memory size that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableLocalStorageInGbs:
{
Description: The maximum local storage that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
computeModel:
{
Description: The compute model of the DB Server for this Flex Component. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component. ,
Enum:
{
COMPUTE: Hardware type is Database Server ,
CELL: Hardware type is Storage Server ,
}
,
Required: False ,
}
enum ,
descriptionSummary:
{
Description: The description summary for this Flex Component. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FlexComponents_Get (new)
Description :  Get a FlexComponent
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/flexComponents/{flexComponentName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
flexComponentName:
{
Description: The name of the FlexComponent ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
minimumCoreCount:
{
Description: The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableCoreCount:
{
Description: The maximum number of CPU cores that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableDbStorageInGbs:
{
Description: The maximum storage that can be enabled on the Storage Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
runtimeMinimumCoreCount:
{
Description: The runtime minimum number of CPU cores that can be enabled for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The name of the DB system shape for this Flex Component. ,
Required: False ,
}
string ,
availableMemoryInGbs:
{
Description: The maximum memory size that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
availableLocalStorageInGbs:
{
Description: The maximum local storage that can be enabled on the DB Server for this Flex Component. ,
Format: int32 ,
Required: False ,
}
integer ,
computeModel:
{
Description: The compute model of the DB Server for this Flex Component. ,
Required: False ,
}
string ,
hardwareType:
{
Description: The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component. ,
Enum:
{
COMPUTE: Hardware type is Database Server ,
CELL: Hardware type is Storage Server ,
}
,
Required: False ,
}
enum ,
descriptionSummary:
{
Description: The description summary for this Flex Component. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GiVersions_ListByLocation (new)
Description :  List GiVersion resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
shape:
{
Description: If provided, filters the results for the given shape ,
Required: False ,
}
string ,
zone:
{
Description: Filters the result for the given Azure Availability Zone ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GiVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: A valid Oracle Grid Infrastructure (GI) software version. ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GiVersions_Get (new)
Description :  Get a GiVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
giversionname:
{
Description: GiVersion name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: A valid Oracle Grid Infrastructure (GI) software version. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GiMinorVersions_ListByParent (new)
Description :  List GiMinorVersion resources by GiVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}/giMinorVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
giversionname:
{
Description: GiVersion name ,
Required: True ,
}
string ,
shapeFamily:
{
Description: If provided, filters the results to the set of database versions which are supported for the given shape family. ,
Required: False ,
}
string ,
zone:
{
Description: Filters the result for the given Azure Availability Zone ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The GiMinorVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: A valid Oracle Grid Infrastructure (GI) software version. ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Infrastructure Image Id ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GiMinorVersions_Get (new)
Description :  Get a GiMinorVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/giVersions/{giversionname}/giMinorVersions/{giMinorVersionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
giversionname:
{
Description: GiVersion name ,
Required: True ,
}
string ,
giMinorVersionName:
{
Description: The name of the GiMinorVersion ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
version:
{
Description: A valid Oracle Grid Infrastructure (GI) software version. ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Infrastructure Image Id ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SystemVersions_ListByLocation (new)
Description :  List SystemVersion resources by SubscriptionLocationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SystemVersion items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
systemVersion:
{
Description: A valid Oracle System Version ,
Required: True ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SystemVersions_Get (new)
Description :  Get a SystemVersion
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/systemVersions/{systemversionname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
systemversionname:
{
Description: SystemVersion name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
systemVersion:
{
Description: A valid Oracle System Version ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_ListBySubscription (new)
Description :  List OracleSubscription resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OracleSubscription items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_Get (new)
Description :  Get a OracleSubscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_CreateOrUpdate (new)
Description :  Create a OracleSubscription
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: OracleSubscription resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_Update (new)
Description :  Update a OracleSubscription
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: False ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: False ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: False ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: OracleSubscriptionProvisioningState provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
saasSubscriptionId:
{
Description: SAAS subscription ID generated by Marketplace ,
Required: False ,
}
string ,
cloudAccountId:
{
Description: Cloud Account Id ,
Required: False ,
}
string ,
cloudAccountState:
{
Description: Cloud Account provisioning state. ,
Enum:
{
Pending: Pending - Initial state when Oracle cloud account is not configured ,
Provisioning: Provisioning - State when Oracle cloud account is being provisioned ,
Available: Available - State when Oracle cloud account cloud linking is complete and it is available ,
}
,
Required: False ,
}
enum ,
termUnit:
{
Description: Term Unit. P1Y, P3Y, etc, see Durations https://en.wikipedia.org/wiki/ISO_8601 ,
Required: False ,
}
string ,
productCode:
{
Description: Product code for the term unit ,
Required: False ,
}
string ,
intent:
{
Description: Intent for the update operation ,
Enum:
{
Retain: Retain intent ,
Reset: Reset intent ,
}
,
Required: False ,
}
enum ,
azureSubscriptionIds:
{
Description: Azure subscriptions to be added ,
Required: False ,
}
[
string ,
]
,
addSubscriptionOperationState:
{
Description: State of the add Azure subscription operation on Oracle subscription ,
Enum:
{
Succeeded: Succeeded - State when Add Subscription operation succeeded ,
Updating: Updating - State when Add Subscription operation is being Updated ,
Failed: Failed - State when Add Subscription operation failed ,
}
,
Required: False ,
}
enum ,
lastOperationStatusDetail:
{
Description: Status details of the last operation on Oracle subscription ,
Required: False ,
}
string ,
}
,
plan:
{
Description: Details of the resource plan. ,
Required: False ,
}
{
name:
{
Description: A user defined name of the 3rd Party Artifact that is being procured. ,
Required: True ,
}
string ,
publisher:
{
Description: The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic ,
Required: True ,
}
string ,
product:
{
Description: The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ,
Required: True ,
}
string ,
promotionCode:
{
Description: A publisher provided promotion code as provisioned in Data Market for the said product/artifact. ,
Required: False ,
}
string ,
version:
{
Description: The version of the desired product/artifact. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_Delete (new)
Description :  Delete a OracleSubscription
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_AddAzureSubscriptions (new)
Description :  Add Azure Subscriptions
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/addAzureSubscriptions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
azureSubscriptionIds:
{
Description: Azure Subscription Ids to be updated ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_ListCloudAccountDetails (new)
Description :  List Cloud Account Details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listCloudAccountDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
cloudAccountName:
{
Description: Cloud Account name ,
Required: False ,
}
string ,
cloudAccountHomeRegion:
{
Description: Cloud Account Home region ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
OracleSubscriptions_ListSaasSubscriptionDetails (new)
Description :  List Saas Subscription Details
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Oracle.Database/oracleSubscriptions/default/listSaasSubscriptionDetails
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Purchased SaaS subscription ID ,
Required: False ,
}
string ,
subscriptionName:
{
Description: SaaS subscription name ,
Required: False ,
}
string ,
timeCreated:
{
Description: Creation Date and Time ,
Format: date-time ,
Required: False ,
}
string ,
offerId:
{
Description: Purchased offer ID ,
Required: False ,
}
string ,
planId:
{
Description: Purchased offer's plan ID ,
Required: False ,
}
string ,
saasSubscriptionStatus:
{
Description: Indicates the status of the Subscription. ,
Required: False ,
}
string ,
publisherId:
{
Description: Publisher ID ,
Required: False ,
}
string ,
purchaserEmailId:
{
Description: Purchaser Email ID ,
Required: False ,
}
string ,
purchaserTenantId:
{
Description: Purchaser Tenant ID ,
Required: False ,
}
string ,
termUnit:
{
Description: Purchase Term Unit ,
Required: False ,
}
string ,
isAutoRenew:
{
Description: AutoRenew flag ,
Required: False ,
}
boolean ,
isFreeTrial:
{
Description: FreeTrial flag ,
Required: False ,
}
boolean ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_ListByResourceGroup (new)
Description :  List AutonomousDatabase resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDatabase items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Get (new)
Description :  Get a AutonomousDatabase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_CreateOrUpdate (new)
Description :  Create a AutonomousDatabase
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Autonomous Database resource model. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Update (new)
Description :  Update a AutonomousDatabase
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: False ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: False ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Delete (new)
Description :  Delete a AutonomousDatabase
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseBackups_ListByParent (new)
Description :  List AutonomousDatabaseBackup resources by AutonomousDatabase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AutonomousDatabaseBackup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseBackups_Get (new)
Description :  Get a AutonomousDatabaseBackup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
adbbackupid:
{
Description: AutonomousDatabaseBackup id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseBackups_CreateOrUpdate (new)
Description :  Create a AutonomousDatabaseBackup
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
adbbackupid:
{
Description: AutonomousDatabaseBackup id ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: AutonomousDatabaseBackup resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseBackups_Update (new)
Description :  Update a AutonomousDatabaseBackup
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
adbbackupid:
{
Description: AutonomousDatabaseBackup id ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
autonomousDatabaseOcid:
{
Description: The OCID of the Autonomous Database. ,
Required: False ,
}
string ,
databaseSizeInTbs:
{
Description: The size of the database in terabytes at the time the backup was taken. ,
Format: double ,
Required: False ,
}
number ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the backup. The name does not have to be unique. ,
Required: False ,
}
string ,
ocid:
{
Description: The OCID of the Autonomous Database backup. ,
Required: False ,
}
string ,
isAutomatic:
{
Description: Indicates whether the backup is user-initiated or automatic. ,
Required: False ,
}
boolean ,
isRestorable:
{
Description: Indicates whether the backup can be used to restore the associated Autonomous Database. ,
Required: False ,
}
boolean ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the backup. ,
Enum:
{
Creating: AutonomousDatabase backup is creating ,
Active: AutonomousDatabase backup is active ,
Deleting: AutonomousDatabase backup is deleting ,
Failed: AutonomousDatabase backup is failed ,
Updating: AutonomousDatabase backup is updating ,
}
,
Required: False ,
}
enum ,
retentionPeriodInDays:
{
Description: Retention period, in days ,
Format: int32 ,
Required: False ,
}
integer ,
sizeInTbs:
{
Description: The backup size in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
timeAvailableTil:
{
Description: Timestamp until when the backup will be available. ,
Format: date-time ,
Required: False ,
}
string ,
timeStarted:
{
Description: The date and time the backup started. ,
Required: False ,
}
string ,
timeEnded:
{
Description: The date and time the backup completed. ,
Required: False ,
}
string ,
backupType:
{
Description: The type of backup. ,
Enum:
{
Incremental: Incremental backup ,
Full: Full backup ,
LongTerm: LongTerm backup ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabaseBackups_Delete (new)
Description :  Delete a AutonomousDatabaseBackup
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/autonomousDatabaseBackups/{adbbackupid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
adbbackupid:
{
Description: AutonomousDatabaseBackup id ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_ChangeDisasterRecoveryConfiguration (new)
Description :  Perform ChangeDisasterRecoveryConfiguration action on Autonomous Database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/changeDisasterRecoveryConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Failover (new)
Description :  Perform failover action on Autonomous Database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/failover
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
peerDbOcid:
{
Description: Ocid of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
peerDbLocation:
{
Description: The location of the Disaster Recovery peer database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_GenerateWallet (new)
Description :  Generate wallet action on Autonomous Database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
generateType:
{
Description: The type of wallet to generate. ,
Enum:
{
Single: Generate single ,
All: Generate all ,
}
,
Required: False ,
}
enum ,
isRegional:
{
Description: True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
password:
{
Description: The password to encrypt the keys inside the wallet ,
Format: password ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
walletFiles:
{
Description: The base64 encoded wallet files ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Restore (new)
Description :  Restores an Autonomous Database based on the provided request parameters.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/restore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
timestamp:
{
Description: The time to restore the database to. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Shrink (new)
Description :  This operation shrinks the current allocated storage down to the current actual used data storage.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/shrink
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AutonomousDatabases_Switchover (new)
Description :  Perform switchover action on Autonomous Database
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/switchover
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
autonomousdatabasename:
{
Description: The database name. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
peerDbOcid:
{
Description: Ocid of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
peerDbLocation:
{
Description: The location of the Disaster Recovery peer database. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
adminPassword:
{
Description: Admin password. ,
Format: password ,
Required: False ,
}
string ,
dataBaseType:
{
Description: Database type to be created. ,
Enum:
{
Regular: Regular DB ,
Clone: Clone DB ,
CloneFromBackupTimestamp: Clone DB from backup timestamp ,
CrossRegionDisasterRecovery: Cross Region Disaster Recovery ,
}
,
Required: True ,
}
enum ,
autonomousMaintenanceScheduleType:
{
Description: The maintenance schedule type of the Autonomous Database Serverless. ,
Enum:
{
Early: Early maintenance schedule ,
Regular: Regular maintenance schedule ,
}
,
Required: False ,
}
enum ,
characterSet:
{
Description: The character set for the autonomous database. ,
Required: False ,
}
string ,
computeCount:
{
Description: The compute amount (CPUs) available to the database. ,
Format: float ,
Required: False ,
}
number ,
computeModel:
{
Description: The compute model of the Autonomous Database. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
cpuCoreCount:
{
Description: The number of CPU cores to be made available to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
customerContacts:
{
Description: Customer Contacts. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInGbs:
{
Description: The size, in gigabytes, of the data volume that will be created and attached to the database. ,
Format: int32 ,
Required: False ,
}
integer ,
dbVersion:
{
Description: A valid Oracle Database version for Autonomous Database. ,
Required: False ,
}
string ,
dbWorkload:
{
Description: The Autonomous Database workload type ,
Enum:
{
OLTP: OLTP - indicates an Autonomous Transaction Processing database ,
DW: DW - indicates an Autonomous Data Warehouse database ,
AJD: AJD - indicates an Autonomous JSON Database ,
APEX: APEX - indicates an Autonomous Database with the Oracle APEX Application Development workload type. ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: The user-friendly name for the Autonomous Database. ,
Required: False ,
}
string ,
isAutoScalingEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database CPU core count. ,
Required: False ,
}
boolean ,
isAutoScalingForStorageEnabled:
{
Description: Indicates if auto scaling is enabled for the Autonomous Database storage. ,
Required: False ,
}
boolean ,
peerDbIds:
{
Description: The 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. ,
Required: False ,
}
[
string ,
]
,
peerDbId:
{
Description: The Azure resource ID of the Disaster Recovery peer database, which is located in a different region from the current peer database. ,
Required: False ,
}
string ,
isLocalDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has local or called in-region Data Guard enabled. ,
Required: False ,
}
boolean ,
isRemoteDataGuardEnabled:
{
Description: Indicates whether the Autonomous Database has Cross Region Data Guard enabled. ,
Required: False ,
}
boolean ,
localDisasterRecoveryType:
{
Description: Indicates 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Format: date-time ,
Required: False ,
}
string ,
remoteDisasterRecoveryConfiguration:
{
Description: Indicates remote disaster recovery configuration ,
Required: False ,
}
{
disasterRecoveryType:
{
Description: Indicates the 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. ,
Enum:
{
Adg: ADG type ,
BackupBased: Backup based type ,
}
,
Required: False ,
}
enum ,
timeSnapshotStandbyEnabledTill:
{
Description: Time and date stored as an RFC 3339 formatted timestamp string. For example, 2022-01-01T12:00:00.000Z would set a limit for the snapshot standby to be converted back to a cross-region standby database. ,
Format: date-time ,
Required: False ,
}
string ,
isSnapshotStandby:
{
Description: Indicates if user wants to convert to a snapshot standby. For example, true would set a standby database to snapshot standby database. False would set a snapshot standby database back to regular standby database. ,
Required: False ,
}
boolean ,
isReplicateAutomaticBackups:
{
Description: If true, 7 days worth of backups are replicated across regions for Cross-Region ADB or Backup-Based DR between Primary and Standby. If false, the backups taken on the Primary are not replicated to the Standby database. ,
Required: False ,
}
boolean ,
}
,
localStandbyDb:
{
Description: Local Autonomous Disaster Recovery standby database details. ,
Required: False ,
}
{
lagTimeInSeconds:
{
Description: The amount of time, in seconds, that the data of the standby database lags the data of the primary database. Can be used to determine the potential data loss in the event of a failover. ,
Format: int32 ,
Required: False ,
}
integer ,
lifecycleState:
{
Description: The current state of the Autonomous Database. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
timeDisasterRecoveryRoleChanged:
{
Description: The date and time the Disaster Recovery role was switched for the standby Autonomous Database. ,
Required: False ,
}
string ,
}
,
failedDataRecoveryInSeconds:
{
Description: Indicates the number of seconds of data loss for a Data Guard failover. ,
Format: int32 ,
Required: False ,
}
integer ,
isMtlsConnectionRequired:
{
Description: Specifies if the Autonomous Database requires mTLS connections. ,
Required: False ,
}
boolean ,
isPreviewVersionWithServiceTermsAccepted:
{
Description: Specifies if the Autonomous Database preview version is being provisioned. ,
Required: False ,
}
boolean ,
licenseModel:
{
Description: The Oracle license model that applies to the Oracle Autonomous Database. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
ncharacterSet:
{
Description: The character set for the Autonomous Database. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Views lifecycleState ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Unavailable: Indicates that resource in Unavailable state ,
RestoreInProgress: Indicates that resource in RestoreInProgress state ,
RestoreFailed: Indicates that resource in RestoreFailed state ,
BackupInProgress: Indicates that resource in BackupInProgress state ,
ScaleInProgress: Indicates that resource in ScaleInProgress state ,
AvailableNeedsAttention: Indicates that resource is available but needs attention ,
Updating: Indicates that resource in Updating state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Restarting: Indicates that resource in Restarting state ,
Recreating: Indicates that resource in Recreating state ,
RoleChangeInProgress: Indicates that resource role change in progress state ,
Upgrading: Indicates that resource in Upgrading state ,
Inaccessible: IIndicates that resource in Inaccessible state ,
Standby: Indicates that resource in Standby state ,
}
,
Required: False ,
}
enum ,
scheduledOperations:
{
Description: The list of scheduled operations. ,
Required: False ,
}
{
dayOfWeek:
{
Description: Day of week ,
Required: True ,
}
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
scheduledStartTime:
{
Description: auto start time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
scheduledStopTime:
{
Description: auto stop time. value must be of ISO-8601 format HH:mm ,
Required: False ,
}
string ,
}
,
privateEndpointIp:
{
Description: The private endpoint Ip address for the resource. ,
Required: False ,
}
string ,
privateEndpointLabel:
{
Description: The resource's private endpoint label. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: False ,
}
string ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the database was created. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceBegin:
{
Description: The date and time when maintenance will begin. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceEnd:
{
Description: The date and time when maintenance will end. ,
Format: date-time ,
Required: False ,
}
string ,
actualUsedDataStorageSizeInTbs:
{
Description: The current amount of storage in use for user and system data, in terabytes (TB). ,
Format: double ,
Required: False ,
}
number ,
allocatedStorageSizeInTbs:
{
Description: The amount of storage currently allocated for the database tables and billed for, rounded up. ,
Format: double ,
Required: False ,
}
number ,
apexDetails:
{
Description: Information about Oracle APEX Application Development. ,
Required: False ,
}
{
apexVersion:
{
Description: The Oracle APEX Application Development version. ,
Required: False ,
}
string ,
ordsVersion:
{
Description: The Oracle REST Data Services (ORDS) version. ,
Required: False ,
}
string ,
}
,
availableUpgradeVersions:
{
Description: List of Oracle Database versions available for a database upgrade. If there are no version upgrades available, this list is empty. ,
Required: False ,
}
[
string ,
]
,
connectionStrings:
{
Description: The connection string used to connect to the Autonomous Database. ,
Required: False ,
}
{
allConnectionStrings:
{
Description: Returns all connection strings that can be used to connect to the Autonomous Database. ,
Required: False ,
}
{
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
}
,
dedicated:
{
Description: The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
high:
{
Description: The High database service provides the highest level of resources to each SQL statement resulting in the highest performance, but supports the fewest number of concurrent SQL statements. ,
Required: False ,
}
string ,
low:
{
Description: The Low database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. ,
Required: False ,
}
string ,
medium:
{
Description: The Medium database service provides a lower level of resources to each SQL statement potentially resulting a lower level of performance, but supports more concurrent SQL statements. ,
Required: False ,
}
string ,
profiles:
{
Description: A list of connection string profiles to allow clients to group, filter and select connection string values based on structured metadata. ,
Required: False ,
}
[
{
consumerGroup:
{
Description: Consumer group used by the connection. ,
Enum:
{
High: High group ,
Medium: Medium group ,
Low: Low group ,
Tp: TP group ,
Tpurgent: TPurgent group ,
}
,
Required: False ,
}
enum ,
displayName:
{
Description: A user-friendly name for the connection. ,
Required: True ,
}
string ,
hostFormat:
{
Description: Host format used in connection string. ,
Enum:
{
Fqdn: FQDN format ,
Ip: IP format ,
}
,
Required: True ,
}
enum ,
isRegional:
{
Description: True for a regional connection string, applicable to cross-region DG only. ,
Required: False ,
}
boolean ,
protocol:
{
Description: Protocol used by the connection. ,
Enum:
{
TCP: TCP protocol ,
TCPS: TCPS protocol ,
}
,
Required: True ,
}
enum ,
sessionMode:
{
Description: Specifies whether the listener performs a direct hand-off of the session, or redirects the session. ,
Enum:
{
Direct: Direct session mode ,
Redirect: Redirect session mode ,
}
,
Required: True ,
}
enum ,
syntaxFormat:
{
Description: Specifies whether the connection string is using the long (LONG), Easy Connect (EZCONNECT), or Easy Connect Plus (EZCONNECTPLUS) format. ,
Enum:
{
Long: Long format ,
Ezconnect: Ezconnect format ,
Ezconnectplus: Ezconnectplus format ,
}
,
Required: True ,
}
enum ,
tlsAuthentication:
{
Description: Specifies whether the TLS handshake is using one-way (SERVER) or mutual (MUTUAL) authentication. ,
Enum:
{
Server: Server authentication ,
Mutual: Mutual TLS ,
}
,
Required: False ,
}
enum ,
value:
{
Description: Connection string value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectionUrls:
{
Description: The 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. ,
Required: False ,
}
{
apexUrl:
{
Description: Oracle Application Express (APEX) URL. ,
Required: False ,
}
string ,
databaseTransformsUrl:
{
Description: The URL of the Database Transforms for the Autonomous Database. ,
Required: False ,
}
string ,
graphStudioUrl:
{
Description: The URL of the Graph Studio for the Autonomous Database. ,
Required: False ,
}
string ,
machineLearningNotebookUrl:
{
Description: The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. ,
Required: False ,
}
string ,
mongoDbUrl:
{
Description: The URL of the MongoDB API for the Autonomous Database. ,
Required: False ,
}
string ,
ordsUrl:
{
Description: The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. ,
Required: False ,
}
string ,
sqlDevWebUrl:
{
Description: Oracle SQL Developer Web URL. ,
Required: False ,
}
string ,
}
,
dataSafeStatus:
{
Description: Status of the Data Safe registration for this Autonomous Database. ,
Enum:
{
Registering: Registering status ,
Registered: Registered status ,
Deregistering: Deregistering status ,
NotRegistered: NotRegistered status ,
Failed: Failed status ,
}
,
Required: False ,
}
enum ,
databaseEdition:
{
Description: The Oracle Database Edition that applies to the Autonomous databases. ,
Enum:
{
StandardEdition: Standard edition ,
EnterpriseEdition: Enterprise edition ,
}
,
Required: False ,
}
enum ,
autonomousDatabaseId:
{
Description: Autonomous Database ID ,
Format: arm-id ,
Required: False ,
}
string ,
inMemoryAreaInGbs:
{
Description: The area assigned to In-Memory tables in Autonomous Database. ,
Format: int32 ,
Required: False ,
}
integer ,
nextLongTermBackupTimeStamp:
{
Description: The date and time when the next long-term backup would be created. ,
Format: date-time ,
Required: False ,
}
string ,
longTermBackupSchedule:
{
Description: Details for the long-term backup schedule. ,
Required: False ,
}
{
repeatCadence:
{
Description: The frequency of the long-term backup schedule ,
Enum:
{
OneTime: Repeat one time ,
Weekly: Repeat weekly ,
Monthly: Repeat monthly ,
Yearly: Repeat yearly ,
}
,
Required: False ,
}
enum ,
timeOfBackup:
{
Description: The timestamp for the long-term backup schedule. For a MONTHLY cadence, months having fewer days than the provided date will have the backup taken on the last day of that month. ,
Format: date-time ,
Required: False ,
}
string ,
retentionPeriodInDays:
{
Description: Retention period, in days, for backups. ,
Format: int32 ,
Required: False ,
}
integer ,
isDisabled:
{
Description: Indicates if the long-term backup schedule should be deleted. The default value is `FALSE`. ,
Required: False ,
}
boolean ,
}
,
isPreview:
{
Description: Indicates if the Autonomous Database version is a preview version. ,
Required: False ,
}
boolean ,
localAdgAutoFailoverMaxDataLossLimit:
{
Description: Parameter 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 ,
Format: int32 ,
Required: False ,
}
integer ,
memoryPerOracleComputeUnitInGbs:
{
Description: The amount of memory (in GBs) enabled per ECPU or OCPU. ,
Format: int32 ,
Required: False ,
}
integer ,
openMode:
{
Description: Indicates the Autonomous Database mode. ,
Enum:
{
ReadOnly: ReadOnly mode ,
ReadWrite: ReadWrite mode ,
}
,
Required: False ,
}
enum ,
operationsInsightsStatus:
{
Description: Status of Operations Insights for this Autonomous Database. ,
Enum:
{
Enabling: Enabling status ,
Enabled: Enabled status ,
Disabling: Disabling status ,
NotEnabled: NotEnabled status ,
FailedEnabling: FailedEnabling status ,
FailedDisabling: FailedDisabling status ,
}
,
Required: False ,
}
enum ,
permissionLevel:
{
Description: The Autonomous Database permission level. ,
Enum:
{
Restricted: Restricted permission level ,
Unrestricted: Unrestricted permission level ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: The private endpoint for the resource. ,
Required: False ,
}
string ,
provisionableCpus:
{
Description: An array of CPU values that an Autonomous Database can be scaled to. ,
Required: False ,
}
[
integer ,
]
,
role:
{
Description: The Data Guard role of the Autonomous Container Database or Autonomous Database, if Autonomous Data Guard is enabled. ,
Enum:
{
Primary: Primary role ,
Standby: Standby role ,
DisabledStandby: DisabledStandby role ,
BackupCopy: BackupCopy role ,
SnapshotStandby: SnapshotStandby role ,
}
,
Required: False ,
}
enum ,
serviceConsoleUrl:
{
Description: The URL of the Service Console for the Autonomous Database. ,
Required: False ,
}
string ,
sqlWebDeveloperUrl:
{
Description: The SQL Web Developer URL for the Oracle Autonomous Database. ,
Required: False ,
}
string ,
supportedRegionsToCloneTo:
{
Description: The list of regions that support the creation of an Autonomous Database clone or an Autonomous Data Guard standby database. ,
Required: False ,
}
[
string ,
]
,
timeDataGuardRoleChanged:
{
Description: The date and time the Autonomous Data Guard role was switched for the Autonomous Database. ,
Required: False ,
}
string ,
timeDeletionOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be automatically deleted because of inactivity. ,
Required: False ,
}
string ,
timeLocalDataGuardEnabled:
{
Description: The 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. ,
Required: False ,
}
string ,
timeOfLastFailover:
{
Description: The timestamp of the last failover operation. ,
Required: False ,
}
string ,
timeOfLastRefresh:
{
Description: The date and time when last refresh happened. ,
Required: False ,
}
string ,
timeOfLastRefreshPoint:
{
Description: The refresh point timestamp (UTC). ,
Required: False ,
}
string ,
timeOfLastSwitchover:
{
Description: The timestamp of the last switchover operation for the Autonomous Database. ,
Required: False ,
}
string ,
timeReclamationOfFreeAutonomousDatabase:
{
Description: The date and time the Always Free database will be stopped because of inactivity. ,
Required: False ,
}
string ,
usedDataStorageSizeInGbs:
{
Description: The storage space consumed by Autonomous Database in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDataStorageSizeInTbs:
{
Description: The amount of storage that has been used, in terabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: Database ocid ,
Required: False ,
}
string ,
backupRetentionPeriodInDays:
{
Description: Retention period, in days, for long-term backups ,
Format: int32 ,
Required: False ,
}
integer ,
whitelistedIps:
{
Description: The 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'] ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_ListByResourceGroup (new)
Description :  List CloudExadataInfrastructure resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CloudExadataInfrastructure items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_Get (new)
Description :  Get a CloudExadataInfrastructure
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_CreateOrUpdate (new)
Description :  Create a CloudExadataInfrastructure
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: CloudExadataInfrastructure resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_Update (new)
Description :  Update a CloudExadataInfrastructure
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_Delete (new)
Description :  Delete a CloudExadataInfrastructure
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudExadataInfrastructures_AddStorageCapacity (new)
Description :  Perform add storage capacity on exadata infra
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/addStorageCapacity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
definedFileSystemConfiguration:
{
Description: Defined file system configurations ,
Required: False ,
}
[
{
isBackupPartition:
{
Description: Checks if the data can be backed up ,
Required: False ,
}
boolean ,
isResizable:
{
Description: Checks if the mount path is resizable ,
Required: False ,
}
boolean ,
minSizeGb:
{
Description: Minimum size of mount path in Gb ,
Format: int32 ,
Required: False ,
}
integer ,
mountPoint:
{
Description: Mount path for the file system ,
Required: False ,
}
string ,
}
,
]
,
ocid:
{
Description: Exadata infra ocid ,
Required: False ,
}
string ,
computeCount:
{
Description: The number of compute servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
storageCount:
{
Description: The number of storage servers for the cloud Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
totalStorageSizeInGbs:
{
Description: The total storage allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
availableStorageSizeInGbs:
{
Description: The available storage can be allocated to the cloud Exadata infrastructure resource, in gigabytes (GB). ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time the cloud Exadata infrastructure resource was created. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
maintenanceWindow:
{
Description: maintenanceWindow property ,
Required: False ,
}
{
preference:
{
Description: The maintenance window scheduling preference. ,
Enum:
{
NoPreference: No preference ,
CustomPreference: Custom preference ,
}
,
Required: False ,
}
enum ,
months:
{
Description: Months during the year when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the month of the year. ,
Enum:
{
January: January value ,
February: February value ,
March: March value ,
April: April value ,
May: May value ,
June: June value ,
July: July value ,
August: August value ,
September: September value ,
October: October value ,
November: November value ,
December: December value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
weeksOfMonth:
{
Description: Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. For example, to allow maintenance during the 2nd week of the month (from the 8th day to the 14th day of the month), use the value 2. Maintenance cannot be scheduled for the fifth week of months that contain more than 28 days. Note that this parameter works in conjunction with the daysOfWeek and hoursOfDay parameters to allow you to specify specific days of the week and hours that maintenance will be performed. ,
Required: False ,
}
[
integer ,
]
,
daysOfWeek:
{
Description: Days during the week when maintenance should be performed. ,
Required: False ,
}
[
{
name:
{
Description: Name of the day of the week. ,
Enum:
{
Monday: Monday value ,
Tuesday: Tuesday value ,
Wednesday: Wednesday value ,
Thursday: Thursday value ,
Friday: Friday value ,
Saturday: Saturday value ,
Sunday: Sunday value ,
}
,
Required: True ,
}
enum ,
}
,
]
,
hoursOfDay:
{
Description: The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are - 0 - represents time slot 0:00 - 3:59 UTC - 4 - represents time slot 4:00 - 7:59 UTC - 8 - represents time slot 8:00 - 11:59 UTC - 12 - represents time slot 12:00 - 15:59 UTC - 16 - represents time slot 16:00 - 19:59 UTC - 20 - represents time slot 20:00 - 23:59 UTC ,
Required: False ,
}
[
integer ,
]
,
leadTimeInWeeks:
{
Description: Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. ,
Format: int32 ,
Required: False ,
}
integer ,
patchingMode:
{
Description: Cloud Exadata infrastructure node patching method. ,
Enum:
{
Rolling: Rolling patching ,
NonRolling: Non Rolling patching ,
}
,
Required: False ,
}
enum ,
customActionTimeoutInMins:
{
Description: Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). ,
Format: int32 ,
Required: False ,
}
integer ,
isCustomActionTimeoutEnabled:
{
Description: If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. ,
Required: False ,
}
boolean ,
isMonthlyPatchingEnabled:
{
Description: is Monthly Patching Enabled ,
Required: False ,
}
boolean ,
}
,
estimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations (database server, storage server, and network switch patching). ,
Required: False ,
}
{
estimatedDbServerPatchingTime:
{
Description: The estimated time required in minutes for database server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedNetworkSwitchesPatchingTime:
{
Description: The estimated time required in minutes for network switch patching. ,
Format: int32 ,
Required: False ,
}
integer ,
estimatedStorageServerPatchingTime:
{
Description: The estimated time required in minutes for storage server patching. ,
Format: int32 ,
Required: False ,
}
integer ,
totalEstimatedPatchingTime:
{
Description: The estimated total time required in minutes for all patching operations. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
customerContacts:
{
Description: The list of customer email addresses that receive information from Oracle about the specified OCI Database service resource. Oracle uses these email addresses to send notifications about planned and unplanned software maintenance updates, information about system hardware, and other information needed by administrators. Up to 10 email addresses can be added to the customer contacts for a cloud Exadata infrastructure instance. ,
Required: False ,
}
[
{
email:
{
Description: The email address used by Oracle to send notifications regarding databases and infrastructure. ,
Required: True ,
}
string ,
}
,
]
,
provisioningState:
{
Description: CloudExadataInfrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudExadataInfrastructure lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
shape:
{
Description: The model name of the cloud Exadata infrastructure resource. ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
cpuCount:
{
Description: The total number of CPU cores allocated. ,
Format: int32 ,
Required: False ,
}
integer ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
maxDbNodeStorageSizeInGbs:
{
Description: The total local node storage available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dataStorageSizeInTbs:
{
Description: The quantity of data in the database, in terabytes. ,
Format: double ,
Required: False ,
}
number ,
maxDataStorageInTbs:
{
Description: The total available DATA disk group size. ,
Format: double ,
Required: False ,
}
number ,
dbServerVersion:
{
Description: The software version of the database servers (dom0) in the Exadata infrastructure. ,
Required: False ,
}
string ,
storageServerVersion:
{
Description: The software version of the storage servers (cells) in the Exadata infrastructure. ,
Required: False ,
}
string ,
activatedStorageCount:
{
Description: The requested number of additional storage servers activated for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalStorageCount:
{
Description: The requested number of additional storage servers for the Exadata infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: The name for the Exadata infrastructure. ,
Required: True ,
}
string ,
lastMaintenanceRunId:
{
Description: The OCID of the last maintenance run. ,
Required: False ,
}
string ,
nextMaintenanceRunId:
{
Description: The OCID of the next maintenance run. ,
Required: False ,
}
string ,
monthlyDbServerVersion:
{
Description: Monthly Db Server version ,
Required: False ,
}
string ,
monthlyStorageServerVersion:
{
Description: Monthly Storage Server version ,
Required: False ,
}
string ,
databaseServerType:
{
Description: The database server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
storageServerType:
{
Description: The storage server model type of the cloud Exadata infrastructure resource. ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
zones:
{
Description: CloudExadataInfrastructure zones ,
Required: True ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbServers_ListByParent (new)
Description :  List DbServer resources by CloudExadataInfrastructure
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DbServer items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Db server name. ,
Required: False ,
}
string ,
displayName:
{
Description: The name for the Db Server. ,
Required: False ,
}
string ,
compartmentId:
{
Description: The OCID of the compartment. ,
Required: False ,
}
string ,
exadataInfrastructureId:
{
Description: The OCID of the Exadata infrastructure. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db server. ,
Format: int32 ,
Required: False ,
}
integer ,
dbServerPatchingDetails:
{
Description: dbServerPatching details of the Db server. ,
Required: False ,
}
{
estimatedPatchDuration:
{
Description: Estimated Patch Duration ,
Format: int32 ,
Required: False ,
}
integer ,
patchingStatus:
{
Description: Patching Status ,
Enum:
{
Scheduled: Patching scheduled ,
MaintenanceInProgress: Patching in progress ,
Failed: Patching failed ,
Complete: Patching completed ,
}
,
Required: False ,
}
enum ,
timePatchingEnded:
{
Description: Time Patching Ended ,
Format: date-time ,
Required: False ,
}
string ,
timePatchingStarted:
{
Description: Time Patching Started ,
Format: date-time ,
Required: False ,
}
string ,
}
,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db server. ,
Format: int32 ,
Required: False ,
}
integer ,
vmClusterIds:
{
Description: The OCID of the VM Clusters associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
dbNodeIds:
{
Description: The OCID of the Db nodes associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
lifecycleDetails:
{
Description: Lifecycle details of dbServer. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: DbServer provisioning state. ,
Enum:
{
Creating: Indicates that resource in Creating state ,
Available: Indicates that resource in Available state ,
Unavailable: Indicates that resource in Unavailable state ,
Deleting: Indicates that resource in Deleting state ,
Deleted: Indicates that resource in Deleted state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
}
,
Required: False ,
}
enum ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
autonomousVmClusterIds:
{
Description: The list of OCIDs of the Autonomous VM Clusters associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
autonomousVirtualMachineIds:
{
Description: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
maxDbNodeStorageInGbs:
{
Description: The total max dbNode storage in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The total memory size in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the Db Server was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbServers_Get (new)
Description :  Get a DbServer
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudExadataInfrastructures/{cloudexadatainfrastructurename}/dbServers/{dbserverocid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudexadatainfrastructurename:
{
Description: CloudExadataInfrastructure name ,
Required: True ,
}
string ,
dbserverocid:
{
Description: DbServer OCID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Db server name. ,
Required: False ,
}
string ,
displayName:
{
Description: The name for the Db Server. ,
Required: False ,
}
string ,
compartmentId:
{
Description: The OCID of the compartment. ,
Required: False ,
}
string ,
exadataInfrastructureId:
{
Description: The OCID of the Exadata infrastructure. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db server. ,
Format: int32 ,
Required: False ,
}
integer ,
dbServerPatchingDetails:
{
Description: dbServerPatching details of the Db server. ,
Required: False ,
}
{
estimatedPatchDuration:
{
Description: Estimated Patch Duration ,
Format: int32 ,
Required: False ,
}
integer ,
patchingStatus:
{
Description: Patching Status ,
Enum:
{
Scheduled: Patching scheduled ,
MaintenanceInProgress: Patching in progress ,
Failed: Patching failed ,
Complete: Patching completed ,
}
,
Required: False ,
}
enum ,
timePatchingEnded:
{
Description: Time Patching Ended ,
Format: date-time ,
Required: False ,
}
string ,
timePatchingStarted:
{
Description: Time Patching Started ,
Format: date-time ,
Required: False ,
}
string ,
}
,
maxMemoryInGbs:
{
Description: The total memory available in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db server. ,
Format: int32 ,
Required: False ,
}
integer ,
vmClusterIds:
{
Description: The OCID of the VM Clusters associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
dbNodeIds:
{
Description: The OCID of the Db nodes associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
lifecycleDetails:
{
Description: Lifecycle details of dbServer. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: DbServer provisioning state. ,
Enum:
{
Creating: Indicates that resource in Creating state ,
Available: Indicates that resource in Available state ,
Unavailable: Indicates that resource in Unavailable state ,
Deleting: Indicates that resource in Deleting state ,
Deleted: Indicates that resource in Deleted state ,
MaintenanceInProgress: Indicates that resource maintenance in progress state ,
}
,
Required: False ,
}
enum ,
maxCpuCount:
{
Description: The total number of CPU cores available. ,
Format: int32 ,
Required: False ,
}
integer ,
autonomousVmClusterIds:
{
Description: The list of OCIDs of the Autonomous VM Clusters associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
autonomousVirtualMachineIds:
{
Description: The list of OCIDs of the Autonomous Virtual Machines associated with the Db server. ,
Required: False ,
}
[
string ,
]
,
maxDbNodeStorageInGbs:
{
Description: The total max dbNode storage in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The total memory size in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available. ,
Required: False ,
}
string ,
timeCreated:
{
Description: The date and time that the Db Server was created. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
computeModel:
{
Description: The compute model of the Exadata Infrastructure ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_ListByResourceGroup (new)
Description :  List CloudVmCluster resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The CloudVmCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_Get (new)
Description :  Get a CloudVmCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_CreateOrUpdate (new)
Description :  Create a CloudVmCluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: CloudVmCluster resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_Update (new)
Description :  Update a CloudVmCluster
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: False ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_Delete (new)
Description :  Delete a CloudVmCluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_AddVms (new)
Description :  Add VMs to the VM Cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/addVms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
dbServers:
{
Description: Db servers ocids ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbNodes_ListByParent (new)
Description :  List DbNode resources by CloudVmCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DbNode items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: DbNode OCID ,
Required: True ,
}
string ,
additionalDetails:
{
Description: Additional information about the planned maintenance. ,
Required: False ,
}
string ,
backupIpId:
{
Description: The OCID of the backup IP address associated with the database node. ,
Required: False ,
}
string ,
backupVnic2Id:
{
Description: The OCID of the second backup VNIC. ,
Required: False ,
}
string ,
backupVnicId:
{
Description: The OCID of the backup VNIC. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbServerId:
{
Description: The OCID of the Exacc Db server associated with the database node. ,
Required: False ,
}
string ,
dbSystemId:
{
Description: The OCID of the DB system. ,
Required: True ,
}
string ,
faultDomain:
{
Description: The name of the Fault Domain the instance is contained in. ,
Required: False ,
}
string ,
hostIpId:
{
Description: The OCID of the host IP address associated with the database node. ,
Required: False ,
}
string ,
hostname:
{
Description: The host name for the database node. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the database node. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: True ,
}
enum ,
lifecycleDetails:
{
Description: Lifecycle details of Db Node. ,
Required: False ,
}
string ,
maintenanceType:
{
Description: The type of database node maintenance. ,
Enum:
{
VmdbRebootMigration: VMDB reboot migration maintenance type ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The allocated memory in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
softwareStorageSizeInGb:
{
Description: The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the database node was created. ,
Format: date-time ,
Required: True ,
}
string ,
timeMaintenanceWindowEnd:
{
Description: End date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceWindowStart:
{
Description: Start date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
vnic2Id:
{
Description: The OCID of the second VNIC. ,
Required: False ,
}
string ,
vnicId:
{
Description: The OCID of the VNIC. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbNodes_Get (new)
Description :  Get a DbNode
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
dbnodeocid:
{
Description: DbNode OCID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: DbNode OCID ,
Required: True ,
}
string ,
additionalDetails:
{
Description: Additional information about the planned maintenance. ,
Required: False ,
}
string ,
backupIpId:
{
Description: The OCID of the backup IP address associated with the database node. ,
Required: False ,
}
string ,
backupVnic2Id:
{
Description: The OCID of the second backup VNIC. ,
Required: False ,
}
string ,
backupVnicId:
{
Description: The OCID of the backup VNIC. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbServerId:
{
Description: The OCID of the Exacc Db server associated with the database node. ,
Required: False ,
}
string ,
dbSystemId:
{
Description: The OCID of the DB system. ,
Required: True ,
}
string ,
faultDomain:
{
Description: The name of the Fault Domain the instance is contained in. ,
Required: False ,
}
string ,
hostIpId:
{
Description: The OCID of the host IP address associated with the database node. ,
Required: False ,
}
string ,
hostname:
{
Description: The host name for the database node. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the database node. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: True ,
}
enum ,
lifecycleDetails:
{
Description: Lifecycle details of Db Node. ,
Required: False ,
}
string ,
maintenanceType:
{
Description: The type of database node maintenance. ,
Enum:
{
VmdbRebootMigration: VMDB reboot migration maintenance type ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The allocated memory in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
softwareStorageSizeInGb:
{
Description: The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the database node was created. ,
Format: date-time ,
Required: True ,
}
string ,
timeMaintenanceWindowEnd:
{
Description: End date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceWindowStart:
{
Description: Start date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
vnic2Id:
{
Description: The OCID of the second VNIC. ,
Required: False ,
}
string ,
vnicId:
{
Description: The OCID of the VNIC. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DbNodes_Action (new)
Description :  VM actions on DbNode of VM Cluster by the provided filter
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/dbNodes/{dbnodeocid}/action
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
dbnodeocid:
{
Description: DbNode OCID. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
action:
{
Description: Db action ,
Enum:
{
Start: Start DbNode ,
Stop: Stop DbNode ,
SoftReset: Soft reset DbNode ,
Reset: Reset DbNode ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: DbNode OCID ,
Required: True ,
}
string ,
additionalDetails:
{
Description: Additional information about the planned maintenance. ,
Required: False ,
}
string ,
backupIpId:
{
Description: The OCID of the backup IP address associated with the database node. ,
Required: False ,
}
string ,
backupVnic2Id:
{
Description: The OCID of the second backup VNIC. ,
Required: False ,
}
string ,
backupVnicId:
{
Description: The OCID of the backup VNIC. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbServerId:
{
Description: The OCID of the Exacc Db server associated with the database node. ,
Required: False ,
}
string ,
dbSystemId:
{
Description: The OCID of the DB system. ,
Required: True ,
}
string ,
faultDomain:
{
Description: The name of the Fault Domain the instance is contained in. ,
Required: False ,
}
string ,
hostIpId:
{
Description: The OCID of the host IP address associated with the database node. ,
Required: False ,
}
string ,
hostname:
{
Description: The host name for the database node. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the database node. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: True ,
}
enum ,
lifecycleDetails:
{
Description: Lifecycle details of Db Node. ,
Required: False ,
}
string ,
maintenanceType:
{
Description: The type of database node maintenance. ,
Enum:
{
VmdbRebootMigration: VMDB reboot migration maintenance type ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The allocated memory in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
softwareStorageSizeInGb:
{
Description: The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the database node was created. ,
Format: date-time ,
Required: True ,
}
string ,
timeMaintenanceWindowEnd:
{
Description: End date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceWindowStart:
{
Description: Start date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
vnic2Id:
{
Description: The OCID of the second VNIC. ,
Required: False ,
}
string ,
vnicId:
{
Description: The OCID of the VNIC. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_ListPrivateIpAddresses (new)
Description :  List Private IP Addresses by the provided filter
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
subnetId:
{
Description: Subnet OCID ,
Required: True ,
}
string ,
vnicId:
{
Description: VCN OCID ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
displayName:
{
Description: PrivateIpAddresses displayName ,
Required: True ,
}
string ,
hostnameLabel:
{
Description: PrivateIpAddresses hostnameLabel ,
Required: True ,
}
string ,
ocid:
{
Description: PrivateIpAddresses Id ,
Required: True ,
}
string ,
ipAddress:
{
Description: PrivateIpAddresses ipAddress ,
Required: True ,
}
string ,
subnetId:
{
Description: PrivateIpAddresses subnetId ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CloudVmClusters_RemoveVms (new)
Description :  Remove VMs from the VM Cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/removeVms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
dbServers:
{
Description: Db servers ocids ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: Cloud VM Cluster ocid ,
Required: False ,
}
string ,
listenerPort:
{
Description: The port number configured for the listener on the cloud VM cluster. ,
Format: int64 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the cloud VM cluster. ,
Format: int32 ,
Required: False ,
}
integer ,
storageSizeInGbs:
{
Description: The data disk group size to be allocated in GBs per VM. ,
Format: int32 ,
Required: False ,
}
integer ,
fileSystemConfigurationDetails:
{
Description: Array of mount path and size. ,
Required: False ,
}
[
{
mountPoint:
{
Description: Mount path ,
Required: False ,
}
string ,
fileSystemSizeGb:
{
Description: Size of the VM ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
dataStorageSizeInTbs:
{
Description: The data disk group size to be allocated in TBs. ,
Format: double ,
Required: False ,
}
number ,
dbNodeStorageSizeInGbs:
{
Description: The local node storage to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
memorySizeInGbs:
{
Description: The memory to be allocated in GBs. ,
Format: int32 ,
Required: False ,
}
integer ,
timeCreated:
{
Description: The date and time that the cloud VM cluster was created. ,
Format: date-time ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the cloud VM cluster. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
zoneId:
{
Description: The OCID of the zone the cloud VM cluster is associated with. ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the cloud VM cluster. ,
Required: True ,
}
string ,
domain:
{
Description: The domain name for the cloud VM cluster. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the cloud VM cluster. ,
Format: int32 ,
Required: True ,
}
integer ,
ocpuCount:
{
Description: The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part. ,
Format: float ,
Required: False ,
}
number ,
clusterName:
{
Description: The cluster name for cloud VM cluster. 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. ,
Required: False ,
}
string ,
dataStoragePercentage:
{
Description: The percentage assigned to DATA storage (user data and database files). The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See [Storage Configuration](/Content/Database/Concepts/exaoverview.htm#Exadata) in the Exadata documentation for details on the impact of the configuration settings on storage. ,
Format: int32 ,
Required: False ,
}
integer ,
isLocalBackupEnabled:
{
Description: If true, database backup on local Exadata storage is configured for the cloud VM cluster. If false, database backup on local Exadata storage is not available in the cloud VM cluster. ,
Required: False ,
}
boolean ,
cloudExadataInfrastructureId:
{
Description: Cloud Exadata Infrastructure ID ,
Format: arm-id ,
Required: True ,
}
string ,
isSparseDiskgroupEnabled:
{
Description: If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created. ,
Required: False ,
}
boolean ,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the cloud VM cluster. ,
Required: True ,
}
[
string ,
]
,
licenseModel:
{
Description: The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
diskRedundancy:
{
Description: The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy. ,
Enum:
{
High: High redundancy ,
Normal: Normal redundancy ,
}
,
Required: False ,
}
enum ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the cloud VM cluster. 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. ,
Required: False ,
}
[
string ,
]
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the cloud VM cluster. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster. ,
Required: False ,
}
string ,
shape:
{
Description: The model name of the Exadata hardware running the cloud VM cluster. ,
Required: False ,
}
string ,
provisioningState:
{
Description: CloudVmCluster provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: True ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
computeNodes:
{
Description: The list of compute servers to be added to the cloud VM cluster. ,
Required: False ,
}
[
string ,
]
,
iormConfigCache:
{
Description: iormConfigCache details for cloud VM cluster. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
lastUpdateHistoryEntryId:
{
Description: The OCID of the last maintenance update history entry. ,
Required: False ,
}
string ,
dbServers:
{
Description: The list of DB servers. ,
Required: False ,
}
[
string ,
]
,
compartmentId:
{
Description: Cluster compartmentId ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
computeModel:
{
Description: The compute model of the VM Cluster. ,
Enum:
{
ECPU: ECPU model type ,
OCPU: OCPU model type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkAddresses_ListByParent (new)
Description :  List VirtualNetworkAddress resources by CloudVmCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The VirtualNetworkAddress items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipAddress:
{
Description: Virtual network Address address. ,
Required: False ,
}
string ,
vmOcid:
{
Description: Virtual Machine OCID. ,
Required: False ,
}
string ,
ocid:
{
Description: Application VIP OCID. ,
Required: False ,
}
string ,
domain:
{
Description: Virtual network address fully qualified domain name. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: virtual network address lifecycle state. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
timeAssigned:
{
Description: The date and time when the create operation for the application virtual IP (VIP) address completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkAddresses_Get (new)
Description :  Get a VirtualNetworkAddress
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
virtualnetworkaddressname:
{
Description: Virtual IP address hostname. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipAddress:
{
Description: Virtual network Address address. ,
Required: False ,
}
string ,
vmOcid:
{
Description: Virtual Machine OCID. ,
Required: False ,
}
string ,
ocid:
{
Description: Application VIP OCID. ,
Required: False ,
}
string ,
domain:
{
Description: Virtual network address fully qualified domain name. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: virtual network address lifecycle state. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
timeAssigned:
{
Description: The date and time when the create operation for the application virtual IP (VIP) address completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkAddresses_CreateOrUpdate (new)
Description :  Create a VirtualNetworkAddress
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
virtualnetworkaddressname:
{
Description: Virtual IP address hostname. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipAddress:
{
Description: Virtual network Address address. ,
Required: False ,
}
string ,
vmOcid:
{
Description: Virtual Machine OCID. ,
Required: False ,
}
string ,
ocid:
{
Description: Application VIP OCID. ,
Required: False ,
}
string ,
domain:
{
Description: Virtual network address fully qualified domain name. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: virtual network address lifecycle state. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
timeAssigned:
{
Description: The date and time when the create operation for the application virtual IP (VIP) address completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipAddress:
{
Description: Virtual network Address address. ,
Required: False ,
}
string ,
vmOcid:
{
Description: Virtual Machine OCID. ,
Required: False ,
}
string ,
ocid:
{
Description: Application VIP OCID. ,
Required: False ,
}
string ,
domain:
{
Description: Virtual network address fully qualified domain name. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: virtual network address lifecycle state. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
timeAssigned:
{
Description: The date and time when the create operation for the application virtual IP (VIP) address completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Virtual IP resource belonging to a vm cluster resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ipAddress:
{
Description: Virtual network Address address. ,
Required: False ,
}
string ,
vmOcid:
{
Description: Virtual Machine OCID. ,
Required: False ,
}
string ,
ocid:
{
Description: Application VIP OCID. ,
Required: False ,
}
string ,
domain:
{
Description: Virtual network address fully qualified domain name. ,
Required: False ,
}
string ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state of the application virtual IP (VIP) address. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Azure resource provisioning state. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: virtual network address lifecycle state. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
timeAssigned:
{
Description: The date and time when the create operation for the application virtual IP (VIP) address completed. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VirtualNetworkAddresses_Delete (new)
Description :  Delete a VirtualNetworkAddress
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/virtualNetworkAddresses/{virtualnetworkaddressname}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
cloudvmclustername:
{
Description: CloudVmCluster name ,
Required: True ,
}
string ,
virtualnetworkaddressname:
{
Description: Virtual IP address hostname. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_ListByResourceGroup (new)
Description :  List ExadbVmCluster resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExadbVmCluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_Get (new)
Description :  Get a ExadbVmCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_CreateOrUpdate (new)
Description :  Create a ExadbVmCluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: ExadbVmCluster resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_Update (new)
Description :  Update a ExadbVmCluster
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_Delete (new)
Description :  Delete a ExadbVmCluster
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbNodes_ListByParent (new)
Description :  List ExascaleDbNode resources by ExadbVmCluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}/dbNodes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExascaleDbNode items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: DbNode OCID ,
Required: True ,
}
string ,
additionalDetails:
{
Description: Additional information about the planned maintenance. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
faultDomain:
{
Description: The name of the Fault Domain the instance is contained in. ,
Required: False ,
}
string ,
hostname:
{
Description: The host name for the database node. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the database node. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
maintenanceType:
{
Description: The type of database node maintenance. ,
Required: False ,
}
string ,
memorySizeInGbs:
{
Description: The allocated memory in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
softwareStorageSizeInGb:
{
Description: The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ,
Format: int32 ,
Required: False ,
}
integer ,
timeMaintenanceWindowEnd:
{
Description: End date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceWindowStart:
{
Description: Start date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
totalCpuCoreCount:
{
Description: The total number of CPU cores reserved on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbNodes_Get (new)
Description :  Get a ExascaleDbNode
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}/dbNodes/{exascaleDbNodeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
exascaleDbNodeName:
{
Description: The name of the ExascaleDbNode ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: DbNode OCID ,
Required: True ,
}
string ,
additionalDetails:
{
Description: Additional information about the planned maintenance. ,
Required: False ,
}
string ,
cpuCoreCount:
{
Description: The number of CPU cores enabled on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
dbNodeStorageSizeInGbs:
{
Description: The allocated local node storage in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
faultDomain:
{
Description: The name of the Fault Domain the instance is contained in. ,
Required: False ,
}
string ,
hostname:
{
Description: The host name for the database node. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of the database node. ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Stopping: Indicates that resource in Stopping state ,
Stopped: Indicates that resource in Stopped state ,
Starting: Indicates that resource in Starting state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
maintenanceType:
{
Description: The type of database node maintenance. ,
Required: False ,
}
string ,
memorySizeInGbs:
{
Description: The allocated memory in GBs on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
softwareStorageSizeInGb:
{
Description: The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems. ,
Format: int32 ,
Required: False ,
}
integer ,
timeMaintenanceWindowEnd:
{
Description: End date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
timeMaintenanceWindowStart:
{
Description: Start date and time of maintenance window. ,
Format: date-time ,
Required: False ,
}
string ,
totalCpuCoreCount:
{
Description: The total number of CPU cores reserved on the Db node. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbNodes_Action (new)
Description :  VM actions on DbNode of ExadbVmCluster by the provided filter
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}/dbNodes/{exascaleDbNodeName}/action
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
exascaleDbNodeName:
{
Description: The name of the ExascaleDbNode ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
action:
{
Description: Db action ,
Enum:
{
Start: Start DbNode ,
Stop: Stop DbNode ,
SoftReset: Soft reset DbNode ,
Reset: Reset DbNode ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
provisioningState:
{
Description: ExascaleDbNode provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExadbVmClusters_RemoveVms (new)
Description :  Remove VMs from the VM Cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exadbVmClusters/{exadbVmClusterName}/removeVms
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exadbVmClusterName:
{
Description: The name of the ExadbVmCluster ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
dbNodes:
{
Description: The list of ExaCS DB nodes for the Exadata VM cluster on Exascale Infrastructure to be removed. ,
Required: True ,
}
[
{
dbNodeId:
{
Description: Exascale DbNode Azure Resource ID ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
ocid:
{
Description: ExadbVmCluster ocid ,
Required: False ,
}
string ,
clusterName:
{
Description: The cluster name for Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
string ,
backupSubnetCidr:
{
Description: Client OCI backup subnet CIDR, default is 192.168.252.0/22 ,
Required: False ,
}
string ,
nsgUrl:
{
Description: HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata VM cluster on Exascale Infrastructure provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: CloudVmCluster lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
MaintenanceInProgress: Indicates that resource Maintenance in progress state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
vnetId:
{
Description: VNET for network connectivity ,
Format: arm-id ,
Required: True ,
}
string ,
subnetId:
{
Description: Client subnet ,
Format: arm-id ,
Required: True ,
}
string ,
dataCollectionOptions:
{
Description: Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
{
isDiagnosticsEventsEnabled:
{
Description: Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS. ,
Required: False ,
}
boolean ,
isHealthMonitoringEnabled:
{
Description: Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
isIncidentLogsEnabled:
{
Description: Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Display Name ,
Required: True ,
}
string ,
domain:
{
Description: A domain name used for the Exadata VM cluster on Exascale Infrastructure ,
Required: False ,
}
string ,
enabledEcpuCount:
{
Description: The number of ECPUs to enable for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
exascaleDbStorageVaultId:
{
Description: The Azure Resource ID of the Exadata Database Storage Vault. ,
Format: arm-id ,
Required: True ,
}
string ,
gridImageOcid:
{
Description: Grid Setup will be done using this Grid Image OCID. Can be obtained using giMinorVersions API ,
Required: False ,
}
string ,
gridImageType:
{
Description: The type of Grid Image ,
Enum:
{
ReleaseUpdate: Release update ,
CustomImage: Custom image ,
}
,
Required: False ,
}
enum ,
giVersion:
{
Description: Oracle Grid Infrastructure (GI) software version ,
Required: False ,
}
string ,
hostname:
{
Description: The hostname for the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
string ,
licenseModel:
{
Description: The Oracle license model that applies to the Exadata VM cluster on Exascale Infrastructure. The default is LICENSE_INCLUDED. ,
Enum:
{
LicenseIncluded: License included ,
BringYourOwnLicense: Bring Your Own License ,
}
,
Required: False ,
}
enum ,
memorySizeInGbs:
{
Description: The memory that you want to be allocated in GBs. Memory is calculated based on 11 GB per VM core reserved. ,
Format: int32 ,
Required: False ,
}
integer ,
nodeCount:
{
Description: The number of nodes in the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
nsgCidrs:
{
Description: CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default. ,
Required: False ,
}
[
{
source:
{
Description: Conceptually, this is the range of IP addresses that a packet coming into the instance can come from. ,
Required: True ,
}
string ,
destinationPortRange:
{
Description: Destination port range to specify particular destination ports for TCP rules. ,
Required: False ,
}
{
min:
{
Description: The minimum port number, which must not be greater than the maximum port number. ,
Format: int32 ,
Required: True ,
}
integer ,
max:
{
Description: The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
zoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
privateZoneOcid:
{
Description: The OCID of the zone the Exadata VM cluster on Exascale Infrastructure is associated with. ,
Required: False ,
}
string ,
scanListenerPortTcp:
{
Description: The TCP Single Client Access Name (SCAN) port. The default port is 1521. ,
Format: int32 ,
Required: False ,
}
integer ,
scanListenerPortTcpSsl:
{
Description: The TCPS Single Client Access Name (SCAN) port. The default port is 2484. ,
Format: int32 ,
Required: False ,
}
integer ,
listenerPort:
{
Description: The port number configured for the listener on the Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: False ,
}
integer ,
shape:
{
Description: The shape of the Exadata VM cluster on Exascale Infrastructure resource ,
Required: True ,
}
string ,
sshPublicKeys:
{
Description: The public key portion of one or more key pairs used for SSH access to the Exadata VM cluster on Exascale Infrastructure. ,
Required: True ,
}
[
string ,
]
,
systemVersion:
{
Description: Operating system version of the image. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone of the Exadata VM cluster on Exascale Infrastructure. For details, see [Exadata Infrastructure Time Zones](/Content/Database/References/timezones.htm). ,
Required: False ,
}
string ,
totalEcpuCount:
{
Description: The number of Total ECPUs for an Exadata VM cluster on Exascale Infrastructure. ,
Format: int32 ,
Required: True ,
}
integer ,
vmFileSystemStorage:
{
Description: Filesystem storage details. ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
scanDnsName:
{
Description: The FQDN of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
scanIpIds:
{
Description: The Single Client Access Name (SCAN) IP addresses associated with the Exadata VM cluster on Exascale Infrastructure. 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. ,
Required: False ,
}
[
string ,
]
,
scanDnsRecordId:
{
Description: The OCID of the DNS record for the SCAN IP addresses that are associated with the Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
string ,
snapshotFileSystemStorage:
{
Description: Snapshot filesystem storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
totalFileSystemStorage:
{
Description: Total file system storage details. ,
Required: False ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
vipIds:
{
Description: The virtual IP (VIP) addresses associated with the Exadata VM cluster on Exascale Infrastructure. The Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster. **Note:** For a single-node DB system, this list is empty. ,
Required: False ,
}
[
string ,
]
,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
iormConfigCache:
{
Description: iormConfigCache details for Exadata VM cluster on Exascale Infrastructure. ,
Required: False ,
}
{
dbPlans:
{
Description: An array of IORM settings for all the database in the Exadata DB system. ,
Required: False ,
}
[
{
dbName:
{
Description: The database name. For the default DbPlan, the dbName is default. ,
Required: False ,
}
string ,
flashCacheLimit:
{
Description: The flash cache limit for this database. This value is internally configured based on the share value assigned to the database. ,
Required: False ,
}
string ,
share:
{
Description: The relative priority of this database. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
lifecycleDetails:
{
Description: Additional information about the current lifecycleState. ,
Required: False ,
}
string ,
lifecycleState:
{
Description: The current state of IORM configuration for the Exadata DB system. ,
Enum:
{
BootStrapping: Indicates that resource in Provisioning state ,
Enabled: Indicates that resource in Enabled state ,
Disabled: Indicates that resource in Disabled state ,
Updating: Indicates that resource in Updating state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
objective:
{
Description: The current value for the IORM objective. The default is AUTO. ,
Enum:
{
LowLatency: Low latency objective ,
HighThroughput: High throughput objective ,
Balanced: Balanced objective ,
Auto: Auto objective ,
Basic: Basic objective ,
}
,
Required: False ,
}
enum ,
}
,
backupSubnetOcid:
{
Description: Cluster backup subnet ocid ,
Required: False ,
}
string ,
subnetOcid:
{
Description: Cluster subnet ocid ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_ListByResourceGroup (new)
Description :  List ExascaleDbStorageVault resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exascaleDbStorageVaults
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExascaleDbStorageVault items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_Get (new)
Description :  Get a ExascaleDbStorageVault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exascaleDbStorageVaults/{exascaleDbStorageVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exascaleDbStorageVaultName:
{
Description: The name of the ExascaleDbStorageVault ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_Create (new)
Description :  Create a ExascaleDbStorageVault
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exascaleDbStorageVaults/{exascaleDbStorageVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exascaleDbStorageVaultName:
{
Description: The name of the ExascaleDbStorageVault ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: ExascaleDbStorageVault resource definition ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_Update (new)
Description :  Update a ExascaleDbStorageVault
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exascaleDbStorageVaults/{exascaleDbStorageVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exascaleDbStorageVaultName:
{
Description: The name of the ExascaleDbStorageVault ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
additionalFlashCacheInPercent:
{
Description: The size of additional Flash Cache in percentage of High Capacity database storage. ,
Format: int32 ,
Required: False ,
}
integer ,
description:
{
Description: Exadata Database Storage Vault description. ,
Required: False ,
}
string ,
displayName:
{
Description: The user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique. ,
Required: True ,
}
string ,
highCapacityDatabaseStorageInput:
{
Description: Create exadata Database Storage Details ,
Required: True ,
}
{
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
highCapacityDatabaseStorage:
{
Description: Response exadata Database Storage Details ,
Required: False ,
}
{
availableSizeInGbs:
{
Description: Available Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
totalSizeInGbs:
{
Description: Total Capacity ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
timeZone:
{
Description: The time zone that you want to use for the Exadata Database Storage Vault ,
Required: False ,
}
string ,
provisioningState:
{
Description: Exadata Database Storage Vault provisioning state ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Indicates that resource in Provisioning state ,
}
,
Required: False ,
}
enum ,
lifecycleState:
{
Description: Exadata Database Storage Vault lifecycle state ,
Enum:
{
Provisioning: Indicates that resource in Provisioning state ,
Available: Indicates that resource in Available state ,
Updating: Indicates that resource in Updating state ,
Terminating: Indicates that resource in Terminating state ,
Terminated: Indicates that resource in Terminated state ,
Failed: Indicates that resource in Failed state ,
}
,
Required: False ,
}
enum ,
lifecycleDetails:
{
Description: Additional information about the current lifecycle state. ,
Required: False ,
}
string ,
vmClusterCount:
{
Description: The number of Exadata VM clusters used the Exadata Database Storage Vault. ,
Format: int32 ,
Required: False ,
}
integer ,
ocid:
{
Description: The OCID of the Exadata Database Storage Vault. ,
Required: False ,
}
string ,
ociUrl:
{
Description: HTTPS link to OCI resources exposed to Azure Customer via Azure Interface. ,
Format: uri ,
Required: False ,
}
string ,
}
,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExascaleDbStorageVaults_Delete (new)
Description :  Delete a ExascaleDbStorageVault
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/exascaleDbStorageVaults/{exascaleDbStorageVaultName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
exascaleDbStorageVaultName:
{
Description: The name of the ExascaleDbStorageVault ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}