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 Connector 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: OracleDBAzureConnector
paths:
  /oracleDbAzureConnector:
    get:
      description: 'Lists all Oracle DB Azure Connector resources based on the specified filters.

        '
      operationId: ListOracleDbAzureConnectors
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/AzureArcDisplayNameQueryParam'
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdQueryParam'
      - $ref: '#/components/parameters/OracleDBAzureConnectorLifecycleStateQueryParam'
      - $ref: '#/components/parameters/DbClusterResourceIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureConnectorSummaryCollection 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/OracleDbAzureConnectorSummaryCollection'
        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 Connector resources based on the specified filters.
      tags:
      - OracleDBAzureConnector
      x-example: 'GET /20240501/oracleDbAzureConnector

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureConnector'
    post:
      description: 'Creates Oracle DB Azure Connector resource and configured Azure Identity in Oracle Database resource.

        '
      operationId: CreateOracleDbAzureConnector
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: "Create Oracle DB Azure Connector resource \nand configured Azure Identity in OCI Database resource\n"
          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/OracleDbAzureConnector'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: 'Creates Oracle DB Azure Connector resource and configured Azure Identity in Oracle Database resource.

        '
      tags:
      - OracleDBAzureConnector
      x-example: "POST /20240501/oracleDbAzureConnector\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  \"dbClusterResourceId\": \"ocid1.vmcluster.oc1.iad..<example_unique_ID>\",\n  \"displayName\": \"AzureConnector-Test-OCI-CURL\",\n  \"azureTenantId\": \"5b743bc7-c1e2-4d46-b4b5-a32eddac0286\",\n  \"azureSubscriptionId\": \"00652aa6-6f3c-4e8a-93e6-60aa66d87126\",\n  \"azureResourceGroup\": \"ADBDAppNewRG\",\n  \"accessToken\": \"Azure-accessToken\",\n  \"privateEndpointIpAddress\": \"172.20.55.17\",\n  \"privateEndpointDnsAlias\": \"testazc.us-ashburn-1.oci.oracleiaas.com\",\n  \"azureIdentityMechanism\": \"ARC_AGENT\",\n  \"freeformTags\": {\n    \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n  }\n}\n"
      x-related-resource: '#/definitions/OracleDbAzureConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOracleDbAzureConnectorDetails'
        description: "Details for to Create Oracle DB Azure Connector resource \nand configured Azure Identity in Oracle Database resource.\n"
        required: true
  /oracleDbAzureConnector/{oracleDbAzureConnectorId}:
    delete:
      description: 'Deletes the Oracle DB Azure Identity Connector resource.

        '
      operationId: DeleteOracleDbAzureConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB Azure Connector 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 Oracle DB Azure Identity Connector resource.
      tags:
      - OracleDBAzureConnector
      x-example: 'DELETE /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureConnector'
    get:
      description: 'Retrieves the Oracle DB Azure Identity Connector for a specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: GetOracleDbAzureConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Returns OracleDbAzureConnector 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/OracleDbAzureConnector'
        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 the Oracle DB Azure Identity Connector for a specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
      tags:
      - OracleDBAzureConnector
      x-example: 'GET /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureConnector'
    patch:
      description: 'Patch Azure Arc Agent on Oracle Cloud VM Cluster with new version.

        '
      operationId: PatchOracleDbAzureConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB Azure Connector resource will be patched with new version.
          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: Patch Azure Arc Agent on Oracle Cloud VM Cluster with new version.
      tags:
      - OracleDBAzureConnector
      x-example: "POST /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&gt;</var>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"newVersion\": \"newVersion-1.2.3\",\n}\n"
      x-related-resource: '#/definitions/OracleDbAzureConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOracleDbAzureConnectorDetails'
        description: Patch Azure Arc Agent on Oracle Cloud VM Cluster with new version.
        required: true
    put:
      description: 'Modifies the existing Oracle DB Azure Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).

        '
      operationId: UpdateOracleDbAzureConnector
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB Azure Connector Resource 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 existing Oracle DB Azure Connector resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
      tags:
      - OracleDBAzureConnector
      x-example: "PUT /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&gt;</var>\nHost: multi-cloud-db.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.compartment.oc1..<example_unique_ID>\",\n  \"dbClusterResourceId\": \"ocid1.vmcluster.oc1.iad.<example_unique_ID>\",\n  \"displayName\": \"Updating-KV-AzureConnector-Test\",\n  \"arcAgentNodes\": [\n             {\n              \"hostName\": \"<hostName>\",\n              \"hostId\": \"ocid1.instance.oc1.iad.<example_unique_ID>\",\n              \"status\": \"CONNECTED\",\n              \"timeLastChecked\": \"2024-02-12T08:09:32.581Z\"\n              }\n       ],\n  \"azureTenantId\": \"5b743bc7-c1e2-4d46-b4b5-a32eddac0286\",\n  \"azureSubscriptionId\": \"00652aa6-6f3c-4e8a-93e6-60aa66d87126\",\n  \"azureResourceGroup\": \"ADBDAppNewRG\",\n  \"accessToken\": \"Azure-accessToken\",\n  \"privateEndpointIpAddress\": \"172.20.55.17\",\n  \"privateEndpointDnsAlias\": \"testazc.us-ashburn-1.oci.oracleiaas.com\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"lifecycleStateDetails\": null,\n  \"azureIdentityMechanism\": \"ARC_AGENT\",\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/OracleDbAzureConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOracleDbAzureConnectorDetails'
        description: Details for to update Oracle DB Azure Connector resource.
        required: true
  /oracleDbAzureConnector/{oracleDbAzureConnectorId}/actions/changeCompartment:
    post:
      description: 'Moves the Oracle DB Azure Connector resource into a different compartment. When provided, ''If-Match'' is checked against ''ETag'' values of the resource.

        '
      operationId: ChangeOracleDbAzureConnectorCompartment
      parameters:
      - $ref: '#/components/parameters/OracleDbAzureConnectorIdPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        202:
          description: Accepted the request. The Oracle DB Azure Connector 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 Oracle DB Azure Connector resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
      tags:
      - OracleDBAzureConnector
      x-example: "POST /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&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/OracleDbAzureConnector'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeOracleDbAzureConnectorCompartmentDetails'
        description: Moves the Oracle DB Azure Connector resource into a different compartment.
        required: true
  /oracleDbAzureConnector/{oracleDbAzureConnectorId}/actions/refresh:
    post:
      description: 'Refreshes the Oracle DB Azure Connector resource.

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

            '
          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 Connector resource.
      tags:
      - OracleDBAzureConnector
      x-example: 'POST /20240501/oracleDbAzureConnector/<var>&lt;oracleDbAzureConnectorId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/OracleDbAzureConnector'
