oracle.oci.oci_data_connectivity_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.11.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_data_connectivity_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

  • Retrieves a list of all data asset summaries.

  • If data_asset_key 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.
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_key
string
The data asset key.
Required to get a specific data_asset.
endpoint_ids
list / elements=string
Endpoint IDs used for data-plane APIs to filter or prefer specific endpoint.
exclude_endpoint_ids
list / elements=string
Endpoints which will be excluded while listing data assets.
exclude_types
list / elements=string
The types that will be excluded from the list of data assets/connections.
favorites_query_param
string
    Choices:
  • FAVORITES_ONLY
  • NON_FAVORITES_ONLY
  • ALL
If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL.
fields
list / elements=string
Specifies the fields to get for an object.
folder_id
string
Unique key of the folder.
include_types
list / elements=string
Artifact type which needs to be listed while listing Artifacts.
name
string
Used to filter by the name of the object.
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.
registry_id
string / required
The registry OCID.
sort_by
string
    Choices:
  • id
  • timeCreated
  • displayName
Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order are by relevance score in descending order).
sort_order
string
    Choices:
  • ASC
  • DESC
Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).
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_data_connectivity_data_asset_facts:
    # required
    data_asset_key: data_asset_key_example
    registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"

- name: List data_assets
  oci_data_connectivity_data_asset_facts:
    # required
    registry_id: "ocid1.registry.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    fields: [ "fields_example" ]
    include_types: [ "include_types_example" ]
    sort_by: id
    sort_order: ASC
    name: name_example
    exclude_types: [ "exclude_types_example" ]
    favorites_query_param: FAVORITES_ONLY
    folder_id: "ocid1.folder.oc1..xxxxxxEXAMPLExxxxxx"
    endpoint_ids: [ "endpoint_ids_example" ]
    exclude_endpoint_ids: [ "exclude_endpoint_ids_example" ]

Authors

  • Oracle (@oracle)

There were some errors parsing the documentation for this plugin. Please file a bug with the collection.

The errors were:

  • Unable to normalize oci_data_connectivity_data_asset_facts: return due to: 12 validation errors for PluginReturnSchema
    return -> data_assets -> contains -> end_points -> contains -> data_assets -> contains -> default_connection -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> end_points -> contains -> data_assets -> contains -> metadata -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> end_points -> contains -> data_assets -> contains -> native_type_system -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> end_points -> contains -> data_assets -> contains -> registry_metadata -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> config_definition -> contains -> parent_ref -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> elements -> contains -> fields -> contains -> config_values -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> elements -> contains -> fields -> contains -> parent_ref -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> parent_type -> contains -> config_definition -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> parent_type -> contains -> parent_ref -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> parent_type -> contains -> parent_type -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> schema -> contains -> parent_ref -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)
    return -> data_assets -> contains -> native_type_system -> contains -> types -> contains -> config_definition -> contains -> config_parameter_definitions -> contains -> parameter_type -> contains -> wrapped_type -> contains -> parent_ref -> type
      string does not match regex "^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$" (type=value_error.str.regex; pattern=^(any|bits|bool|bytes|complex|dict|float|int|json|jsonarg|list|path|sid|str|pathspec|pathlist)$)