Cloud Vm Clusters - Get

Service:

Oracle Database

API Version:

2023-09-01

Get a CloudVmCluster

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
cloudvmclustername	path	True	string pattern: .*	CloudVmCluster name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CloudVmCluster	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Get VM Cluster

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1?api-version=2023-09-01

Java

/**
 * Samples for CloudVmClusters GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json
     */
    /**
     * Sample code: Get VM Cluster.
     * 
     * @param manager Entry point to OracleDatabaseManager.
     */
    public static void getVMCluster(com.azure.resourcemanager.oracledatabase.OracleDatabaseManager manager) {
        manager.cloudVmClusters().getByResourceGroupWithResponse("rg000", "cluster1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.oracledatabase import OracleDatabaseMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-oracledatabase
# USAGE
    python vm_clusters_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = OracleDatabaseMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.cloud_vm_clusters.get(
        resource_group_name="rg000",
        cloudvmclustername="cluster1",
    )
    print(response)


# x-ms-original-file: specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armoracledatabase_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/oracledatabase/armoracledatabase"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/1c63635d66ae38cff18045ab416a6572d3e15f6e/specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json
func ExampleCloudVMClustersClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoracledatabase.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewCloudVMClustersClient().Get(ctx, "rg000", "cluster1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CloudVMCluster = armoracledatabase.CloudVMCluster{
	// 	Type: to.Ptr("Oracle.Database/cloudVmClusters"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1"),
	// 	Location: to.Ptr("eastus"),
	// 	Tags: map[string]*string{
	// 		"tagK1": to.Ptr("tagV1"),
	// 	},
	// 	Properties: &armoracledatabase.CloudVMClusterProperties{
	// 		BackupSubnetCidr: to.Ptr("172.17.5.0/24"),
	// 		CloudExadataInfrastructureID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1"),
	// 		ClusterName: to.Ptr("cluster1"),
	// 		CompartmentID: to.Ptr("ocid1..aaaaaa"),
	// 		CPUCoreCount: to.Ptr[int32](10),
	// 		DataCollectionOptions: &armoracledatabase.DataCollectionOptions{
	// 			IsDiagnosticsEventsEnabled: to.Ptr(false),
	// 			IsHealthMonitoringEnabled: to.Ptr(false),
	// 			IsIncidentLogsEnabled: to.Ptr(false),
	// 		},
	// 		DataStoragePercentage: to.Ptr[int32](80),
	// 		DataStorageSizeInTbs: to.Ptr[float64](10),
	// 		DbNodeStorageSizeInGbs: to.Ptr[int32](100),
	// 		DbServers: []*string{
	// 			to.Ptr("ocid1..aaaa")},
	// 			DiskRedundancy: to.Ptr(armoracledatabase.DiskRedundancyHigh),
	// 			DisplayName: to.Ptr("cluster 1"),
	// 			Domain: to.Ptr("domain1"),
	// 			GiVersion: to.Ptr("19.0.0.0"),
	// 			Hostname: to.Ptr("hostname1"),
	// 			IormConfigCache: &armoracledatabase.ExadataIormConfig{
	// 				DbPlans: []*armoracledatabase.DbIormConfig{
	// 					{
	// 						DbName: to.Ptr("db1"),
	// 						FlashCacheLimit: to.Ptr("none"),
	// 						Share: to.Ptr[int32](32),
	// 				}},
	// 				LifecycleDetails: to.Ptr("Disabled"),
	// 				LifecycleState: to.Ptr(armoracledatabase.IormLifecycleStateDisabled),
	// 				Objective: to.Ptr(armoracledatabase.ObjectiveLowLatency),
	// 			},
	// 			IsLocalBackupEnabled: to.Ptr(false),
	// 			IsSparseDiskgroupEnabled: to.Ptr(false),
	// 			LastUpdateHistoryEntryID: to.Ptr("none"),
	// 			LicenseModel: to.Ptr(armoracledatabase.LicenseModelLicenseIncluded),
	// 			LifecycleDetails: to.Ptr("success"),
	// 			ListenerPort: to.Ptr[int64](1050),
	// 			MemorySizeInGbs: to.Ptr[int32](1000),
	// 			NodeCount: to.Ptr[int32](100),
	// 			NsgCidrs: []*armoracledatabase.NsgCidr{
	// 				{
	// 					DestinationPortRange: &armoracledatabase.PortRange{
	// 						Max: to.Ptr[int32](1522),
	// 						Min: to.Ptr[int32](1520),
	// 					},
	// 					Source: to.Ptr("10.0.0.0/16"),
	// 				},
	// 				{
	// 					Source: to.Ptr("10.10.0.0/24"),
	// 			}},
	// 			NsgURL: to.Ptr("https://fake"),
	// 			OciURL: to.Ptr("https://fake"),
	// 			Ocid: to.Ptr("ocid1..aaaa"),
	// 			OcpuCount: to.Ptr[float32](100),
	// 			ProvisioningState: to.Ptr(armoracledatabase.AzureResourceProvisioningStateSucceeded),
	// 			ScanDNSName: to.Ptr("dbdns1"),
	// 			ScanDNSRecordID: to.Ptr("scandns1"),
	// 			ScanIPIDs: []*string{
	// 				to.Ptr("10.0.0.1")},
	// 				ScanListenerPortTCP: to.Ptr[int32](1050),
	// 				ScanListenerPortTCPSSL: to.Ptr[int32](1025),
	// 				Shape: to.Ptr("EXADATA.X9M"),
	// 				SSHPublicKeys: []*string{
	// 					to.Ptr("ssh-key 1")},
	// 					StorageSizeInGbs: to.Ptr[int32](1000),
	// 					SubnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1"),
	// 					SubnetOcid: to.Ptr("ocid1..aaaaaa"),
	// 					SystemVersion: to.Ptr("v1"),
	// 					TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-22T02:18:35.683Z"); return t}()),
	// 					TimeZone: to.Ptr("UTC"),
	// 					VipIDs: []*string{
	// 						to.Ptr("10.0.1.3")},
	// 						VnetID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1"),
	// 						ZoneID: to.Ptr("ocid1..aaaa"),
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { OracleDatabaseManagementClient } = require("@azure/arm-oracledatabase");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get a CloudVmCluster
 *
 * @summary Get a CloudVmCluster
 * x-ms-original-file: specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json
 */
async function getVMCluster() {
  const subscriptionId =
    process.env["ORACLEDATABASE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["ORACLEDATABASE_RESOURCE_GROUP"] || "rg000";
  const cloudvmclustername = "cluster1";
  const credential = new DefaultAzureCredential();
  const client = new OracleDatabaseManagementClient(credential, subscriptionId);
  const result = await client.cloudVmClusters.get(resourceGroupName, cloudvmclustername);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.OracleDatabase.Models;
using Azure.ResourceManager.OracleDatabase;

// Generated from example definition: specification/oracle/resource-manager/Oracle.Database/stable/2023-09-01/examples/vmClusters_get.json
// this example is just showing the usage of "CloudVmClusters_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CloudVmClusterResource created on azure
// for more information of creating CloudVmClusterResource, please refer to the document of CloudVmClusterResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg000";
string cloudvmclustername = "cluster1";
ResourceIdentifier cloudVmClusterResourceId = CloudVmClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, cloudvmclustername);
CloudVmClusterResource cloudVmCluster = client.GetCloudVmClusterResource(cloudVmClusterResourceId);

// invoke the operation
CloudVmClusterResource result = await cloudVmCluster.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
CloudVmClusterData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1",
  "type": "Oracle.Database/cloudVmClusters",
  "location": "eastus",
  "tags": {
    "tagK1": "tagV1"
  },
  "properties": {
    "ocid": "ocid1..aaaa",
    "listenerPort": 1050,
    "nodeCount": 100,
    "storageSizeInGbs": 1000,
    "dataStorageSizeInTbs": 10,
    "dbNodeStorageSizeInGbs": 100,
    "memorySizeInGbs": 1000,
    "timeCreated": "2023-10-22T02:18:35.683Z",
    "lifecycleDetails": "success",
    "timeZone": "UTC",
    "zoneId": "ocid1..aaaa",
    "hostname": "hostname1",
    "domain": "domain1",
    "cpuCoreCount": 10,
    "ocpuCount": 100,
    "clusterName": "cluster1",
    "dataStoragePercentage": 80,
    "isLocalBackupEnabled": false,
    "cloudExadataInfrastructureId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudExadataInfrastructures/infra1",
    "isSparseDiskgroupEnabled": false,
    "sshPublicKeys": [
      "ssh-key 1"
    ],
    "nsgCidrs": [
      {
        "source": "10.0.0.0/16",
        "destinationPortRange": {
          "min": 1520,
          "max": 1522
        }
      },
      {
        "source": "10.10.0.0/24"
      }
    ],
    "licenseModel": "LicenseIncluded",
    "scanListenerPortTcp": 1050,
    "scanListenerPortTcpSsl": 1025,
    "vnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1",
    "giVersion": "19.0.0.0",
    "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1",
    "backupSubnetCidr": "172.17.5.0/24",
    "systemVersion": "v1",
    "diskRedundancy": "High",
    "scanIpIds": [
      "10.0.0.1"
    ],
    "vipIds": [
      "10.0.1.3"
    ],
    "scanDnsName": "dbdns1",
    "scanDnsRecordId": "scandns1",
    "shape": "EXADATA.X9M",
    "provisioningState": "Succeeded",
    "ociUrl": "https://fake",
    "nsgUrl": "https://fake",
    "dataCollectionOptions": {
      "isDiagnosticsEventsEnabled": false,
      "isHealthMonitoringEnabled": false,
      "isIncidentLogsEnabled": false
    },
    "displayName": "cluster 1",
    "iormConfigCache": {
      "dbPlans": [
        {
          "dbName": "db1",
          "flashCacheLimit": "none",
          "share": 32
        }
      ],
      "lifecycleDetails": "Disabled",
      "lifecycleState": "Disabled",
      "objective": "LowLatency"
    },
    "lastUpdateHistoryEntryId": "none",
    "dbServers": [
      "ocid1..aaaa"
    ],
    "compartmentId": "ocid1..aaaaaa",
    "subnetOcid": "ocid1..aaaaaa"
  }
}

Definitions

Name	Description
AzureResourceProvisioningState	Azure Resource Provisioning State enum
CloudVmCluster	CloudVmCluster resource definition
CloudVmClusterLifecycleState	Cloud VM Cluster lifecycle state enum
createdByType	The type of identity that created the resource.
DataCollectionOptions	DataCollectionOptions resource properties
DbIormConfig	DbIormConfig for cloud vm cluster
DiskRedundancy	Disk redundancy enum
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExadataIormConfig	ExadataIormConfig for cloud vm cluster
IormLifecycleState	ORM lifecycle state enum
LicenseModel	LicenseModel enum
NsgCidr	A rule for allowing inbound (INGRESS) IP packets
Objective	Objective enum
PortRange	Port Range to specify particular destination ports for TCP rules.
systemData	Metadata pertaining to creation and last modification of the resource.

AzureResourceProvisioningState

Enumeration

Azure Resource Provisioning State enum

Value	Description
Canceled	Resource creation was canceled.
Failed	Resource creation failed.
Provisioning	Indicates that resource in Provisioning state
Succeeded	Resource has been created.

CloudVmCluster

Object

CloudVmCluster resource definition

Name	Type	Default value	Description
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.backupSubnetCidr	string minLength: 1 maxLength: 32		Client OCI backup subnet CIDR, default is 192.168.252.0/22
properties.cloudExadataInfrastructureId	string (arm-id)		Cloud Exadata Infrastructure ID
properties.clusterName	string minLength: 1 maxLength: 11		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.
properties.compartmentId	string minLength: 1 maxLength: 255		Cluster compartmentId
properties.computeNodes	string[] minLength: 1 maxLength: 255		The list of compute servers to be added to the cloud VM cluster.
properties.cpuCoreCount	integer (int32)		The number of CPU cores enabled on the cloud VM cluster.
properties.dataCollectionOptions	DataCollectionOptions		Indicates user preferences for the various diagnostic collection options for the VM cluster/Cloud VM cluster/VMBM DBCS.
properties.dataStoragePercentage	integer (int32)		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 in the Exadata documentation for details on the impact of the configuration settings on storage.
properties.dataStorageSizeInTbs	number (double)		The data disk group size to be allocated in TBs.
properties.dbNodeStorageSizeInGbs	integer (int32)		The local node storage to be allocated in GBs.
properties.dbServers	string[] minLength: 1 maxLength: 255		The list of DB servers.
properties.diskRedundancy	DiskRedundancy		The type of redundancy configured for the cloud Vm cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
properties.displayName	string minLength: 1 maxLength: 255		Display Name
properties.domain	string		The domain name for the cloud VM cluster.
properties.giVersion	string		Oracle Grid Infrastructure (GI) software version
properties.hostname	string minLength: 1 maxLength: 23		The hostname for the cloud VM cluster.
properties.iormConfigCache	ExadataIormConfig		iormConfigCache details for cloud VM cluster.
properties.isLocalBackupEnabled	boolean	False	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.
properties.isSparseDiskgroupEnabled	boolean	False	If true, sparse disk group is configured for the cloud VM cluster. If false, sparse disk group is not created.
properties.lastUpdateHistoryEntryId	string minLength: 1 maxLength: 255		The OCID of the last maintenance update history entry.
properties.licenseModel	LicenseModel		The Oracle license model that applies to the cloud VM cluster. The default is LICENSE_INCLUDED.
properties.lifecycleDetails	string		Additional information about the current lifecycle state.
properties.lifecycleState	CloudVmClusterLifecycleState		CloudVmCluster lifecycle state
properties.listenerPort	integer (int64)		The port number configured for the listener on the cloud VM cluster.
properties.memorySizeInGbs	integer (int32)		The memory to be allocated in GBs.
properties.nodeCount	integer (int32)		The number of nodes in the cloud VM cluster.
properties.nsgCidrs	NsgCidr[]		CIDR blocks for additional NSG ingress rules. The VNET CIDRs used to provision the VM Cluster will be added by default.
properties.nsgUrl	string (uri)		HTTPS link to OCI Network Security Group exposed to Azure Customer via the Azure Interface.
properties.ociUrl	string (uri)		HTTPS link to OCI resources exposed to Azure Customer via Azure Interface.
properties.ocid	string minLength: 1 maxLength: 255		Cloud VM Cluster ocid
properties.ocpuCount	number (float)		The number of OCPU cores to enable on the cloud VM cluster. Only 1 decimal place is allowed for the fractional part.
properties.provisioningState	AzureResourceProvisioningState		CloudVmCluster provisioning state
properties.scanDnsName	string minLength: 1 maxLength: 72		The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
properties.scanDnsRecordId	string minLength: 1 maxLength: 255		The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
properties.scanIpIds	string[]		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.
properties.scanListenerPortTcp	integer (int32)		The TCP Single Client Access Name (SCAN) port. The default port is 1521.
properties.scanListenerPortTcpSsl	integer (int32)		The TCPS Single Client Access Name (SCAN) port. The default port is 2484.
properties.shape	string minLength: 1 maxLength: 255		The model name of the Exadata hardware running the cloud VM cluster.
properties.sshPublicKeys	string[]		The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.
properties.storageSizeInGbs	integer (int32)		The data disk group size to be allocated in GBs per VM.
properties.subnetId	string (arm-id)		Client subnet
properties.subnetOcid	string minLength: 1 maxLength: 255		Cluster subnet ocid
properties.systemVersion	string minLength: 1 maxLength: 255		Operating system version of the image.
properties.timeCreated	string (date-time)		The date and time that the cloud VM cluster was created.
properties.timeZone	string minLength: 1 maxLength: 255		The time zone of the cloud VM cluster. For details, see Exadata Infrastructure Time Zones.
properties.vipIds	string[]		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.
properties.vnetId	string (arm-id)		VNET for network connectivity
properties.zoneId	string minLength: 1 maxLength: 255		The OCID of the zone the cloud VM cluster is associated with.
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CloudVmClusterLifecycleState

Enumeration

Cloud VM Cluster lifecycle state enum

Value	Description
Available	Indicates that resource in Available state
Failed	Indicates that resource in Failed state
MaintenanceInProgress	Indicates that resource Maintenance in progress state
Provisioning	Indicates that resource in Provisioning state
Terminated	Indicates that resource in Terminated state
Terminating	Indicates that resource in Terminating state
Updating	Indicates that resource in Updating state

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

DataCollectionOptions

Object

DataCollectionOptions resource properties

Name	Type	Default value	Description
isDiagnosticsEventsEnabled	boolean	False	Indicates whether diagnostic collection is enabled for the VM cluster/Cloud VM cluster/VMBM DBCS.
isHealthMonitoringEnabled	boolean	False	Indicates whether health monitoring is enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.
isIncidentLogsEnabled	boolean	False	Indicates whether incident logs and trace collection are enabled for the VM cluster / Cloud VM cluster / VMBM DBCS.

DbIormConfig

Object

DbIormConfig for cloud vm cluster

Name	Type	Description
dbName	string	The database name. For the default DbPlan, the dbName is default.
flashCacheLimit	string	The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share	integer (int32) minimum: 1 maximum: 32	The relative priority of this database.

DiskRedundancy

Enumeration

Disk redundancy enum

Value	Description
High	High redundancy
Normal	Normal redundancy

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExadataIormConfig

Object

ExadataIormConfig for cloud vm cluster

Name	Type	Description
dbPlans	DbIormConfig[]	An array of IORM settings for all the database in the Exadata DB system.
lifecycleDetails	string	Additional information about the current lifecycleState.
lifecycleState	IormLifecycleState	The current state of IORM configuration for the Exadata DB system.
objective	Objective	The current value for the IORM objective. The default is AUTO.

IormLifecycleState

Enumeration

ORM lifecycle state enum

Value	Description
BootStrapping	Indicates that resource in Provisioning state
Disabled	Indicates that resource in Disabled state
Enabled	Indicates that resource in Enabled state
Failed	Indicates that resource in Failed state
Updating	Indicates that resource in Updating state

LicenseModel

Enumeration

LicenseModel enum

Value	Description
BringYourOwnLicense	Bring Your Own License
LicenseIncluded	License included

NsgCidr

Object

A rule for allowing inbound (INGRESS) IP packets

Name	Type	Description
destinationPortRange	PortRange	Destination port range to specify particular destination ports for TCP rules.
source	string minLength: 1 maxLength: 128	Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.

Objective

Enumeration

Objective enum

Value	Description
Auto	Auto objective
Balanced	Balanced objective
Basic	Basic objective
HighThroughput	High throughput objective
LowLatency	Low latency objective

PortRange

Object

Port Range to specify particular destination ports for TCP rules.

Name	Type	Description
max	integer (int32) minimum: 1 maximum: 65535	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.
min	integer (int32) minimum: 1 maximum: 65535	The minimum port number, which must not be greater than the maximum port number.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.