Autonomous Databases - Generate Wallet

Service:

Oracle Database

API Version:

2025-03-01

Generate wallet action on Autonomous Database

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Oracle.Database/autonomousDatabases/{autonomousdatabasename}/generateWallet?api-version=2025-03-01

URI Parameters

Name	In	Required	Type	Description
autonomousdatabasename	path	True	string minLength: 1 maxLength: 30 pattern: .*	The database 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
password	True	string (password) minLength: 8	The password to encrypt the keys inside the wallet
generateType		GenerateType	The type of wallet to generate.
isRegional		boolean	True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only.

Responses

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

Generate wallet action on Autonomous Database

Sample request

HTTP

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

{
  "generateType": "Single",
  "isRegional": false,
  "password": "********"
}

Java

import com.azure.resourcemanager.oracledatabase.models.GenerateAutonomousDatabaseWalletDetails;
import com.azure.resourcemanager.oracledatabase.models.GenerateType;

/**
 * Samples for AutonomousDatabases GenerateWallet.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-03-01/autonomousDatabase_generateWallet.json
     */
    /**
     * Sample code: AutonomousDatabases_generateWallet.
     * 
     * @param manager Entry point to OracleDatabaseManager.
     */
    public static void
        autonomousDatabasesGenerateWallet(com.azure.resourcemanager.oracledatabase.OracleDatabaseManager manager) {
        manager.autonomousDatabases()
            .generateWalletWithResponse(
                "rg000", "databasedb1", new GenerateAutonomousDatabaseWalletDetails()
                    .withGenerateType(GenerateType.SINGLE).withIsRegional(false).withPassword("fakeTokenPlaceholder"),
                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 autonomous_database_generate_wallet.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.autonomous_databases.generate_wallet(
        resource_group_name="rg000",
        autonomousdatabasename="databasedb1",
        body={"generateType": "Single", "isRegional": False, "password": "********"},
    )
    print(response)


# x-ms-original-file: 2025-03-01/autonomousDatabase_generateWallet.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/autonomousDatabase_generateWallet.json
func ExampleAutonomousDatabasesClient_GenerateWallet() {
	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.NewAutonomousDatabasesClient().GenerateWallet(ctx, "rg000", "databasedb1", armoracledatabase.GenerateAutonomousDatabaseWalletDetails{
		GenerateType: to.Ptr(armoracledatabase.GenerateTypeSingle),
		IsRegional:   to.Ptr(false),
		Password:     to.Ptr("********"),
	}, 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.AutonomousDatabasesClientGenerateWalletResponse{
	// 	AutonomousDatabaseWalletFile: &armoracledatabase.AutonomousDatabaseWalletFile{
	// 		WalletFiles: to.Ptr("testEncodedFiles"),
	// 	},
	// }
}

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 generate wallet action on Autonomous Database
 *
 * @summary generate wallet action on Autonomous Database
 * x-ms-original-file: 2025-03-01/autonomousDatabase_generateWallet.json
 */
async function autonomousDatabasesGenerateWallet() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new OracleDatabaseManagementClient(credential, subscriptionId);
  const result = await client.autonomousDatabases.generateWallet("rg000", "databasedb1", {
    generateType: "Single",
    isRegional: false,
    password: "********",
  });
  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/autonomousDatabase_generateWallet.json
// this example is just showing the usage of "AutonomousDatabases_GenerateWallet" 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 AutonomousDatabaseResource created on azure
// for more information of creating AutonomousDatabaseResource, please refer to the document of AutonomousDatabaseResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg000";
string autonomousdatabasename = "databasedb1";
ResourceIdentifier autonomousDatabaseResourceId = AutonomousDatabaseResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, autonomousdatabasename);
AutonomousDatabaseResource autonomousDatabase = client.GetAutonomousDatabaseResource(autonomousDatabaseResourceId);

// invoke the operation
GenerateAutonomousDatabaseWalletDetails details = new GenerateAutonomousDatabaseWalletDetails("********")
{
    GenerateType = WalletGenerateType.Single,
    IsRegional = false,
};
AutonomousDatabaseWalletFile result = await autonomousDatabase.GenerateWalletAsync(details);

Console.WriteLine($"Succeeded: {result}");

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

{
  "walletFiles": "testEncodedFiles"
}

Definitions

Name	Description
AutonomousDatabaseWalletFile	Autonomous Database Wallet File resource model.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
GenerateAutonomousDatabaseWalletDetails	Autonomous Database Generate Wallet resource model.
GenerateType	Generate type enum

AutonomousDatabaseWalletFile

Object

Autonomous Database Wallet File resource model.

Name	Type	Description
walletFiles	string	The base64 encoded wallet files

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.

GenerateAutonomousDatabaseWalletDetails

Object

Autonomous Database Generate Wallet resource model.

Name	Type	Description
generateType	GenerateType	The type of wallet to generate.
isRegional	boolean	True when requesting regional connection strings in PDB connect info, applicable to cross-region DG only.
password	string (password) minLength: 8	The password to encrypt the keys inside the wallet

GenerateType

Enumeration

Generate type enum

Value	Description
All	Generate all
Single	Generate single