db_servers

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

Overview

Name	db_servers
Type	Resource
Id	azure_isv.oracledatabase.db_servers

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.
autonomousVirtualMachineIds	array	The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIds	array	The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartmentId	string	The OCID of the compartment.
computeModel	string	The compute model of the Exadata Infrastructure. Known values are: "ECPU" and "OCPU". (ECPU, OCPU)
cpuCoreCount	integer	The number of CPU cores enabled on the Db server.
dbNodeIds	array	The OCID of the Db nodes associated with the Db server.
dbNodeStorageSizeInGbs	integer	The allocated local node storage in GBs on the Db server.
dbServerPatchingDetails	object	dbServerPatching details of the Db server.
displayName	string	The name for the Db Server.
exadataInfrastructureId	string	The OCID of the Exadata infrastructure.
lifecycleDetails	string	Lifecycle details of dbServer.
lifecycleState	string	DbServer provisioning state. Known values are: "Creating", "Available", "Unavailable", "Deleting", "Deleted", and "MaintenanceInProgress". (Creating, Available, Unavailable, Deleting, Deleted, MaintenanceInProgress)
maxCpuCount	integer	The total number of CPU cores available.
maxDbNodeStorageInGbs	integer	The total max dbNode storage in GBs.
maxMemoryInGbs	integer	The total memory available in GBs.
memorySizeInGbs	integer	The total memory size in GBs.
ocid	string	Db server name.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
shape	string	The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The date and time that the Db Server was created.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmClusterIds	array	The OCID of the VM Clusters associated with the Db server.

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.
autonomousVirtualMachineIds	array	The list of OCIDs of the Autonomous Virtual Machines associated with the Db server.
autonomousVmClusterIds	array	The list of OCIDs of the Autonomous VM Clusters associated with the Db server.
compartmentId	string	The OCID of the compartment.
computeModel	string	The compute model of the Exadata Infrastructure. Known values are: "ECPU" and "OCPU". (ECPU, OCPU)
cpuCoreCount	integer	The number of CPU cores enabled on the Db server.
dbNodeIds	array	The OCID of the Db nodes associated with the Db server.
dbNodeStorageSizeInGbs	integer	The allocated local node storage in GBs on the Db server.
dbServerPatchingDetails	object	dbServerPatching details of the Db server.
displayName	string	The name for the Db Server.
exadataInfrastructureId	string	The OCID of the Exadata infrastructure.
lifecycleDetails	string	Lifecycle details of dbServer.
lifecycleState	string	DbServer provisioning state. Known values are: "Creating", "Available", "Unavailable", "Deleting", "Deleted", and "MaintenanceInProgress". (Creating, Available, Unavailable, Deleting, Deleted, MaintenanceInProgress)
maxCpuCount	integer	The total number of CPU cores available.
maxDbNodeStorageInGbs	integer	The total max dbNode storage in GBs.
maxMemoryInGbs	integer	The total memory available in GBs.
memorySizeInGbs	integer	The total memory size in GBs.
ocid	string	Db server name.
provisioningState	string	Azure resource provisioning state. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
shape	string	The shape of the Db server. The shape determines the amount of CPU, storage, and memory resources available.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The date and time that the Db Server was created.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vmClusterIds	array	The OCID of the VM Clusters associated with the Db server.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cloudexadatainfrastructurename, dbserverocid, subscription_id		Get a DbServer.
list_by_parent	select	resource_group_name, cloudexadatainfrastructurename, subscription_id		List DbServer resources by CloudExadataInfrastructure.

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
cloudexadatainfrastructurename	string	CloudExadataInfrastructure name. Required.
dbserverocid	string	DbServer OCID. 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 DbServer.

SELECT
id,
name,
autonomousVirtualMachineIds,
autonomousVmClusterIds,
compartmentId,
computeModel,
cpuCoreCount,
dbNodeIds,
dbNodeStorageSizeInGbs,
dbServerPatchingDetails,
displayName,
exadataInfrastructureId,
lifecycleDetails,
lifecycleState,
maxCpuCount,
maxDbNodeStorageInGbs,
maxMemoryInGbs,
memorySizeInGbs,
ocid,
provisioningState,
shape,
systemData,
timeCreated,
type,
vmClusterIds
FROM azure_isv.oracledatabase.db_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudexadatainfrastructurename = '{{ cloudexadatainfrastructurename }}' -- required
AND dbserverocid = '{{ dbserverocid }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_parent

List DbServer resources by CloudExadataInfrastructure.

SELECT
id,
name,
autonomousVirtualMachineIds,
autonomousVmClusterIds,
compartmentId,
computeModel,
cpuCoreCount,
dbNodeIds,
dbNodeStorageSizeInGbs,
dbServerPatchingDetails,
displayName,
exadataInfrastructureId,
lifecycleDetails,
lifecycleState,
maxCpuCount,
maxDbNodeStorageInGbs,
maxMemoryInGbs,
memorySizeInGbs,
ocid,
provisioningState,
shape,
systemData,
timeCreated,
type,
vmClusterIds
FROM azure_isv.oracledatabase.db_servers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cloudexadatainfrastructurename = '{{ cloudexadatainfrastructurename }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;