oracle.oci.oci_budget_facts – Fetches details about one or multiple Budget resources in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.5.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_budget_facts.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

Fetches details about one or multiple Budget resources in Oracle Cloud Infrastructure
Gets a list of budgets in a compartment.
By default, ListBudgets returns budgets of the ‘COMPARTMENT’ target type, and the budget records with only one target compartment OCID.
To list all budgets, set the targetType query parameter to ALL (for example: ‘targetType=ALL’).
Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.
If budget_id is specified, the details of a single Budget will be returned.

Requirements ¶

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

python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

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 security_token	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.
budget_id string		The unique budget OCID. Required to get a specific budget. aliases: id
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 budgets.
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`.
display_name string		A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource` aliases: name
lifecycle_state string	Choices: ACTIVE INACTIVE	The current state of the resource to filter by.
realm_specific_endpoint_template_enabled boolean	Choices: no yes	Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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. If not specified, the default is timeCreated. The default sort order for timeCreated is DESC. The default sort order for displayName is ASC in alphanumeric order.
sort_order string	Choices: ASC DESC	The sort order to use, either 'asc' or 'desc'.
target_type string	Choices: ALL COMPARTMENT TAG	The type of target to filter by: * ALL - List all budgets * COMPARTMENT - List all budgets with targetType == "COMPARTMENT" * TAG - List all budgets with targetType == "TAG"
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

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get a specific budget
  oci_budget_facts:
    # required
    budget_id: "ocid1.budget.oc1..xxxxxxEXAMPLExxxxxx"

- name: List budgets
  oci_budget_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    sort_order: ASC
    sort_by: timeCreated
    lifecycle_state: ACTIVE
    display_name: display_name_example
    target_type: ALL

Return Values ¶

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

Key		Returned	Description
budgets complex		on success	List of Budget resources Sample: [{'actual_spend': 10, 'alert_rule_count': 56, 'amount': 10, 'budget_processing_period_start_offset': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'end_date': '2013-10-20T19:20:30+01:00', 'forecasted_spend': 10, 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'processing_period_type': 'INVOICE', 'reset_period': 'MONTHLY', 'start_date': '2013-10-20T19:20:30+01:00', 'target_compartment_id': 'ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx', 'target_type': 'COMPARTMENT', 'targets': [], 'time_created': '2013-10-20T19:20:30+01:00', 'time_spend_computed': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'version': 56}]
	actual_spend float	on success	The actual spend in currency for the current budget cycle. Sample: 10
	alert_rule_count integer	on success	The total number of alert rules in the budget. Sample: 56
	amount float	on success	The amount of the budget expressed in the currency of the customer's rate card. Sample: 10
	budget_processing_period_start_offset integer	on success	The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight. Sample: 56
	compartment_id string	on success	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	defined_tags dictionary	on success	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` Sample: {'Operations': {'CostCenter': 'US'}}
	description string	on success	The description of the budget. Sample: description_example
	display_name string	on success	The display name of the budget. Avoid entering confidential information. Sample: display_name_example
	end_date string	on success	The time when the one-time budget concludes. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. Sample: 2013-10-20T19:20:30+01:00
	forecasted_spend float	on success	The forecasted spend in currency by the end of the current budget cycle. Sample: 10
	freeform_tags dictionary	on success	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: `{"Department": "Finance"}` Sample: {'Department': 'Finance'}
	id string	on success	The OCID of the budget. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	lifecycle_state string	on success	The current state of the budget. Sample: ACTIVE
	processing_period_type string	on success	The budget processing period type. Valid values are INVOICE, MONTH, and SINGLE_USE. Sample: INVOICE
	reset_period string	on success	The reset period for the budget. Sample: MONTHLY
	start_date string	on success	The date when the one-time budget begins. For example, `2023-03-23`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time. Sample: 2013-10-20T19:20:30+01:00
	target_compartment_id string	on success	This is DEPRECATED. For backwards compatability, the property is populated when the targetType is "COMPARTMENT", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty. Sample: ocid1.targetcompartment.oc1..xxxxxxEXAMPLExxxxxx
	target_type string	on success	The type of target on which the budget is applied. Sample: COMPARTMENT
	targets list / elements=string	on success	The list of targets on which the budget is applied. If the targetType is "COMPARTMENT", the targets contain the list of compartment OCIDs. If the targetType is "TAG", the targets contain the list of cost tracking tag identifiers in the form of "{tagNamespace}.{tagKey}.{tagValue}".
	time_created string	on success	The time that the budget was created. Sample: 2013-10-20T19:20:30+01:00
	time_spend_computed string	on success	The time that the budget spend was last computed. Sample: 2013-10-20T19:20:30+01:00
	time_updated string	on success	The time that the budget was updated. Sample: 2013-10-20T19:20:30+01:00
	version integer	on success	The version of the budget. Starts from 1 and increments by 1. Sample: 56

Authors¶

Oracle (@oracle)

oracle.oci.oci_budget_facts – Fetches details about one or multiple Budget resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