Oracle Oracle Db Azure Key API

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 Key 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: OracleDbAzureKey
paths:
  /oracleDbAzureKey:
    get:
      description: 'Lists all Oracle DB Azure Keys based on the specified filters.

        '
      operationId: ListOracleDbAzureKeys
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureKeyDisplayNameQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureVaultIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureKeyIdQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureKeyLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureKeySummaryCollection 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/OracleDbAzureKeySummaryCollection'
        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 Oracle DB Azure Keys based on the specified filters.
      tags:
      - OracleDbAzureKey
      x-example: 'GET /20240501/oracleDbAzureKey

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureKey'
  /oracleDbAzureKey/{oracleDbAzureKeyId}:
    get:
      description: 'Retrieves detailed information about a Oracle DB Azure Key resource by specifying its unique resource [OCID](/Content/General/Concepts/identifiers.htm).

        '
      operationId: GetOracleDbAzureKey
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureKeyIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureKey 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/OracleDbAzureKey'
        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 a Oracle DB Azure Key resource by specifying its unique resource [OCID](/Content/General/Concepts/identifiers.htm).
      tags:
      - OracleDbAzureKey
      x-example: 'GET /20240501/oracleDbAzureKey/<var>&lt;oracleDbAzureKeyId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureKey'
components:
  parameters:
    OracleDbAzureKeyDisplayNameQueryParam:
      description: A filter to return Oracle DB Azure Vault Keys resources that match the specified display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
    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
    OracleDbAzureKeyLifecycleStateQueryParam:
      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/OracleDbAzureKey/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
    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
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    OracleDbAzureKeyIdQueryParam:
      description: A filter to return Oracle DB Azure Vault Keys resource that match the specified Oracle DB Azure Key [OCID](/Content/General/Concepts/identifiers.htm).
      in: query
      name: oracleDbAzureKeyId
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDbAzureKeyIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault Key resource.
      in: path
      name: oracleDbAzureKeyId
      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
  schemas:
    OracleDbAzureKeySummary:
      description: 'Oracle DB Azure Key resource summary.

        '
      properties:
        azureKeyId:
          description: The ID of Azure Key resource.
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment contains Oracle DB Azure Vault Key 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 Key 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) for the Oracle DB Azure Vault Key resource.
          type: string
        keyProperties:
          description: Key properties
          type: object
        lastModification:
          description: Description of the latest modification of the Oracle DB Azure Vault resource.
          type: string
        lifecycleState:
          description: The current lifecycle state of the Oracle DB Azure Vault Key resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureKey/lifecycleState'
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          type: string
        oracleDbAzureVaultId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource.
          type: string
        resourceType:
          description: Key Resource type.
          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
        timeCreated:
          description: 'Time when the Oracle DB Azure Vault Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''

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

            '
          format: date-time
          type: string
      type: object
    OracleDbAzureKeySummaryCollection:
      description: List of OracleDbAzureKeySummary resources.
      properties:
        items:
          description: This list contains the summary of Oracle DB Azure Key resources.
          items:
            $ref: '#/components/schemas/OracleDbAzureKeySummary'
          type: array
      required:
      - items
      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
    OracleDbAzureKey:
      description: 'Oracle DB Azure Key resource object.

        '
      properties:
        azureKeyId:
          description: The ID of the Azure Key resource.
          maxLength: 1024
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Azure Vault Key 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 Key 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 Key resource.
          maxLength: 255
          minLength: 1
          type: string
        keyProperties:
          description: Key properties
          type: object
        lastModification:
          description: Description of the latest modification of the Oracle DB Azure Vault Key resource.
          maxLength: 1024
          minLength: 1
          type: string
        lifecycleState:
          description: The current lifecycle state of the Oracle DB Azure Vault Key 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
        oracleDbAzureVaultId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Vault resource.
          maxLength: 255
          minLength: 1
          type: string
        resourceType:
          description: Key Resource type.
          maxLength: 1024
          minLength: 0
          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
        timeCreated:
          description: 'Time when the Oracle DB Azure Vault Key resource was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''

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

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - oracleDbAzureVaultId
      type: object
  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