components:
  schemas:
    CreateOracleDbAzureConnectorDetails:
      description: 'Create Oracle DB Azure Connector resource object.

        '
      properties:
        accessToken:
          description: Azure bearer access token.
          maxLength: 20000
          minLength: 1
          type: string
        azureIdentityMechanism:
          description: Azure Identity mechanism.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureConnector/azureIdentityMechanism'
        azureResourceGroup:
          description: Azure Resource group name.
          maxLength: 255
          minLength: 1
          type: string
        azureSubscriptionId:
          description: Azure Subscription ID.
          maxLength: 255
          minLength: 1
          type: string
        azureTenantId:
          description: Azure Tenant ID.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Azure Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        dbClusterResourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Cloud VM Cluster resource where this Azure Arc Agent Identity to configure.
          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 Connector 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
        privateEndpointDnsAlias:
          description: Private endpoint's DNS alias.
          maxLength: 255
          minLength: 1
          type: string
        privateEndpointIpAddress:
          description: Private endpoint IP.
          maxLength: 1024
          minLength: 1
          type: string
      required:
      - compartmentId
      - displayName
      - dbClusterResourceId
      - azureIdentityMechanism
      - azureTenantId
      - azureSubscriptionId
      - azureResourceGroup
      type: object
    UpdateOracleDbAzureConnectorDetails:
      description: 'Update Oracle DB Azure Connector resource object.

        '
      properties:
        accessToken:
          description: Azure bearer access token.
          maxLength: 20000
          minLength: 1
          type: string
        azureIdentityMechanism:
          description: Azure Identity mechanism.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureConnector/azureIdentityMechanism'
        azureResourceGroup:
          description: Azure Resource group name.
          maxLength: 255
          minLength: 1
          type: string
        azureSubscriptionId:
          description: Azure Subscription ID.
          maxLength: 255
          minLength: 1
          type: string
        azureTenantId:
          description: Azure Tenant ID.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Azure Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        dbClusterResourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Cloud VM Cluster resource where this Azure Arc Agent Identity to configure.
          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 Connector 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
        privateEndpointDnsAlias:
          description: Private endpoint's DNS alias.
          maxLength: 255
          minLength: 1
          type: string
        privateEndpointIpAddress:
          description: Private endpoint IP.
          maxLength: 1024
          minLength: 1
          type: string
      type: object
    ArcAgentNodes:
      description: 'Azure Arc Agent node details.

        '
      properties:
        currentArcAgentVersion:
          description: Current Arc Agent Version installed on this node of Oracle Cloud VM Cluster.
          maxLength: 255
          minLength: 1
          type: string
        hostId:
          description: Host ID.
          maxLength: 255
          minLength: 1
          type: string
        hostName:
          description: Host name or Azure Arc Agent name.
          maxLength: 255
          minLength: 1
          type: string
        status:
          description: The current status of the Azure Arc Agent resource.
          enum:
          - CONNECTED
          - DISCONNECTED
          - UNKNOWN
          type: string
        timeLastChecked:
          description: 'Time when the Azure Arc Agent''s status was checked [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
    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
    OracleDbAzureConnector:
      description: 'Oracle DB Azure Connector resource.

        '
      properties:
        accessToken:
          description: Azure bearer access token.
          maxLength: 20000
          minLength: 1
          type: string
        arcAgentNodes:
          description: List of all VMs where Arc Agent is installed under Cloud VM Cluster.
          items:
            $ref: '#/components/schemas/ArcAgentNodes'
          type: array
        azureIdentityConnectivityStatus:
          description: The current Connectivity status of Azure Identity Connector resource.
          enum:
          - CONNECTED
          - DISCONNECTED
          - PARTIALLY_CONNECTED
          - UNKNOWN
          type: string
        azureIdentityMechanism:
          description: Azure Identity mechanism.
          enum:
          - ARC_AGENT
          - SERVICE_PRINCIPAL
          type: string
        azureResourceGroup:
          description: Azure Resource group name.
          maxLength: 255
          minLength: 1
          type: string
        azureSubscriptionId:
          description: Azure Subscription ID.
          maxLength: 255
          minLength: 1
          type: string
        azureTenantId:
          description: Azure Tenant ID.
          maxLength: 255
          minLength: 1
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Azure Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        dbClusterResourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Cloud VM Cluster resource where this Azure Arc Agent identity to configure.
          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 Connector 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](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Connector resource.
          maxLength: 255
          minLength: 1
          type: string
        lastModification:
          description: Description of the latest modification of the Oracle DB Azure Connector resource.
          maxLength: 1024
          minLength: 1
          type: string
        lifecycleState:
          description: The current lifecycle state of the Azure Arc Agent 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
        privateEndpointDnsAlias:
          description: Private endpoint's DNS alias.
          maxLength: 255
          minLength: 1
          type: string
        privateEndpointIpAddress:
          description: Private endpoint IP.
          maxLength: 1024
          minLength: 1
          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 Connector resource was created 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
        timeUpdated:
          description: 'Time when the Oracle DB Azure Connector 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
      - dbClusterResourceId
      - azureTenantId
      - azureSubscriptionId
      - azureResourceGroup
      type: object
    ChangeOracleDbAzureConnectorCompartmentDetails:
      description: Details of the new compartment to contain the Oracle DB Azure Connector resource.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the new compartment to contain the Oracle DB Azure Connector 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
    PatchOracleDbAzureConnectorDetails:
      description: Details for to patch Oracle DB Azure Connector resource.
      properties:
        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
        newVersion:
          description: The new version of Azure Agent to be used for patching.
          maxLength: 255
          minLength: 1
          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
    OracleDbAzureConnectorSummaryCollection:
      description: List of OracleDbAzureConnectorSummary resources.
      properties:
        items:
          description: OracleDbAzureConnectorSummary object.
          items:
            $ref: '#/components/schemas/OracleDbAzureConnectorSummary'
          type: array
      required:
      - items
      type: object
    OracleDbAzureConnectorSummary:
      description: Details of Oracle DB Azure Connector resource.
      properties:
        arcAgentNodes:
          description: List of all VMs where Arc Agent Identity is configure under Oracle Cloud VM Cluster.
          items:
            $ref: '#/components/schemas/ArcAgentNodes'
          type: array
        azureIdentityConnectivityStatus:
          description: The current lifecycle state of the Oracle DB Azure Identity Connector resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureConnector/azureIdentityConnectivityStatus'
        azureIdentityMechanism:
          description: Azure Identity mechanism.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureConnector/azureIdentityMechanism'
        azureResourceGroup:
          description: Azure Resource group name.
          type: string
        azureSubscriptionId:
          description: Azure Subscription ID.
          type: string
        azureTenantId:
          description: Azure Tenant ID.
          type: string
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains Oracle DB Azure Connector resource.
          type: string
        dbClusterResourceId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Cloud VM Cluster resource where this Azure Arc Agent Identity to configure.
          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 Connector 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](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Connector resource.
          type: string
        lastModification:
          description: Description of the latest modification of the Oracle DB Azure Connector resource.
          type: string
        lifecycleState:
          description: The current lifecycle state of the Oracle DB Azure Connector resource.
          type: string
          x-obmcs-enumref: '#/definitions/OracleDbAzureConnector/lifecycleState'
        lifecycleStateDetails:
          description: Description of the current lifecycle state in more detail.
          type: string
        privateEndpointDnsAlias:
          description: Private endpoint's DNS alias.
          type: string
        privateEndpointIpAddress:
          description: Private endpoint IP.
          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 Connector resource was created 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
        timeUpdated:
          description: 'Time when the Oracle DB Azure Connector 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
  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
    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
    AzureArcDisplayNameQueryParam:
      description: A filter to return Oracle DB Azure Connector resources that match the specified display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    OracleDBAzureConnectorLifecycleStateQueryParam:
      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/OracleDbAzureConnector/lifecycleState'
      schema:
        type: string
    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
    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
    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
    DbClusterResourceIdQueryParam:
      description: The [ID](/iaas/Content/General/Concepts/identifiers.htm) of the Database resource.
      in: query
      name: dbClusterResourceId
      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
    OracleDbAzureConnectorIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Connector resource.
      in: path
      name: oracleDbAzureConnectorId
      required: true
      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