Flex Components - List By Parent

Service:

Oracle Database

API Version:

2025-03-01

List FlexComponent resources by SubscriptionLocationResource

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/flexComponents?api-version=2025-03-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Oracle.Database/locations/{location}/flexComponents?api-version=2025-03-01&shape={shape}

URI Parameters

Name	In	Required	Type	Description
location	path	True	string minLength: 1	The name of the Azure region.
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.
shape	query		SystemShapes	If provided, filters the results for the given shape

Responses

Name	Type	Description
200 OK	FlexComponentListResult	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

FlexComponents_ListByParent_MaximumSet

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Oracle.Database/locations/eastus/flexComponents?api-version=2025-03-01&shape=Exadata.X11M

Java

import com.azure.resourcemanager.oracledatabase.models.SystemShapes;

/**
 * Samples for FlexComponents ListByParent.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-01/FlexComponents_ListByParent_MaximumSet_Gen.json
     */
    /**
     * Sample code: FlexComponents_ListByParent_MaximumSet.
     * 
     * @param manager Entry point to OracleDatabaseManager.
     */
    public static void
        flexComponentsListByParentMaximumSet(com.azure.resourcemanager.oracledatabase.OracleDatabaseManager manager) {
        manager.flexComponents().listByParent("eastus", SystemShapes.EXADATA_X11M, 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 flex_components_list_by_parent_maximum_set_gen.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="SUBSCRIPTION_ID",
    )

    response = client.flex_components.list_by_parent(
        location="eastus",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-03-01/FlexComponents_ListByParent_MaximumSet_Gen.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/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/oracledatabase/armoracledatabase"
)

// Generated from example definition: 2025-03-01/FlexComponents_ListByParent_MaximumSet_Gen.json
func ExampleFlexComponentsClient_NewListByParentPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoracledatabase.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewFlexComponentsClient().NewListByParentPager("eastus", &armoracledatabase.FlexComponentsClientListByParentOptions{
		Shape: to.Ptr(armoracledatabase.SystemShapesExadataX11M)})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armoracledatabase.FlexComponentsClientListByParentResponse{
		// 	FlexComponentListResult: armoracledatabase.FlexComponentListResult{
		// 		Value: []*armoracledatabase.FlexComponent{
		// 			{
		// 				Properties: &armoracledatabase.FlexComponentProperties{
		// 					MinimumCoreCount: to.Ptr[int32](16),
		// 					AvailableCoreCount: to.Ptr[int32](11),
		// 					AvailableDbStorageInGbs: to.Ptr[int32](8),
		// 					RuntimeMinimumCoreCount: to.Ptr[int32](13),
		// 					Shape: to.Ptr("Exadata.X11M"),
		// 					AvailableMemoryInGbs: to.Ptr[int32](15),
		// 					AvailableLocalStorageInGbs: to.Ptr[int32](13),
		// 					ComputeModel: to.Ptr("ECPU"),
		// 					HardwareType: to.Ptr(armoracledatabase.HardwareTypeCOMPUTE),
		// 					DescriptionSummary: to.Ptr("The description summary for this Flex Component"),
		// 				},
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/flexComponents/name"),
		// 				Name: to.Ptr("fc"),
		// 				Type: to.Ptr("Oracle.Database/flexComponents"),
		// 				SystemData: &armoracledatabase.SystemData{
		// 					CreatedBy: to.Ptr("ilrpjodjmvzhybazxipoplnql"),
		// 					CreatedByType: to.Ptr(armoracledatabase.CreatedByTypeUser),
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-12-09T21:02:12.592Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("lhjbxchqkaia"),
		// 					LastModifiedByType: to.Ptr(armoracledatabase.CreatedByTypeUser),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-12-09T21:02:12.592Z"); return t}()),
		// 				},
		// 			},
		// 		},
		// 		NextLink: to.Ptr("https://microsoft.com/a"),
		// 	},
		// }
	}
}

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 list FlexComponent resources by SubscriptionLocationResource
 *
 * @summary list FlexComponent resources by SubscriptionLocationResource
 * x-ms-original-file: 2025-03-01/FlexComponents_ListByParent_MaximumSet_Gen.json
 */
