openapi: 3.2.0
info:
  description: "<b>Microsoft Azure:</b> <br>\n<b>Oracle Azure Connector Resource:</b>:&nbsp;&nbsp;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).\n The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:\n<ul>\n <li>Using a Bearer Access Token</li>\n</ul>\n\n<b>Oracle Azure Blob Container Resource:</b>&nbsp;&nbsp;The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. \nThis 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.\n\n<b>Oracle Azure Blob Mount Resource:</b>&nbsp;&nbsp;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).\nIt relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.\n\n<b>Discover Azure Vaults and Keys Resource:</b>&nbsp;&nbsp;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.\n\n<b>Oracle Azure Vault:</b>&nbsp;&nbsp;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.\n\n<b>Oracle Azure Key:</b>&nbsp;&nbsp;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.\n\n<br>\n\n<b>Google Cloud:</b><br>\n<b>Oracle Google Cloud Connector Resource:</b>&nbsp;&nbsp;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).\n\n<b>Discover Google Key Rings and Keys Resource:</b>&nbsp;&nbsp;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.\n\n<b>Google Key Rings Resource:</b>&nbsp;&nbsp;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.\n\n<b>Google Key Resource:</b>&nbsp;&nbsp;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.\n<br>\n\n<b>AWS</b>:<br>\n<b>Oracle AWS Connector Resource:</b>&nbsp;&nbsp;The Oracle AWS Connector Resource is used to install the AWS Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\n<b>Oracle AWS Key Resource:</b>&nbsp;&nbsp;The Oracle AWS Key Resource is used to register and manage a AWS Key within Oracle Cloud Infrastructure (OCI).\n"
  title: Oracle Database MultiCloud Data Plane Integration Oracle Db Azure Vault API
  version: '20240501'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Database MultiCloud Data Plane Integration OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/70d1a303c64ae25a654e1897690653227087a9daff98ffa409104e364edd293c.yaml
    what: the harvested document for Oracle Database MultiCloud Data Plane Integration
