oracle.oci.oci_ai_anomaly_detection_data_asset_facts – Fetches details about one or multiple DataAsset resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.14.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_ai_anomaly_detection_data_asset_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple DataAsset resources in Oracle Cloud Infrastructure

  • Returns a list of DataAssets.

  • If data_asset_id is specified, the details of a single DataAsset will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The ID of the compartment in which to list resources.
Required to list multiple data_assets.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
data_asset_id
string
The OCID of the Data Asset.
Required to get a specific data_asset.

aliases: id
display_name
string
A filter to return only resources that match the entire display name given.

aliases: name
lifecycle_state
string
    Choices:
  • ACTIVE
  • DELETED
<b>Filter</b> results by the specified lifecycle state. Must be a valid state for the resource type.
project_id
string
The ID of the project for which to list the objects.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • timeCreated
  • displayName
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 timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Get a specific data_asset
  oci_ai_anomaly_detection_data_asset_facts:
    # required
    data_asset_id: "ocid1.dataasset.oc1..xxxxxxEXAMPLExxxxxx"

- name: List data_assets
  oci_ai_anomaly_detection_data_asset_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    project_id: "ocid1.project.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    lifecycle_state: ACTIVE
    sort_order: ASC
    sort_by: timeCreated

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data_assets
complex
on success
List of DataAsset resources

Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'data_source_details': {'atp_password_secret_id': 'ocid1.atppasswordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'atp_user_name': 'atp_user_name_example', 'bucket_name': 'bucket_name_example', 'cwallet_file_secret_id': 'ocid1.cwalletfilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'data_source_type': 'ORACLE_OBJECT_STORAGE', 'database_name': 'database_name_example', 'ewallet_file_secret_id': 'ocid1.ewalletfilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'key_store_file_secret_id': 'ocid1.keystorefilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'measurement_name': 'measurement_name_example', 'namespace': 'namespace_example', 'object_name': 'object_name_example', 'ojdbc_file_secret_id': 'ocid1.ojdbcfilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx', 'table_name': 'table_name_example', 'tnsnames_file_secret_id': 'ocid1.tnsnamesfilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'truststore_file_secret_id': 'ocid1.truststorefilesecret.oc1..xxxxxxEXAMPLExxxxxx', 'url': 'url_example', 'user_name': 'user_name_example', 'version_specific_details': {'bucket_name': 'bucket_name_example', 'database_name': 'database_name_example', 'influx_version': 'V_1_8', 'organization_name': 'organization_name_example', 'retention_policy_name': 'retention_policy_name_example'}, 'wallet_password_secret_id': 'ocid1.walletpasswordsecret.oc1..xxxxxxEXAMPLExxxxxx'}, 'data_source_type': 'ORACLE_OBJECT_STORAGE', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'private_endpoint_id': 'ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx', 'project_id': 'ocid1.project.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}]
 
compartment_id
string
on success
The OCID of the compartment containing the DataAsset.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
data_source_details
complex
on success
Returned for get operation

   
atp_password_secret_id
string
on success
atp db password Secret Id

Sample:
ocid1.atppasswordsecret.oc1..xxxxxxEXAMPLExxxxxx
   
atp_user_name
string
on success
atp db user name

Sample:
atp_user_name_example
   
bucket_name
string
on success
Object storage bucket name

Sample:
bucket_name_example
   
cwallet_file_secret_id
string
on success
OCID of the secret containing the containers certificates of ATP wallet

Sample:
ocid1.cwalletfilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
data_source_type
string
on success
Data source type where actually data asset is being stored

Sample:
ORACLE_OBJECT_STORAGE
   
database_name
string
on success
atp database name

Sample:
database_name_example
   
ewallet_file_secret_id
string
on success
OCID of the secret containing the PDB'S certificates of ATP wallet

Sample:
ocid1.ewalletfilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
key_store_file_secret_id
string
on success
OCID of the secret containing Keystore.jks file of the ATP wallet

Sample:
ocid1.keystorefilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
measurement_name
string
on success
Measurement name for influx

Sample:
measurement_name_example
   
namespace
string
on success
Object storage namespace

Sample:
namespace_example
   
object_name
string
on success
File name

Sample:
object_name_example
   
ojdbc_file_secret_id
string
on success
OCID of the secret that contains jdbc properties file of ATP wallet

Sample:
ocid1.ojdbcfilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
password_secret_id
string
on success
Password Secret Id for the influx connection

Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
   
table_name
string
on success
atp database table name

Sample:
table_name_example
   
tnsnames_file_secret_id
string
on success
OCID of the secret that contains the tnsnames file of ATP wallet

Sample:
ocid1.tnsnamesfilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
truststore_file_secret_id
string
on success
OCID of the secret containing truststore.jks file of the ATP wallet

Sample:
ocid1.truststorefilesecret.oc1..xxxxxxEXAMPLExxxxxx
   
url
string
on success
public IP address and port to influx DB

Sample:
url_example
   
user_name
string
on success
Username for connection to Influx

Sample:
user_name_example
   
version_specific_details
complex
on success

     
bucket_name
string
on success
Bucket Name for influx connection

Sample:
bucket_name_example
     
database_name
string
on success
DB Name for influx connection

Sample:
database_name_example
     
influx_version
string
on success
Data source type where actually data asset is being stored

Sample:
V_1_8
     
organization_name
string
on success
Org name for the influx db

Sample:
organization_name_example
     
retention_policy_name
string
on success
retention policy is how long the bucket would last

Sample:
retention_policy_name_example
   
wallet_password_secret_id
string
on success
wallet password Secret ID in String format

Sample:
ocid1.walletpasswordsecret.oc1..xxxxxxEXAMPLExxxxxx
 
data_source_type
string
on success
Data source type where actually data asset is being stored
Returned for list operation

Sample:
ORACLE_OBJECT_STORAGE
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A short description of the data asset.

Sample:
description_example
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The Unique Oracle ID (OCID) that is immutable on creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The lifecycle state of the Data Asset.

Sample:
ACTIVE
 
private_endpoint_id
string
on success
OCID of Private Endpoint.

Sample:
ocid1.privateendpoint.oc1..xxxxxxEXAMPLExxxxxx
 
project_id
string
on success
The Unique project id which is created at project creation that is immutable on creation.

Sample:
ocid1.project.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The time the the DataAsset was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the the DataAsset was updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)