Cloud Vm Clusters - List Private Ip Addresses

Service:

Oracle Database

API Version:

2025-03-01

List Private IP Addresses by the provided filter

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/cloudVmClusters/{cloudvmclustername}/listPrivateIpAddresses?api-version=2025-03-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.

Request Body

Name	Required	Type	Description
subnetId	True	string minLength: 1 maxLength: 255	Subnet OCID
vnicId	True	string minLength: 1 maxLength: 255	VCN OCID

Responses

Name	Type	Description
200 OK	PrivateIpAddressProperties[]	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

List Private IP Addresses for VM Cluster

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg000/providers/Oracle.Database/cloudVmClusters/cluster1/listPrivateIpAddresses?api-version=2025-03-01

{
  "subnetId": "ocid1..aaaaaa",
  "vnicId": "ocid1..aaaaa"
}

Java

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

/**
 * Samples for CloudVmClusters ListPrivateIpAddresses.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-01/vmClusters_listPrivateIpAddresses.json
     */
    /**
     * Sample code: CloudVmClusters_listPrivateIpAddresses.
     * 
     * @param manager Entry point to OracleDatabaseManager.
     */
    public static void
        cloudVmClustersListPrivateIpAddresses(com.azure.resourcemanager.oracledatabase.OracleDatabaseManager manager) {
        manager.cloudVmClusters().listPrivateIpAddressesWithResponse("rg000", "cluster1",
            new PrivateIpAddressesFilter().withSubnetId("ocid1..aaaaaa").withVnicId("ocid1..aaaaa"),
            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_list_private_ip_addresses.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.cloud_vm_clusters.list_private_ip_addresses(
        resource_group_name="rg000",
        cloudvmclustername="cluster1",
        body={"subnetId": "ocid1..aaaaaa", "vnicId": "ocid1..aaaaa"},
    )
    print(response)


# x-ms-original-file: 2025-03-01/vmClusters_listPrivateIpAddresses.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/vmClusters_listPrivateIpAddresses.json
func ExampleCloudVMClustersClient_ListPrivateIPAddresses() {
	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)
	}
	res, err := clientFactory.NewCloudVMClustersClient().ListPrivateIPAddresses(ctx, "rg000", "cluster1", armoracledatabase.PrivateIPAddressesFilter{
		SubnetID: to.Ptr("ocid1..aaaaaa"),
		VnicID:   to.Ptr("ocid1..aaaaa"),
	}, 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 = armoracledatabase.CloudVMClustersClientListPrivateIPAddressesResponse{
	// 	undefined: &[]*armoracledatabase.PrivateIPAddressProperties{
	// 		{
	// 			DisplayName: to.Ptr("ip1"),
	// 			HostnameLabel: to.Ptr("hostname1"),
	// 			Ocid: to.Ptr("ocid1..aaaa"),
	// 			IPAddress: to.Ptr("192.168.0.1"),
	// 			SubnetID: 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 list Private IP Addresses by the provided filter
 *
 * @summary list Private IP Addresses by the provided filter
 * x-ms-original-file: 2025-03-01/vmClusters_listPrivateIpAddresses.json
 */
async function cloudVmClustersListPrivateIpAddresses() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new OracleDatabaseManagementClient(credential, subscriptionId);
  const result = await client.cloudVmClusters.listPrivateIpAddresses("rg000", "cluster1", {
    subnetId: "ocid1..aaaaaa",
    vnicId: "ocid1..aaaaa",
  });
  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: 2025-03-01/vmClusters_listPrivateIpAddresses.json
// this example is just showing the usage of "CloudVmClusters_ListPrivateIPAddresses" 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 and iterate over the result
PrivateIPAddressesContent content = new PrivateIPAddressesContent("ocid1..aaaaaa", "ocid1..aaaaa");
await foreach (PrivateIPAddressResult item in cloudVmCluster.GetPrivateIPAddressesAsync(content))
{
    Console.WriteLine($"Succeeded: {item}");
}

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

[
  {
    "displayName": "ip1",
    "hostnameLabel": "hostname1",
    "ocid": "ocid1..aaaa",
    "ipAddress": "192.168.0.1",
    "subnetId": "ocid1..aaaa"
  }
]

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
PrivateIpAddressesFilter	Private Ip Addresses filter
PrivateIpAddressProperties	PrivateIpAddress resource properties

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.

PrivateIpAddressesFilter

Object

Private Ip Addresses filter

Name	Type	Description
subnetId	string minLength: 1 maxLength: 255	Subnet OCID
vnicId	string minLength: 1 maxLength: 255	VCN OCID

PrivateIpAddressProperties

Object

PrivateIpAddress resource properties

Name	Type	Description
displayName	string	PrivateIpAddresses displayName
hostnameLabel	string	PrivateIpAddresses hostnameLabel
ipAddress	string	PrivateIpAddresses ipAddress
ocid	string minLength: 1 maxLength: 255	PrivateIpAddresses Id
subnetId	string minLength: 1 maxLength: 255	PrivateIpAddresses subnetId