Package com.oracle.bmc.dbmulticloud

Interface OracleDbAzureVault

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    OracleDbAzureVaultClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20240501")
public interface OracleDbAzureVault
extends AutoCloseable

    Microsoft Azure:
    Oracle Azure Connector Resource::  The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

    The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:

    • Using a Bearer Access Token

    Oracle Azure Blob Container Resource:  The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. This resource can then be reused across multiple Exadata VM clusters in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D) to mount the Azure container.

    Oracle Azure Blob Mount Resource:  The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). It relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.

    Discover Azure Vaults and Keys Resource:  The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.

    Oracle Azure Vault:  The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

    Oracle Azure Key:  Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.
    Google Cloud:
    Oracle Google Cloud Connector Resource:  The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

    Discover Google Key Rings and Keys Resource:  The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.

    Google Key Rings Resource:  The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

    Google Key Resource:  The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeOracleDbAzureVaultCompartment

        ChangeOracleDbAzureVaultCompartmentResponse changeOracleDbAzureVaultCompartment​(ChangeOracleDbAzureVaultCompartmentRequest request)
        Moves the DB Azure Vault resource into a different compartment.

        When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/ChangeOracleDbAzureVaultCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeOracleDbAzureVaultCompartment API.

      • createOracleDbAzureVault

        CreateOracleDbAzureVaultResponse createOracleDbAzureVault​(CreateOracleDbAzureVaultRequest request)
        Creates DB Azure Vault resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/CreateOracleDbAzureVaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOracleDbAzureVault API.

      • deleteOracleDbAzureVault

        DeleteOracleDbAzureVaultResponse deleteOracleDbAzureVault​(DeleteOracleDbAzureVaultRequest request)
        Deletes the DB Azure Vault resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/DeleteOracleDbAzureVaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteOracleDbAzureVault API.

      • getOracleDbAzureVault

        GetOracleDbAzureVaultResponse getOracleDbAzureVault​(GetOracleDbAzureVaultRequest request)
        Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource OCID.

        This operation returns metadata and configuration details associated with the specified vault resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/GetOracleDbAzureVaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetOracleDbAzureVault API.

      • listOracleDbAzureVaults

        ListOracleDbAzureVaultsResponse listOracleDbAzureVaults​(ListOracleDbAzureVaultsRequest request)
        Lists all DB Azure Vault resources based on the specified filters.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/ListOracleDbAzureVaultsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListOracleDbAzureVaults API.

      • refreshOracleDbAzureVault

        RefreshOracleDbAzureVaultResponse refreshOracleDbAzureVault​(RefreshOracleDbAzureVaultRequest request)
        Refreshes the Oracle DB Azure Vault resource.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/RefreshOracleDbAzureVaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RefreshOracleDbAzureVault API.

      • updateOracleDbAzureVault

        UpdateOracleDbAzureVaultResponse updateOracleDbAzureVault​(UpdateOracleDbAzureVaultRequest request)
        Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique OCID.

        This operation updates only the specified fields in the request body.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/dbmulticloud/UpdateOracleDbAzureVaultExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateOracleDbAzureVault API.

      • getWaiters

        OracleDbAzureVaultWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        OracleDbAzureVaultPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.