servers:
- url: http://127.0.0.1/20240501
- url: https://127.0.0.1/20240501
tags:
- name: OracleDbAzureVault
paths:
  /oracleDbAzureVault:
    get:
      description: 'Lists all DB Azure Vault resources based on the specified filters.

        '
      operationId: ListOracleDbAzureVaults
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OracleAzureVaultDisplayNameQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureVaultIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureVaultLifecycleStateQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureResourceGroupQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureVaultSummaryCollection object.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

                important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAzureVaultSummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists all DB Azure Vault resources based on the specified filters.
      tags:
      - OracleDbAzureVault
      x-example: 'GET /20240501/oracleDbAzureVault

        Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAzureVault'
    post:
      description: 'Creates DB Azure Vault resource.

        '
      operationId: CreateOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: Creates DB Azure Vault resource.
          headers:
            content-location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the resource
              schema:
                type: string
                format: uri-reference
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAzureVault'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: 'Creates DB Azure Vault resource.

        '
      tags:
      - OracleDbAzureVault
      x-example: "POST /20240501/oracleDbAzureVault\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"TestDbAzureVault\",\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n  \"oracleDbAzureResourceGroup\": \"QAResourceGroup\",\n  \"oracleDbConnectorId\": \"ocid1.oracledbazureconnector.oc1.iad.<example_unique_ID>\",\n  \"azureVaultId\":\"/subscriptions/7080446f-ee76-4aa2-b9dd-c2625f63cab0/resourceGroups/Prasanna.RG/providers/Microsoft.KeyVault/managedHSMs/PrasannaHSM2\",\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  }\n}\n"
      x-related-resource: '#/definitions/OracleDbAzureVault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOracleDbAzureVaultDetails'
        description: Details for to Create Oracle DB Azure Vault details.
        required: true
  /oracleDbAzureVault/{oracleDbAzureVaultId}:
    delete:
      description: 'Deletes the DB Azure Vault resource.

        '
      operationId: DeleteOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The DB Azure Vault resource object will be deleted.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes the DB Azure Vault resource.
      tags:
      - OracleDbAzureVault
      x-example: 'DELETE /20240501/oracleDbAzureVault/<var>&lt;oracleDbAzureVaultId&gt;</var>

        Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAzureVault'
    get:
      description: 'Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource [OCID](/Content/General/Concepts/identifiers.htm). This operation returns metadata and configuration details associated with the specified vault resource.

        '
      operationId: GetOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureBlobContainer object.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OracleDbAzureVault'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource [OCID](/Content/General/Concepts/identifiers.htm). This operation returns metadata and configuration details associated with the specified vault resource.
      tags:
      - OracleDbAzureVault
      x-example: 'GET /20240501/oracleDbAzureVault/<var>&lt;OracleDbAzureVaultId&gt;</var>

        Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAzureVault'
    put:
      description: 'Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique [OCID](/Content/General/Concepts/identifiers.htm). This operation updates only the specified fields in the request body.

        '
      operationId: UpdateOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB Azure Vault will be updated.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique [OCID](/Content/General/Concepts/identifiers.htm). This operation updates only the specified fields in the request body.
      tags:
      - OracleDbAzureVault
      x-example: "PUT /20240501/oracleDbAzureVault/<var>&lt;racleDBAzureVaultId&gt;</var>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"TestDBAzureBlobContainerUpdated\" ,\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n  \"oracleDbAzureResourceGroup\": \"QAResourceGroup\",\n  \"oracleDbConnectorId\": \"ocid1.oracledbazureconnector.oc1.iad.<example_unique_ID>\",\n  \"azureVaultId\":\"/subscriptions/7080446f-ee76-4aa2-b9dd-c2625f63cab0/resourceGroups/Prasanna.RG/providers/Microsoft.KeyVault/managedHSMs/PrasannaHSM2\",\n  \"type\": \"Microsoft.KeyVault/managedHSMs\",\n  \"location\": \"eastus\",\n  \"properties\": {\n    \"tenantId\": \"some-azure-tenantId\",\n    \"hsmUri\": \"https://hsmkc.uri/\"\n  },\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleStateDetails\": null,\n  \"timeCreated\": \"2024-02-09T06:31:16.380Z\",\n  \"timeUpdated\": \"1970-01-01T00:00:00.000Z\",\n  \"lastModification\": null,\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  }\n}\n"
      x-related-resource: '#/definitions/OracleDbAzureVault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOracleDbAzureVaultDetails'
        description: Details for to update OracleDbAzureVault.
        required: true
  /oracleDbAzureVault/{oracleDbAzureVaultId}/actions/changeCompartment:
    post:
      description: Moves the DB Azure Vault resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      operationId: ChangeOracleDbAzureVaultCompartment
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The DB Azure Vault resource will be moved to the new compartment.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Moves the DB Azure Vault resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - OracleDbAzureVault
      x-example: "POST /20240501/oracleDbAzureVault/<var>&lt;oracleDbAzureVaultId&gt;</var>/actions/changeCompartment\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\"\n}\n"
      x-related-resource: '#/definitions/OracleDbAzureVault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOracleDbAzureVaultCompartmentDetails'
        description: Moves the DB Azure Vault resource into a different compartment.
        required: true
  /oracleDbAzureVault/{oracleDbAzureVaultId}/actions/refresh:
    post:
      description: 'Refreshes the Oracle DB Azure Vault resource.

        '
      operationId: RefreshOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The Oracle DB Azure Vault resource object will be synced with Azure Vaults.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Refreshes the Oracle DB Azure Vault resource.
      tags:
      - OracleDbAzureVault
      x-example: 'POST /20240501/oracleDbAzureVault/<var>&lt;oracleDbAzureVaultId&gt;</var>/actions/refresh

        Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/OracleDbAzureVault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshOracleDbAzureVaultDetails'
        description: Details for to refresh Oracle DB Azure Vault resource.
  /oracleDbAzureVault/{oracleDbAzureVaultId}/actions/replicate:
    post:
      description: 'Replicate the Oracle DB Azure Vault resource to target region.

        '
      operationId: ReplicateOracleDbAzureVault
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureVaultIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: 'Accepted the request, The Oracle DB Azure Vault resource object will be synced with Azure Vaults.

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Replicate the Oracle DB Azure Vault resource to target region.
      tags:
      - OracleDbAzureVault
      x-example: "POST /20240501/oracleDbAzureVault/<var>&lt;oracleDbAzureVaultId&gt;</var>/actions/replicate\nHost: dbmulticloud.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n   \"targetRegion\": \"us-ashburn-1\",\n   \"action\": \"CREATE\n}\n"
      x-obmcs-terraform:
        actionType: UPDATE_FIELD
      x-related-resource: '#/definitions/OracleDbAzureVault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicateOracleDbAzureVaultDetails'
        description: Details for to replicate Oracle DB Azure Vault resource to target region.
        required: true
