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 Oracle DB Azure Blob Container 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: OracleDBAzureBlobContainer
paths:
/oracleDbAzureBlobContainer:
get:
description: 'Lists all Oracle DB Azure Blob Container resources based on the specified filters.
'
operationId: ListOracleDbAzureBlobContainers
parameters:
- $ref: '#/components/parameters/CompartmentIdQueryParam'
- $ref: '#/components/parameters/OracleAzureBlobContainerDisplayNameQueryParam'
- $ref: '#/components/parameters/OracleDbAzureBlobContainerIdQueryParam'
- $ref: '#/components/parameters/OracleDBAzureBlobContainerLifecycleStateQueryParam'
- $ref: '#/components/parameters/AzureStorageAccountName'
- $ref: '#/components/parameters/AzureStorageContainerName'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/SortByQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbAzureBlobContainerSummaryCollection 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/OracleDbAzureBlobContainerSummaryCollection'
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 Blob Container resources based on the specified filters.
tags:
- OracleDBAzureBlobContainer
x-example: 'GET /20240501/oracleDbAzureBlobContainer
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbAzureBlobContainer'
post:
description: 'Creates Oracle DB Azure Blob Container resource.
'
operationId: CreateOracleDbAzureBlobContainer
parameters:
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
201:
description: Install Arc Agent in OCI Database resource.
headers:
content-location:
description: URI of the resource
schema:
type: string
format: uri-reference
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
location:
description: URI of the resource
schema:
type: string
format: uri-reference
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
opc-work-request-id:
description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
Use GetWorkRequest with this ID to track the status of the request.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbAzureBlobContainer'
400:
$ref: '#/components/responses/400'
401:
$ref: '#/components/responses/401'
404:
$ref: '#/components/responses/404'
409:
$ref: '#/components/responses/409'
412:
$ref: '#/components/responses/412'
429:
$ref: '#/components/responses/429'
500:
$ref: '#/components/responses/500'
default:
$ref: '#/components/responses/default'
summary: Creates Oracle DB Azure Blob Container resource.
tags:
- OracleDBAzureBlobContainer
x-example: "POST /20240501/oracleDbAzureBlobContainer\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestDBAzureBlobContainerUpdated\" ,\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"azureStorageAccountName\": \"ADBDAppStorageAccount\",\n \"azureStorageContainerName\": \"ADBDContainer\",\n \"privateEndpointIpAddress\": \"196.168.0.1\",\n \"privateEndpointDnsAlias\": \"test.oracle.com\",\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/OracleDbAzureBlobContainer'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOracleDbAzureBlobContainerDetails'
description: Details for to mount Azure Container in OCI Database resource.
required: true
/oracleDbAzureBlobContainer/{oracleDbAzureBlobContainerId}:
delete:
description: 'Delete Oracle DB Azure Blob Container resource.
'
operationId: DeleteOracleDbAzureBlobContainer
parameters:
- $ref: '#/components/parameters/OracleDbAzureBlobContainerIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: "Accepted the request, The Oracle DB Azure Blob Container resource object will be deleted \nand Azure Container will be unmounted from OCI Database resource.\n"
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: Delete Oracle DB Azure Blob Container resource.
tags:
- OracleDBAzureBlobContainer
x-example: 'DELETE /20240501/oracleDbAzureBlobContainer/<oracleDbAzureBlobContainerId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbAzureBlobContainer'
get:
description: 'Retrieves the details of an Oracle DB–associated Azure Blob Container using the specified container resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: GetOracleDbAzureBlobContainer
parameters:
- $ref: '#/components/parameters/OracleDbAzureBlobContainerIdPathParam'
- $ref: '#/components/parameters/PaginationLimitQueryParam'
- $ref: '#/components/parameters/PaginationTokenQueryParam'
- $ref: '#/components/parameters/SortOrderQueryParam'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
200:
description: Returns OracleDbAzureBlobContainer object.
headers:
etag:
description: 'For optimistic concurrency control. See `if-match`.
'
schema:
type: string
opc-request-id:
description: 'Unique Oracle-assigned identifier for the request. If you need to contact
Oracle about a particular request, please provide the request ID.
'
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/OracleDbAzureBlobContainer'
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 details of an Oracle DB–associated Azure Blob Container using the specified container resource [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- OracleDBAzureBlobContainer
x-example: 'GET /20240501/oracleDbAzureBlobContainer/<oracleDbAzureBlobContainerId>
Host: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com
<authorization and other headers>
'
x-related-resource: '#/definitions/OracleDbAzureBlobContainer'
put:
description: 'Modifies the existing Oracle DB Azure Blob Container resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
'
operationId: UpdateOracleDbAzureBlobContainer
parameters:
- $ref: '#/components/parameters/OracleDbAzureBlobContainerIdPathParam'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle DB Azure Blob Container 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 Blob Container resource for a given [OCID](/iaas/Content/General/Concepts/identifiers.htm).
tags:
- OracleDBAzureBlobContainer
x-example: "PUT /20240501/oracleDbAzureBlobContainer/<oracleDbAzureBlobContainerId>\nHost: multi-cloud-db.us-ashburn-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\": \"TestDBAzureBlobContainerUpdated\" ,\n \"compartmentId\": \"ocid1.compartment.oc1..\",\n \"azureStorageAccountName\": \"ADBDAppStorageAccount\",\n \"azureStorageContainerName\": \"ADBDContainer\",\n \"privateEndpointIpAddress\": \"196.168.0.1\",\n \"privateEndpointDnsAlias\": \"test.oracle.com\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleStateDetails\": null,\n \"timeCreated\": \"2024-02-09T06:31:16.380Z\",\n \"timeUpdated\": \"1970-01-01T00:00:00.000Z\",\n \"lastModification\": null,\n \"freeformTags\": {\n \"TestFreeFromTag\": \"TestFreeFromTagValue\"\n }\n}\n"
x-related-resource: '#/definitions/OracleDbAzureBlobContainer'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOracleDbAzureBlobContainerDetails'
description: Details for to update OracleDbAzureBlobContainer.
required: true
/oracleDbAzureBlobContainer/{oracleDbAzureBlobContainerId}/actions/changeCompartment:
post:
description: Moves the Oracle DB Azure Blob Container resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
operationId: ChangeOracleDbAzureBlobContainerCompartment
parameters:
- $ref: '#/components/parameters/OracleDbAzureBlobContainerIdPathParam'
- $ref: '#/components/parameters/RetryTokenHeader'
- $ref: '#/components/parameters/IfMatchHeader'
- $ref: '#/components/parameters/RequestIdHeader'
responses:
202:
description: Accepted the request. The Oracle DB Azure Blob Container 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 Blob Container resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.
tags:
- OracleDBAzureBlobContainer
x-example: "POST /20240501/oracleDbAzureBlobContainer/<oracleDbAzureBlobContainerId>/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/OracleDbAzureBlobContainer'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeOracleDbAzureBlobContainerCompartmentDetails'
description: Moves the DB Azure Blob Container resource into a different compartment.
required: true
components:
schemas:
CreateOracleDbAzureBlobContainerDetails:
description: 'Create Oracle DB Azure Blob Container object.
'
properties:
azureStorageAccountName:
description: Azure Storage account name.
maxLength: 255
minLength: 1
type: string
azureStorageContainerName:
description: Azure Storage container name.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of Oracle DB Azure Blob Container resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Azure Blob Container 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
- azureStorageAccountName
- azureStorageContainerName
type: object
UpdateOracleDbAzureBlobContainerDetails:
description: 'Oracle DB Azure Blob Container resource''s update object.
'
properties:
azureStorageAccountName:
description: Azure Storage account name.
maxLength: 255
minLength: 1
type: string
azureStorageContainerName:
description: Azure Storage container name.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Blob Container resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Azure Blob Container 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
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
OracleDbAzureBlobContainerSummaryCollection:
description: Oracle DB Azure Blob Container change compartment object.
properties:
items:
description: This list contains the summary of Oracle DB Azure Blob Container resources.
items:
$ref: '#/components/schemas/OracleDbAzureBlobContainerSummary'
type: array
required:
- items
type: object
OracleDbAzureBlobContainer:
description: 'Oracle DB Azure Blob Container resource object.
'
properties:
azureStorageAccountName:
description: Azure Storage account name.
maxLength: 255
minLength: 1
type: string
azureStorageContainerName:
description: Azure Storage container name.
maxLength: 255
minLength: 1
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of of the compartment that contains Oracle DB Azure Blob Container resource.
maxLength: 255
minLength: 1
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Azure Blob Container 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 Oracle DB Azure Blob Container resource.
maxLength: 255
minLength: 1
type: string
lastModification:
description: Description of the latest modification of the Oracle DB Azure Blob Container resource.
maxLength: 1024
minLength: 1
type: string
lifecycleState:
description: The current lifecycle state of the Oracle DB Azure Blob Container 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 Blob Container was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB Azure Blob Container 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
- azureStorageAccountName
- azureStorageContainerName
type: object
OracleDbAzureBlobContainerSummary:
description: 'Oracle DB Azure Blob Container resource''s summary object.
'
properties:
azureStorageAccountName:
description: Azure Storage account name.
type: string
azureStorageContainerName:
description: Azure Storage container name.
type: string
compartmentId:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment contains Oracle DB Azure Blob Container resource.
type: string
definedTags:
additionalProperties:
additionalProperties:
description: 'The value of the tag. Only the String type is supported.
'
type: object
description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.
Example: `{"CostCenter": "42"}`
'
type: object
description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
Example: `{"Operations": {"CostCenter": "42"}}`
'
type: object
displayName:
description: Oracle DB Azure Blob Container 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 DB Azure Blob Container resource.
type: string
lastModification:
description: Description of the latest modification of the Oracle DB Azure Blob Container resource.
type: string
lifecycleState:
description: The current lifecycle state of the DB Azure Blob Container resource.
type: string
x-obmcs-enumref: '#/definitions/OracleDbAzureBlobContainer/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 Blob Container was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format, e.g. ''2020-05-22T21:10:29.600Z''
'
format: date-time
type: string
timeUpdated:
description: 'Time when the Oracle DB Azure Blob Container 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
ChangeOracleDbAzureBlobContainerCompartmentDetails:
description: Details of the new compartment to contain the Oracle DB Azure Blob Container resource.
properties:
compartmentId:
description: he [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the Oracle DB Azure Blob Container 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
parameters:
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
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
OracleAzureBlobContainerDisplayNameQueryParam:
description: A filter to return Oracle DB Azure Blob Container resources that match the specified display name.
in: query
name: displayName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
OracleDbAzureBlobContainerIdQueryParam:
description: A filter to return Oracle DB Azure Blob Container resource.
in: query
name: oracleDbAzureBlobContainerId
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
OracleDbAzureBlobContainerIdPathParam:
description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Oracle DB Azure Blob Container resource.
in: path
name: oracleDbAzureBlobContainerId
required: true
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
PaginationLimitQueryParam:
description: The maximum number of items to return.
in: query
name: limit
x-default-description: 'null'
schema:
type: integer
default: 10
maximum: 1000
minimum: 1
SortOrderQueryParam:
description: The sort order to use, either 'asc' or 'desc'.
in: query
name: sortOrder
x-default-description: 'null'
x-obmcs-top-level-enum: '#/definitions/SortOrder'
schema:
type: string
enum:
- ASC
- DESC
default: DESC
OracleDBAzureBlobContainerLifecycleStateQueryParam:
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/OracleDbAzureBlobContainer/lifecycleState'
schema:
type: string
AzureStorageAccountName:
description: A filter to return Oracle DB Azure Blob Container resources that match the specified Azure Account name.
in: query
name: azureStorageAccountName
x-default-description: 'null'
schema:
type: string
maxLength: 255
minLength: 1
RetryTokenHeader:
description: 'A token that uniquely identifies a request, allowing it to be safely retried in the event of a timeout or server error without the risk of the action being executed more than once.
Retry tokens expire after 24 hours but can be invalidated sooner if conflicting operations occur.
For example, if a resource has been deleted and permanently purged from the system, a retry of the original creation request may be rejected.
'
in: header
name: opc-retry-token
required: false
schema:
type: string
maxLength: 64
minLength: 1
AzureStorageContainerName:
description: A filter to return Oracle DB Azure Blob Container resources that match the specified Azure Storage name.
in: query
name: azureStorageContainerName
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
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