Configuring and Connecting to Oracle Cloud with Oracle Developer Tools for VS Code

This page shows you how to create an Oracle Cloud account, set up the Oracle Cloud Infrastructure config file, connect to Oracle Cloud Infrastructure, and view your Oracle Autonomous Database resources in Visual Studio Code.

    Open all Close all

  • 1. Create an Oracle Cloud Account

    Sign up for Oracle Cloud Free Tier if you don't already have an Oracle Cloud account.

  • 2. Set up the Oracle Cloud Infrastructure Config File

    • The following steps help you quickly generate an API key pair and a config file. For more complete instructions including how to generate an encrypted key file, please read the OCI Developer Guide
    • Open a web browser and log into your Oracle Cloud account. The cloud console will open.
    • In the upper right hand corner of the cloud console, click on the profile icon and then click on the link containing your username.
    • On the left side of the screen, under Resources, click API Keys.
    • A maximum of three API keys are allowed. If you already have three API Keys listed, delete one that you are no longer using by clicking the three dots next to the key and choosing Delete.
    • Click the Add API Key button
    • Select the Generate API Key Pair radio button, click Download Private Key and make a note where you saved the .pem file, then click Add.
    • To the right of the newly added key, click the three dots and select View Configuration File.
    • In the Configuration File Preview, click the Copy link to copy the contents of the dialog to the clipboard
    • Paste the contents of the clipboard into a file named config and save it to ~/.oci if using Linux or macOS, or %HOMEDRIVE%%HOMEPATH%\.oci if on Windows.
    • Modify the config file to set the key_file entry to the location of the private key (.pem file ) you downloaded earlier.
    • Save the config file and close it.

  • 3. Connect to Oracle Cloud Infrastructure in Visual Studio Code

    • Open Visual Studio Code
    • Install the Oracle Developer Tools for VS Code extension if it is not already installed
    • Click the database icon in the sidebar to open Oracle Explorer.
    • In the Oracle Cloud Infrastructure section, click the refresh icon.
    • If you see the message No OCI account profile found this means that the config file is not in the correct location. Other errors may pop up. Expand them to learn more and then correct the error. For example, the path to the .PEM file referenced by the config file may be incorrect.
    • Once your profile is shown, you can use the menu to Change the Compartment or Region to find your Autonomous Database resources