components:
  schemas:
    CreateOracleDbAzureVaultDetails:
      description: 'Create Oracle DB Azure Vault obejct.

        '
      properties:
        azureVaultId:
          description: Azure Vault ID.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Azure Vault resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        location:
          description: Oracle DB Azure Vault resource location.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbAzureResourceGroup:
          description: Oracle DB Azure resource group name.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource that contains Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            type: string
          description: resource's properties.
          maxProperties: 20
          type: object
        type:
          description: Oracle DB Azure Vault resource type.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - displayName
      - oracleDbConnectorId
      type: object
    Error:
      description: Error information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error message.
          type: string
      required:
      - code
      - message
    UpdateOracleDbAzureVaultDetails:
      description: 'This object is about to provide input params to update Oracle DB Azure Vault resource.

        '
      properties:
        azureVaultId:
          description: Azure Vault ID.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains this Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Azure Vault resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        location:
          description: Oracle DB Azure Vault resource location.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbAzureResourceGroup:
          description: Oracle DB Azure resource group name.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource that contains Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            type: string
          description: Oracle DB Azure Vault resource's properties.
          maxProperties: 20
          type: object
        type:
          description: Oracle DB Azure Vault resource type.
          maxLength: 255
          minLength: 1
          type: string
      type: object
    OracleDbAzureVault:
      description: 'Oracle DB Azure Vault resource object.

        '
      properties:
        azureVaultId:
          description: Azure Vault ID.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains this Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Azure Vault resource name.
          maxLength: 255
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        lastModification:
          description: Description of the latest modification of the Oracle DB Azure Vault resource.
          maxLength: 1024
          minLength: 1
          type: string
        lifecycleState:
          description: The lifecycle state of the Oracle DB Azure Vault resource.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          maxLength: 1024
          minLength: 1
          type: string
        location:
          description: Oracle DB Azure Vault resource location.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbAzureResourceGroup:
          description: Oracle DB Azure resource group name.
          maxLength: 255
          minLength: 1
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource that contains Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        properties:
          additionalProperties:
            type: string
          description: Oracle DB Azure Vault resource's properties.
          maxProperties: 20
          type: object
        replicationMetadata:
          $ref: '#/components/schemas/ReplicationMetadata'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        type:
          description: Oracle DB Azure Vault resource type.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - oracleDbAzureResourceGroup
      type: object
    OracleDbAzureVaultSummary:
      description: 'Oracle DB Azure Vault resource summary.

        '
      properties:
        azureVaultId:
          description: Azure Vault ID.
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment contains DB Azure Vault resource.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: Oracle DB Azure Vault resource name.
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the oracle DB Azure Vault resource.
          type: string
        lastModification:
          description: Description of the latest modification of the DB Azure Vault resource.
          type: string
        lifecycleState:
          description: The current lifecycle state of the Azure Arc Agent resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureVault/lifecycleState'
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          type: string
        location:
          description: Oracle DB Azure Vault resource location.
          type: string
        oracleDbAzureResourceGroup:
          description: Oracle DB Azure resource group name.
          type: string
        oracleDbConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource that contains Oracle DB Azure Vault resource.
          type: string
        properties:
          additionalProperties:
            type: string
          description: Oracle DB Azure Vault resource's properties.
          maxProperties: 20
          type: object
        replicationMetadata:
          $ref: '#/components/schemas/ReplicationMetadata'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: 'Time when the Oracle DB Azure Vault resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Oracle DB Azure Vault resource was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        type:
          description: Oracle DB Azure Vault resource type.
          type: string
      type: object
    ReplicateOracleDbAzureVaultDetails:
      description: 'Replicate Oracle GCP Keyring resource.

        '
      properties:
        action:
          description: Action for replicate Resource.
          enum:
          - CREATE
          - DELETE
          type: string
          x-obmcs-top-level-enum: '#/definitions/ReplicationActions'
        targetRegion:
          description: The Destination region where Oracle GCP Keyring resource will replicate.
          type: string
      required:
      - targetRegion
      type: object
    ChangeOracleDbAzureVaultCompartmentDetails:
      description: Details of the new compartment to contain the Oracle DB Azure Vault resource.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the new compartment to contain the Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


              Example: `{"free-tier-retained": "true"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
    RefreshOracleDbAzureVaultDetails:
      description: Details for to refresh DB Azure Vault resource.
      properties:
        oracleDbAzureConnectorId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
    OracleDbAzureVaultSummaryCollection:
      description: List of OracleDbAzureVaultSummary resources.
      properties:
        items:
          description: This list contains the summary of DB Azure Vault resources.
          items:
            $ref: '#/components/schemas/OracleDbAzureVaultSummary'
          type: array
      required:
      - items
      type: object
    ReplicationMetadata:
      description: 'Replication metadata, it has information about replication and target region.

        '
      properties:
        replicationDetails:
          description: List of all regions and their respective resource ID.
          items:
            $ref: '#/components/schemas/ReplicationDetails'
          maxItems: 20
          minItems: 0
          type: array
      type: object
    ReplicationDetails:
      description: 'Replication metadata details, targeted regions and respective replication state, time created or time when it was updated.

        '
      properties:
        replicationState:
          description: The lifecycle state of the Oracle DB Azure Vault resource.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        targetRegion:
          description: The target region, where resource is replicated.
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: 'Time when the Replication was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Time when the Replication was last modified, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-23T21:10:29.600Z''

            '
          format: date-time
          type: string
      type: object
  parameters:
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified, default is timeCreated.

        '
      in: query
      name: sortBy
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    CompartmentIdQueryParam:
      description: The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    OracleDbAzureVaultLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

        '
      in: query
      name: lifecycleState
      required: false
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/OracleDbAzureVault/lifecycleState'
      schema:
        type: string
    OracleDbAzureVaultIdQueryParam:
      description: A filter to return Oracle DB Azure Vault resources that match the specified [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource.
      in: query
      name: oracleDbAzureVaultId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAzureVaultIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource.
      in: path
      name: oracleDbAzureVaultId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      x-default-description: 'null'
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: DESC
    OracleDbAzureConnectorIdQueryParam:
      description: A filter to return Oracle DB Azure Azure Identity Connector resources.
      in: query
      name: oracleDbAzureConnectorId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.


        Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.


        For example, if a resource has been deleted and permanently purged from the system, a retry of the original creation request may be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    OracleDbAzureResourceGroupQueryParam:
      description: A filter to return Oracle DB Azure Vault resources that match the specified Oracle DB Azure resource group name.
      in: query
      name: oracleDbAzureResourceGroup
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    OracleAzureVaultDisplayNameQueryParam:
      description: A filter to return Oracle DB Azure Vault resources that match the specified display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages of results remain. For

        important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

        Use GetWorkRequest with this ID to track the status of the request.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    content-location:
      description: URI of the resource
      format: uri-reference
      type: string
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.


          Example: `{"CostCenter": "42"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Operations": {"CostCenter": "42"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

        For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).


        Example: `{"Department": "Finance"}`

        '
      type: object
    location:
      description: URI of the resource
      format: uri-reference
      type: string
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only the String type is supported.

            '
          type: object
        description: 'Key-value pair representing a system tag key and value, scoped to a namespace.


          Example: `{"free-tier-retained": "true"}`

          '
        type: object
      description: 'System tags for this resource. Each key is predefined and scoped to a namespace.


        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.db.mci.azure.identity