openapi: 3.2.0
info:
description: "Microsoft Azure:
\nOracle Azure Connector Resource:: The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:\n
\n - Using a Bearer Access Token
\n
\n\nOracle Azure Blob Container Resource: 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\nOracle Azure Blob Mount Resource: The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\nIt relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.\n\nDiscover Azure Vaults and Keys Resource: The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.\n\nOracle Azure Vault: The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\nOracle Azure Key: Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.\n\n
\n\nGoogle Cloud:
\nOracle Google Cloud Connector Resource: The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).\n\nDiscover Google Key Rings and Keys Resource: The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.\n\nGoogle Key Rings Resource: The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.\n\nGoogle Key Resource: The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.\n
\n\nAWS:
\nOracle AWS Connector Resource: 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\nOracle AWS Key Resource: 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 Multi Cloud Resource Discovery 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: MultiCloudResourceDiscovery
paths:
/multiCloudResourceDiscovery:
get:
description: 'Lists all Multicloud Resource Discovery resources based on the specified filters.
'
operationId: ListMultiCloudResourceDiscoveries
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryDisplayNameQueryParam'
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryIdQueryParam'
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryLifecycleStateQueryParam'
- $ref: '#/components/parameters/OracleDbAzureConnectorIdQueryParam'
- $ref: '#/components/parameters/MultiCloudResourceTypeQueryParam'
- $ref: '#/components/parameters/MultiCloudResourcesFilterQueryParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns MultiCloudResourceDiscoverySummaryCollection 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/MultiCloudResourceDiscoverySummaryCollection'
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 Multicloud Resource Discovery resources based on the specified filters.
tags:
- MultiCloudResourceDiscovery
x-example: 'GET /20240501/multiCloudResourceDiscovery
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
post:
description: 'Discovers Multicloud Resource and their associated resources based on the information provided.
'
operationId: CreateMultiCloudResourceDiscovery
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: Discovering Azure Vaults and Keys based using Identity Connector Configured.
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/MultiCloudResourceDiscovery'
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: 'Discovers Multicloud Resource and their associated resources based on the information provided.
'
tags:
- MultiCloudResourceDiscovery
x-example: "POST /20240501/multiCloudResourceDiscovery\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"Discover1\" ,\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"oracleDbConnectorId\": \"ocid1.oracledbazureconnector.oc1.iad.\",\n \"resourceType\":\"VAULTS\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateMultiCloudResourceDiscoveryDetails'
description: Details for to Discover Multicloud Resource and their associated resources.
required: true
/multiCloudResourceDiscovery/{multiCloudResourceDiscoveryId}:
delete:
description: 'Deletes the Multicloud Resource Discovery resource and removes its associated metadata from Oracle Cloud Infrastructure.
'
operationId: DeleteMultiCloudResourceDiscovery
parameters:
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: 'Accepted the request, The Multi Cloud Discovery Resource 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 Multicloud Resource Discovery resource and removes its associated metadata from Oracle Cloud Infrastructure.
tags:
- MultiCloudResourceDiscovery
x-example: 'DELETE /20240501/multiCloudResourceDiscovery/<multiCloudResourceDiscoveryID>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
get:
description: 'Retrieves detailed information about a Multicloud discovered resource by specifying its unique resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: GetMultiCloudResourceDiscovery
parameters:
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns MultiCloudResourceDiscovery 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/MultiCloudResourceDiscovery'
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 Multicloud discovered resource by specifying its unique resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- MultiCloudResourceDiscovery
x-example: 'GET /20240501/multiCloudResourceDiscovery/<multiCloudResourceDiscoveryId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
put:
description: 'Modifies the properties of an Azure discovered resource identified by the specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateMultiCloudResourceDiscovery
parameters:
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Multicloud Resource Discovery 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 properties of an Azure discovered resource identified by the specified resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- MultiCloudResourceDiscovery
x-example: "PUT /20240501/multiCloudResourceDiscovery/<multiCloudResourceDiscoveryID>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"id\": \"ocid1.multicloudresourcediscovery.oc1.iad.\",\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"displayName\": \"MultiCloudResourceDiscovery1\",\n \"oracleDbConnectorId\": \"ocid1.oracledbazureconnector.oc1.iad.\",\n \"resourceType\": \"VAULTS\"\n \"resources\": [\n {\n \"id\": \"/subscriptions/7080446f-ee76-4aa2-b9dd-c2625f63cab0/resourceGroups/Prasanna.RG/providers/Microsoft.KeyVault/managedHSMs/PrasannaHSM2\",\n \"name\": \"managedHSMs\",\n \"resourceGroup\": \"group1\",\n \"type\": \"Microsoft.KeyVault/managedHSMs\",\n \"location\": \"eastus\",\n \"properties\": {\n \"tenantId\": \"some-azure-tenantId\",\n \"hsmUri\": \"https://hsmkc.uri/\"\n }\n }\n ],\n \"lifecycleState\": \"DISCOVERED\",\n \"lifecycleStateDetails\": null,\n \"timeCreated\": \"2024-05-12T09:39:16.105Z\",\n \"timeUpdated\": \"2024-05-12T09:39:16.105Z\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n },\n \"definedTags\": {\n \"Oracle-Tags\": {\n \"CreatedBy\": \"canary_op_user\",\n \"CreatedOn\": \"2024-02-12T09:39:15.995Z\"\n }\n },\n \"systemTags\": {}\n}\n"
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMultiCloudResourceDiscoveryDetails'
description: Details for to update MultiCloudResourceDiscovery.
required: true
/multiCloudResourceDiscovery/{multiCloudResourceDiscoveryId}/actions/changeCompartment:
post:
description: Moves the Multicloud Resource Discovery resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
operationId: ChangeMultiCloudResourceDiscoveryCompartment
parameters:
- $ref: '#/components/parameters/MultiCloudResourceDiscoveryIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Multi Cloud Discovered 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 Multicloud Resource Discovery resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
tags:
- MultiCloudResourceDiscovery
x-example: "POST /20240501/multiCloudResourceDiscovery/<multiCloudResourceDiscoveryId>/actions/changeCompartment\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.compartment.oc1..\"\n}\n"
x-related-resource: '#/definitions/MultiCloudResourceDiscovery'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeMultiCloudResourceDiscoveryCompartmentDetails'
description: Moves the Multi Cloud Discovered resource to a different compartment.
required: true
components:
parameters:
MultiCloudResourceDiscoveryDisplayNameQueryParam:
description: A filter to return Oracle DB Multicloud Discovery resources that match the specified display name.
in: query
name: displayName
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
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
MultiCloudResourceDiscoveryIdQueryParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Multicloud Discovery resource.
in: query
name: multiCloudResourceDiscoveryId
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
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
MultiCloudResourceDiscoveryLifecycleStateQueryParam:
description: 'A filter to return only resources that match the specified lifecycle state. The state value is case-insensitive.
'
in: query
name: lifecycleState
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/lifecycleState'
schema:
type: string
MultiCloudResourceTypeQueryParam:
description: The type of Multicloud Resource.
in: query
name: resourceType
required: false
x-default-description: 'null'
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/resourceType'
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
RequestIdHeader:
description: The client request ID for tracing.
in: header
name: opc-request-id
schema:
type: string
MultiCloudResourcesFilterQueryParam:
description: Specifies the type(s) of resources to discover in the target cloud provider.
in: query
name: resourcesFilter
required: false
x-default-description: 'null'
schema:
type: array
items:
maxLength: 2048
minLength: 1
type: string
maxItems: 100
minItems: 0
MultiCloudResourceDiscoveryIdPathParam:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Multicloud Discovery Resource.
in: path
name: multiCloudResourceDiscoveryId
required: true
schema:
type: string
maxLength: 255
minLength: 1
schemas:
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
MultiCloudResourceDiscovery:
description: 'Multicloud Resource Discovery resource object
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Multicloud Resource Discovery 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: Display name of the Multicloud Resource Discovery resource.
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 Multicloud Resource Discovery resource
maxLength: 255
minLength: 1
type: string
lastModification:
description: Description of the latest modification of the Multicloud Resource Discovery resource.
maxLength: 1024
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the discovered resource.
enum:
- ACCEPTED
- IN_PROGRESS
- WAITING
- SUCCEEDED
- UPDATING
- CANCELING
- CANCELED
- FAILED
- NEEDS_ATTENTION
type: string
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
maxLength: 1024
minLength: 1
type: string
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
maxLength: 255
minLength: 1
type: string
resourceType:
description: Resource Type to discover.
enum:
- VAULTS
- STORAGE
- GCP_KEY_RINGS
- AWS_KEYS
type: string
resources:
description: List of All Discovered resources.
items:
$ref: '#/components/schemas/Resources'
maxItems: 50
minItems: 0
type: array
resourcesFilter:
additionalProperties:
type: string
description: 'Discover resource using attributes as key-value pair.
For GCP supported attributes (keyRing)
For Azure supported attributes (keyVault)
GCP Example
`{"keyRing": "projects/db-mc-dataplane/locations/global/keyRings/dbmci-keyring"}` or
`{"keyRing": "dbmci-keyring"}`
Azure Example
`{"keyVault": "/subscriptions/fd42b73d-5f28-4a23-ae7c-ca08c625fe07/resourceGroups/yumfei0808Test/providers/Microsoft.KeyVault/managedHSMs/orp7HSM001"}` or
`{"keyVault": "orp7HSM001"}`
'
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
timeCreated:
description: 'Time when the Multicloud Discovery 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 Multicloud Discovery 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
- oracleDbConnectorId
- resourceType
type: object
UpdateMultiCloudResourceDiscoveryDetails:
description: 'This object is about to provide input params to update Multicloud Resource Discovery.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Multicloud Resource Discovery 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: Display name of the Multicloud Resource Discovery resource.
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
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
maxLength: 255
minLength: 1
type: string
resourceType:
description: Resource Type to discover.
type: string
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/resourceType'
type: object
MultiCloudResourceDiscoverySummaryCollection:
description: List of MultiCloudResourceDiscoverySummary resources.
properties:
items:
description: This list contains the summary of Multicloud Resource Discovery.
items:
$ref: '#/components/schemas/MultiCloudResourceDiscoverySummary'
type: array
required:
- items
type: object
Resources:
description: 'Discovered Resources.
'
properties:
id:
description: The ID of the Discovered Resource.
maxLength: 1024
minLength: 1
type: string
location:
description: Discovered Resource Location.
maxLength: 255
minLength: 1
type: string
name:
description: Discovered Resource Name.
maxLength: 255
minLength: 1
type: string
properties:
additionalProperties:
type: string
description: Discovered Resource's properties.
maxProperties: 20
type: object
resourceGroup:
description: Discovered Resource Group Name.
maxLength: 255
minLength: 1
type: string
type:
description: Discovered Resource Type.
maxLength: 255
minLength: 1
type: string
type: object
ChangeMultiCloudResourceDiscoveryCompartmentDetails:
description: Details of the new compartment to contain the Multicloud Resource Discovery.
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the new compartment that contains Multicloud Resource Discovery 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
MultiCloudResourceDiscoverySummary:
description: 'Multicloud Resource Discovery Summary.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Multicloud Resource Discovery 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: Display name of the Multicloud Resource Discovery resource.
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 Multicloud Resource Discovery resource
type: string
lastModification:
description: Description of the latest modification of the Multicloud Resource Discovery resource.
type: string
lifecycleState:
description: The current lifecycle state of the discovered resource.
type: string
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/lifecycleState'
lifecycleStateDetails:
description: Description of the current lifecycle state in more detail.
type: string
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
type: string
resourceType:
description: Resource Type to discover.
type: string
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/resourceType'
resources:
description: List of All Discovered Vaults and Keys for respective vaults.
items:
$ref: '#/components/schemas/Resources'
maxItems: 100
minItems: 0
type: array
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 Multicloud Discovery 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 Multicloud Discovery 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
CreateMultiCloudResourceDiscoveryDetails:
description: 'This object is about to provide input params to discover resource.
'
properties:
compartmentId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment that contains Multicloud Resource Discovery 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: Display name of the Multicloud Resource Discovery resource.
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
oracleDbConnectorId:
description: The [OCID](/Content/General/Concepts/identifiers.htm) of the Oracle DB Connector resource.
maxLength: 255
minLength: 1
type: string
resourceType:
description: Resource Type to discover.
type: string
x-obmcs-enumref: '#/definitions/MultiCloudResourceDiscovery/resourceType'
resourcesFilter:
additionalProperties:
type: string
description: 'Discover resource using attributes as key-value pair.
For GCP supported attributes (keyRing)
For Azure supported attributes (keyVault)
GCP Example
`{"keyRing": "projects/db-mc-dataplane/locations/global/keyRings/dbmci-keyring"}` or
`{"keyRing": "dbmci-keyring"}`
Azure Example
`{"keyVault": "/subscriptions/fd42b73d-5f28-4a23-ae7c-ca08c625fe07/resourceGroups/yumfei0808Test/providers/Microsoft.KeyVault/managedHSMs/orp7HSM001"}` or
`{"keyVault": "orp7HSM001"}`
'
type: object
required:
- compartmentId
- displayName
- oracleDbConnectorId
- resourceType
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