exascale_db_nodes

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

Overview

Name	exascale_db_nodes
Type	Resource
Id	azure_isv.oracledatabase.exascale_db_nodes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	string	Additional information about the planned maintenance.
cpuCoreCount	integer	The number of CPU cores enabled on the Db node.
dbNodeStorageSizeInGbs	integer	The allocated local node storage in GBs on the Db node.
faultDomain	string	The name of the Fault Domain the instance is contained in.
hostname	string	The host name for the database node.
lifecycleState	string	The current state of the database node. Known values are: "Provisioning", "Available", "Updating", "Stopping", "Stopped", "Starting", "Terminating", "Terminated", and "Failed". (Provisioning, Available, Updating, Stopping, Stopped, Starting, Terminating, Terminated, Failed)
maintenanceType	string	The type of database node maintenance.
memorySizeInGbs	integer	The allocated memory in GBs on the Db node.
ocid	string	DbNode OCID. Required.
softwareStorageSizeInGb	integer	The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeMaintenanceWindowEnd	string (date-time)	End date and time of maintenance window.
timeMaintenanceWindowStart	string (date-time)	Start date and time of maintenance window.
totalCpuCoreCount	integer	The total number of CPU cores reserved on the Db node.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_parent

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalDetails	string	Additional information about the planned maintenance.
cpuCoreCount	integer	The number of CPU cores enabled on the Db node.
dbNodeStorageSizeInGbs	integer	The allocated local node storage in GBs on the Db node.
faultDomain	string	The name of the Fault Domain the instance is contained in.
hostname	string	The host name for the database node.
lifecycleState	string	The current state of the database node. Known values are: "Provisioning", "Available", "Updating", "Stopping", "Stopped", "Starting", "Terminating", "Terminated", and "Failed". (Provisioning, Available, Updating, Stopping, Stopped, Starting, Terminating, Terminated, Failed)
maintenanceType	string	The type of database node maintenance.
memorySizeInGbs	integer	The allocated memory in GBs on the Db node.
ocid	string	DbNode OCID. Required.
softwareStorageSizeInGb	integer	The size (in GB) of the block storage volume allocation for the DB system. This attribute applies only for virtual machine DB systems.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeMaintenanceWindowEnd	string (date-time)	End date and time of maintenance window.
timeMaintenanceWindowStart	string (date-time)	Start date and time of maintenance window.
totalCpuCoreCount	integer	The total number of CPU cores reserved on the Db node.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, exadb_vm_cluster_name, exascale_db_node_name, subscription_id		Get a ExascaleDbNode.
list_by_parent	select	resource_group_name, exadb_vm_cluster_name, subscription_id		List ExascaleDbNode resources by ExadbVmCluster.
action	exec	resource_group_name, exadb_vm_cluster_name, exascale_db_node_name, subscription_id, action		VM actions on DbNode of ExadbVmCluster by the provided filter.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
exadb_vm_cluster_name	string	The name of the ExadbVmCluster. Required.
exascale_db_node_name	string	The name of the ExascaleDbNode. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a ExascaleDbNode.

SELECT
id,
name,
additionalDetails,
cpuCoreCount,
dbNodeStorageSizeInGbs,
faultDomain,
hostname,
lifecycleState,
maintenanceType,
memorySizeInGbs,
ocid,
softwareStorageSizeInGb,
systemData,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
totalCpuCoreCount,
type
FROM azure_isv.oracledatabase.exascale_db_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' -- required
AND exascale_db_node_name = '{{ exascale_db_node_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List ExascaleDbNode resources by ExadbVmCluster.

SELECT
id,
name,
additionalDetails,
cpuCoreCount,
dbNodeStorageSizeInGbs,
faultDomain,
hostname,
lifecycleState,
maintenanceType,
memorySizeInGbs,
ocid,
softwareStorageSizeInGb,
systemData,
timeMaintenanceWindowEnd,
timeMaintenanceWindowStart,
totalCpuCoreCount,
type
FROM azure_isv.oracledatabase.exascale_db_nodes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND exadb_vm_cluster_name = '{{ exadb_vm_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

action

VM actions on DbNode of ExadbVmCluster by the provided filter.

EXEC azure_isv.oracledatabase.exascale_db_nodes.action 
@resource_group_name='{{ resource_group_name }}' --required, 
@exadb_vm_cluster_name='{{ exadb_vm_cluster_name }}' --required, 
@exascale_db_node_name='{{ exascale_db_node_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"action": "{{ action }}"
}'
;