OracleDbAzureVaultClient¶

class oci.dbmulticloud.OracleDbAzureVaultClient(config, **kwargs)¶

Microsoft Azure: Oracle 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).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_oracle_db_azure_vault_compartment`(…)	Moves the DB Azure Vault resource into a different compartment.
`create_oracle_db_azure_vault`(…)	Creates DB Azure Vault resource.
`delete_oracle_db_azure_vault`(…)	Deletes the DB Azure Vault resource.
`get_oracle_db_azure_vault`(…)	Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource `OCID`__.
`list_oracle_db_azure_vaults`(compartment_id, …)	Lists all DB Azure Vault resources based on the specified filters.
`refresh_oracle_db_azure_vault`(…)	Refreshes the Oracle DB Azure Vault resource.
`update_oracle_db_azure_vault`(…)	Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique `OCID`__.

The supported method to install the Azure Arc Server (Azure Identity) on the Exadata VM cluster:

<ul>: <li>Using a Bearer Access Token</li>

</ul>

Oracle Azure Blob Container Resource:  The Oracle Azure Blob Container Resource is used to capture the details of an Azure Blob Container. This 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.

Oracle 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). It relies on both the Oracle Azure Connector and the Oracle Azure Blob Container Resource to perform the mount operation.

Discover 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.

Oracle 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.

Oracle 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.

Google Cloud: Oracle 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).

Discover 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.

Google 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.

Google 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.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_oracle_db_azure_vault_compartment(oracle_db_azure_vault_id, change_oracle_db_azure_vault_compartment_details, **kwargs)¶

Moves the DB Azure Vault resource into a different compartment. When provided, ‘If-Match’ is checked against ‘ETag’ values of the resource.

Parameters:	oracle_db_azure_vault_id (str) – (required) The `OCID`__ of the Oracle DB Azure Vault resource. change_oracle_db_azure_vault_compartment_details (oci.dbmulticloud.models.ChangeOracleDbAzureVaultCompartmentDetails) – (required) Moves the DB Azure Vault resource into a different compartment. opc_retry_token (str) – (optional) 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. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_oracle_db_azure_vault_compartment API.

create_oracle_db_azure_vault(create_oracle_db_azure_vault_details, **kwargs)¶

Creates DB Azure Vault resource.

Parameters:	create_oracle_db_azure_vault_details (oci.dbmulticloud.models.CreateOracleDbAzureVaultDetails) – (required) Details for to Create Oracle DB Azure Vault details. opc_retry_token (str) – (optional) 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. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OracleDbAzureVault`
Return type:	`Response`
Example:

Click here to see an example of how to use create_oracle_db_azure_vault API.

delete_oracle_db_azure_vault(oracle_db_azure_vault_id, **kwargs)¶

Deletes the DB Azure Vault resource.

Parameters:	oracle_db_azure_vault_id (str) – (required) The `OCID`__ of the Oracle DB Azure Vault resource. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_oracle_db_azure_vault API.

get_oracle_db_azure_vault(oracle_db_azure_vault_id, **kwargs)¶

Retrieves detailed information about an Oracle Database Azure Vault resource using its unique resource `OCID`__. This operation returns metadata and configuration details associated with the specified vault resource.

Parameters:	oracle_db_azure_vault_id (str) – (required) The `OCID`__ of the Oracle DB Azure Vault resource. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OracleDbAzureVault`
Return type:	`Response`
Example:

Click here to see an example of how to use get_oracle_db_azure_vault API.

list_oracle_db_azure_vaults(compartment_id, **kwargs)¶

Lists all DB Azure Vault resources based on the specified filters.

Parameters:	compartment_id (str) – (required) The `ID`__ of the compartment. display_name (str) – (optional) A filter to return Oracle DB Azure Vault resources that match the specified display name. oracle_db_azure_vault_id (str) – (optional) A filter to return Oracle DB Azure Vault resources that match the specified `OCID`__ of the Oracle DB Azure Vault resource. lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED” oracle_db_azure_resource_group (str) – (optional) A filter to return Oracle DB Azure Vault resources that match the specified Oracle DB Azure resource group name. oracle_db_azure_connector_id (str) – (optional) A filter to return Oracle DB Azure Azure Identity Connector resources. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. sort_order (str) – (optional) The sort order to use, either ‘asc’ or ‘desc’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) 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. Allowed values are: “timeCreated”, “displayName” opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OracleDbAzureVaultSummaryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_oracle_db_azure_vaults API.

refresh_oracle_db_azure_vault(oracle_db_azure_vault_id, **kwargs)¶

Refreshes the Oracle DB Azure Vault resource.

Parameters:	oracle_db_azure_vault_id (str) – (required) The `OCID`__ of the Oracle DB Azure Vault resource. refresh_oracle_db_azure_vault_details (oci.dbmulticloud.models.RefreshOracleDbAzureVaultDetails) – (optional) Details for to refresh Oracle DB Azure Vault resource. opc_retry_token (str) – (optional) 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. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use refresh_oracle_db_azure_vault API.

update_oracle_db_azure_vault(oracle_db_azure_vault_id, update_oracle_db_azure_vault_details, **kwargs)¶

Modifies the configuration details of an existing Oracle Database Azure Vault resource identified by its unique `OCID`__. This operation updates only the specified fields in the request body.

Parameters:	oracle_db_azure_vault_id (str) – (required) The `OCID`__ of the Oracle DB Azure Vault resource. update_oracle_db_azure_vault_details (oci.dbmulticloud.models.UpdateOracleDbAzureVaultDetails) – (required) Details for to update OracleDbAzureVault. if_match (str) – (optional) 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. opc_request_id (str) – (optional) The client request ID for tracing. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use update_oracle_db_azure_vault API.