async function flexComponentsListByParentMaximumSet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new OracleDatabaseManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.flexComponents.listByParent("eastus", {
    shape: "Exadata.X11M",
  })) {
    resArray.push(item);
  }

  console.log(resArray);
}

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.Resources;
using Azure.ResourceManager.OracleDatabase;

// Generated from example definition: 2025-03-01/FlexComponents_ListByParent_MaximumSet_Gen.json
// this example is just showing the usage of "FlexComponent_ListByParent" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// get the collection of this OracleFlexComponentResource
AzureLocation location = new AzureLocation("eastus");
OracleFlexComponentCollection collection = subscriptionResource.GetOracleFlexComponents(location);

// invoke the operation and iterate over the result
OracleDatabaseSystemShape? shape = OracleDatabaseSystemShape.ExadataX11M;
await foreach (OracleFlexComponentResource item in collection.GetAllAsync(shape: shape))
{
    // the variable item 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
    OracleFlexComponentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "properties": {
        "minimumCoreCount": 16,
        "availableCoreCount": 11,
        "availableDbStorageInGbs": 8,
        "runtimeMinimumCoreCount": 13,
        "shape": "Exadata.X11M",
        "availableMemoryInGbs": 15,
        "availableLocalStorageInGbs": 13,
        "computeModel": "ECPU",
        "hardwareType": "COMPUTE",
        "descriptionSummary": "The description summary for this Flex Component"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/flexComponents/name",
      "name": "fc",
      "type": "Oracle.Database/flexComponents",
      "systemData": {
        "createdBy": "ilrpjodjmvzhybazxipoplnql",
        "createdByType": "User",
        "createdAt": "2024-12-09T21:02:12.592Z",
        "lastModifiedBy": "lhjbxchqkaia",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2024-12-09T21:02:12.592Z"
      }
    }
  ],
  "nextLink": "https://microsoft.com/a"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
FlexComponent	FlexComponent Resource Definition
FlexComponentListResult	The response of a FlexComponent list operation.
HardwareType	Hardware Type enum
systemData	Metadata pertaining to creation and last modification of the resource.
SystemShapes	Allowed values for System Shapes

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

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.

FlexComponent

Object

FlexComponent Resource Definition

Name	Type	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties.availableCoreCount	integer (int32)	The maximum number of CPU cores that can be enabled on the DB Server for this Flex Component.
properties.availableDbStorageInGbs	integer (int32)	The maximum storage that can be enabled on the Storage Server for this Flex Component.
properties.availableLocalStorageInGbs	integer (int32)	The maximum local storage that can be enabled on the DB Server for this Flex Component.
properties.availableMemoryInGbs	integer (int32)	The maximum memory size that can be enabled on the DB Server for this Flex Component.
properties.computeModel	string	The compute model of the DB Server for this Flex Component.
properties.descriptionSummary	string minLength: 1 maxLength: 255	The description summary for this Flex Component.
properties.hardwareType	HardwareType	The hardware type of the DB (Compute) or Storage (Cell) Server for this Flex Component.
properties.minimumCoreCount	integer (int32)	The minimum number of CPU cores that can be enabled on the DB Server for this Flex Component.
properties.runtimeMinimumCoreCount	integer (int32)	The runtime minimum number of CPU cores that can be enabled for this Flex Component.
properties.shape	string minLength: 1 maxLength: 255	The name of the DB system shape for this Flex Component.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

FlexComponentListResult

Object

The response of a FlexComponent list operation.

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	FlexComponent[]	The FlexComponent items on this page

HardwareType

Enumeration

Hardware Type enum

Value	Description
COMPUTE	Hardware type is Database Server
CELL	Hardware type is Storage Server

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.

SystemShapes

Enumeration

Allowed values for System Shapes

Value	Description
Exadata.X9M	Exadata X9M shape
Exadata.X11M	Exadata X11M shape
ExaDbXS	Exadata DB on Exascale Infrastructure shape