OracleDbAzureVaultClient

class oci.dbmulticloud.OracleDbAzureVaultClient(config, **kwargs)
  1. Oracle Azure Connector Resource: This is for installing Azure Arc Server in ExaCS VM Cluster.

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(…) Create DB Azure Vaults based on the provided information, this will fetch Keys related to Azure Vaults.
delete_oracle_db_azure_vault(…) Delete DB Azure Vault details.
get_oracle_db_azure_vault(…) Get Oracle DB Azure Vault Details form a particular Container Resource ID.
list_oracle_db_azure_vaults(compartment_id, …) Lists the all DB Azure Vaults based on filters.
refresh_oracle_db_azure_vault(…) Refresh Oracle DB Azure Vault details from backend.
update_oracle_db_azure_vault(…) Modifies the existing Oracle DB Azure Vault Details for a given ID.
There are two way to install Azure Arc Server (Azure Identity) in ExaCS VMCluster.
  1. Using Bearer Access Token or
  2. By providing Authentication token
  1. Oracle Azure Blob Container Resource: This is for to capture Azure Container details and same will be used in multiple ExaCS VMCluster to mount the Azure Container.
  2. Oracle Azure Blob Mount Resource: This is for to mount Azure Container in ExaCS VMCluster using Oracle Azure Connector and Oracle Azure Blob Container Resource.
__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 ID 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 so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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)

Create DB Azure Vaults based on the provided information, this will fetch Keys related to Azure Vaults.

Parameters:
  • create_oracle_db_azure_vault_details (oci.dbmulticloud.models.CreateOracleDbAzureVaultDetails) – (required) Details for to Create DB Azure Vault Details.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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)

Delete DB Azure Vault details.

Parameters:
  • oracle_db_azure_vault_id (str) – (required) The ID 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)

Get Oracle DB Azure Vault Details form a particular Container Resource ID.

Parameters:
  • oracle_db_azure_vault_id (str) – (required) The ID 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 the all DB Azure Vaults based on filters.

Parameters:
  • compartment_id (str) –

    (required) The ID of the compartment.

  • display_name (str) – (optional) A filter to return Azure Vaults.
  • oracle_db_azure_vault_id (str) – (optional) A filter to return Oracle DB Azure Vault Resources.
  • 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 Azure Vaults.
  • oracle_db_azure_connector_id (str) – (optional) A filter to return Oracle DB Azure Blob Mount 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)

Refresh Oracle DB Azure Vault details from backend.

Parameters:
  • oracle_db_azure_vault_id (str) – (required) The ID of the Oracle DB Azure Vault Resource.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might 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 existing Oracle DB Azure Vault Details for a given ID.

Parameters:
  • oracle_db_azure_vault_id (str) – (required) The ID 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.