Class: OCI::Dbmulticloud::OracleDbAzureKeyClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dbmulticloud/oracle_db_azure_key_client.rb

Overview

Microsoft Azure:
Oracle Azure Connector Resource::&nbsp;&nbsp;The Oracle Azure Connector Resource is used to install the Azure Arc Server on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). 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:&nbsp;&nbsp;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:&nbsp;&nbsp;The Oracle Azure Blob Mount Resource is used to mount an Azure Blob Container on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D). 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:&nbsp;&nbsp;The Discover Oracle Azure Vaults and Azure Keys Resource is used to discover Azure Vaults and the associated encryption keys available in your Azure project.

Oracle Azure Vault:&nbsp;&nbsp;The Oracle Azure Vault Resource is used to manage Azure Vaults within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

Oracle Azure Key:&nbsp;&nbsp;Oracle Azure Key Resource is used to register and manage a Oracle Azure Key Key within Oracle Cloud Infrastructure (OCI) under an associated Azure Vault.


Google Cloud:
Oracle Google Cloud Connector Resource:&nbsp;&nbsp;The Oracle Google Cloud Connector Resource is used to install the Google Cloud Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

Discover Google Key Rings and Keys Resource:&nbsp;&nbsp;The Discover Google Key Rings and Keys Resource is used to discover Google Cloud Key Rings and the associated encryption keys available in your Google Cloud project.

Google Key Rings Resource:&nbsp;&nbsp;The Google Key Rings Resource is used to register and manage Google Cloud Key Rings within Oracle Cloud Infrastructure (OCI) for use with services such as Oracle Exadata Database Service on Dedicated Infrastructure.

Google Key Resource:&nbsp;&nbsp;The Google Key Resource is used to register and manage a Google Cloud Key within Oracle Cloud Infrastructure (OCI) under an associated Google Key Ring.

AWS:
Oracle AWS Connector Resource:&nbsp;&nbsp;The Oracle AWS Connector Resource is used to install the AWS Identity Connector on an Exadata VM cluster in Oracle Exadata Database Service on Dedicated Infrastructure (ExaDB-D).

Oracle AWS Key Resource:&nbsp;&nbsp;The Oracle AWS Key Resource is used to register and manage a AWS Key within Oracle Cloud Infrastructure (OCI).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ OracleDbAzureKeyClient

Creates a new OracleDbAzureKeyClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • endpoint (String) (defaults to: nil) —

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 89

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20240501'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "OracleDbAzureKeyClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



49
50
51
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 49

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 53

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 63

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



59
60
61
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 59

def retry_config
  @retry_config
end

Instance Method Details

#get_oracle_db_azure_key(oracle_db_azure_key_id, opts = {}) ⇒ Response

Note:

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

Retrieves detailed information about a Oracle DB Azure Key resource by specifying its unique resource OCID.

Parameters:

  • oracle_db_azure_key_id (String) —

    The OCID of the Oracle DB Azure Vault Key resource.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 149

def get_oracle_db_azure_key(oracle_db_azure_key_id, opts = {})
  logger.debug 'Calling operation OracleDbAzureKeyClient#get_oracle_db_azure_key.' if logger

  raise "Missing the required parameter 'oracle_db_azure_key_id' when calling get_oracle_db_azure_key." if oracle_db_azure_key_id.nil?

  if opts[:sort_order] && !OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'oracle_db_azure_key_id' must not be blank" if OCI::Internal::Util.blank_string?(oracle_db_azure_key_id)

  path = '/oracleDbAzureKey/{oracleDbAzureKeyId}'.sub('{oracleDbAzureKeyId}', oracle_db_azure_key_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OracleDbAzureKeyClient#get_oracle_db_azure_key') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dbmulticloud::Models::OracleDbAzureKey'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_oracle_db_azure_keys(compartment_id, opts = {}) ⇒ Response

Note:

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

Lists all Oracle DB Azure Keys based on the specified filters.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :display_name (String) —

    A filter to return Oracle DB Azure Vault Keys resources that match the specified display name.

  • :oracle_db_azure_vault_id (String) —

    A filter to return Oracle DB Azure Vault resources that match the specified OCID of the Oracle DB Azure Vault resource.

  • :oracle_db_azure_key_id (String) —

    A filter to return Oracle DB Azure Vault Keys resource that match the specified Oracle DB Azure Key OCID.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC)

  • :sort_by (String) —

    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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 222

def list_oracle_db_azure_keys(compartment_id, opts = {})
  logger.debug 'Calling operation OracleDbAzureKeyClient#list_oracle_db_azure_keys.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_oracle_db_azure_keys." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::Dbmulticloud::Models::OracleDbAzureKey::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Dbmulticloud::Models::OracleDbAzureKey::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::Dbmulticloud::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/oracleDbAzureKey'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:oracleDbAzureVaultId] = opts[:oracle_db_azure_vault_id] if opts[:oracle_db_azure_vault_id]
  query_params[:oracleDbAzureKeyId] = opts[:oracle_db_azure_key_id] if opts[:oracle_db_azure_key_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'OracleDbAzureKeyClient#list_oracle_db_azure_keys') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dbmulticloud::Models::OracleDbAzureKeySummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



128
129
130
 
# File 'lib/oci/dbmulticloud/oracle_db_azure_key_client.rb', line 128

def logger
  @api_client.config.logger
end