unified_agent_configurations

Creates, updates, deletes, gets or lists an unified_agent_configurations resource.

Overview

Name	unified_agent_configurations
Type	Resource
Id	oci.logging.unified_agent_configurations

Fields

The following fields are returned by SELECT queries:

get

Unified agent configuration.

Name	Datatype	Description
id	string	The OCID of the resource.
compartmentId	string	The OCID of the compartment that the resource belongs to.
configurationState	string	State of unified agent service configuration. (VALID, INVALID) (x-obmcs-top-level-enum: #/definitions/UnifiedAgentServiceConfigurationStates)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
description	string	Description for this resource.
displayName	string	The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
freeformTags	object	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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
groupAssociation	object	Groups using the configuration.
isEnabled	boolean	Whether or not this resource is currently enabled.
lifecycleState	string	The pipeline state. (CREATING, ACTIVE, UPDATING, INACTIVE, DELETING, FAILED) (x-obmcs-top-level-enum: #/definitions/LogLifecycleState)
serviceConfiguration	object	Top level Unified Agent service configuration object.
timeCreated	string (date-time)	Time the resource was created.
timeLastModified	string (date-time)	Time the resource was last modified.

list

The list is being retrieved.

Name	Datatype	Description
id	string	The OCID of the resource.
compartmentId	string	The OCID of the compartment that the resource belongs to.
configurationState	string	State of unified agent service configuration. (VALID, INVALID) (x-obmcs-top-level-enum: #/definitions/UnifiedAgentServiceConfigurationStates)
configurationType	string	Type of Unified Agent service configuration. (LOGGING) (x-obmcs-top-level-enum: #/definitions/UnifiedAgentServiceConfigurationTypes)
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
description	string	Description for this resource.
displayName	string	The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
freeformTags	object	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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isEnabled	boolean	Whether or not this resource is currently enabled.
lifecycleState	string	The pipeline state. (CREATING, ACTIVE, UPDATING, INACTIVE, DELETING, FAILED) (x-obmcs-top-level-enum: #/definitions/LogLifecycleState)
timeCreated	string (date-time)	Time the resource was created.
timeLastModified	string (date-time)	Time the resource was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	unifiedAgentConfigurationId, region	opc-request-id	Get the unified agent configuration for an ID.
list	select	compartmentId, region	logId, isCompartmentIdInSubtree, groupId, displayName, lifecycleState, limit, page, sortBy, sortOrder, opc-request-id	Lists all unified agent configurations in the specified compartment.
create	insert	region, isEnabled, compartmentId, serviceConfiguration	opc-request-id, opc-retry-token	Create unified agent configuration registration.
update	update	unifiedAgentConfigurationId, region, displayName, isEnabled, serviceConfiguration	if-match, opc-request-id	Update an existing unified agent configuration. This call<br /> fails if the log group does not exist.<br />
delete	delete	unifiedAgentConfigurationId, region	opc-request-id, if-match	Delete unified agent configuration.
change_compartment	exec	unifiedAgentConfigurationId, region	opc-retry-token, if-match, opc-request-id	Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.<br />For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	Compartment OCID to list resources in. See compartmentIdInSubtree for nested compartments traversal.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
unifiedAgentConfigurationId	string	The OCID of the Unified Agent configuration.
displayName	string	Resource name.
groupId	string	The OCID of a group or a dynamic group.
if-match	string	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.
isCompartmentIdInSubtree	boolean	Specifies whether or not nested compartments should be traversed. Defaults to false.
lifecycleState	string	Lifecycle state of the log object
limit	integer	When setting the page limit, specifies the maximum number of unfiltered records that can be fetched from the data store in one request. Filtering happens after the records are retrieved. Subsequent pages might include results that match the query criteria.
logId	string	Custom log OCID to list resources with the log as destination.
opc-request-id	string	Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	For list pagination. The value of the opc-next-page or opc-previous-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by (one column only). Default sort order is ascending exception of timeCreated and timeLastModified columns (descending).
sortOrder	string	The sort order to use, whether 'asc' or 'desc'.

SELECT examples

get

Get the unified agent configuration for an ID.

SELECT
id,
compartmentId,
configurationState,
definedTags,
description,
displayName,
freeformTags,
groupAssociation,
isEnabled,
lifecycleState,
serviceConfiguration,
timeCreated,
timeLastModified
FROM oci.logging.unified_agent_configurations
WHERE unifiedAgentConfigurationId = '{{ unifiedAgentConfigurationId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists all unified agent configurations in the specified compartment.

SELECT
id,
compartmentId,
configurationState,
configurationType,
definedTags,
description,
displayName,
freeformTags,
isEnabled,
lifecycleState,
timeCreated,
timeLastModified
FROM oci.logging.unified_agent_configurations
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND logId = '{{ logId }}'
AND isCompartmentIdInSubtree = '{{ isCompartmentIdInSubtree }}'
AND groupId = '{{ groupId }}'
AND displayName = '{{ displayName }}'
AND lifecycleState = '{{ lifecycleState }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Create unified agent configuration registration.

INSERT INTO oci.logging.unified_agent_configurations (
compartmentId,
definedTags,
description,
displayName,
freeformTags,
groupAssociation,
isEnabled,
serviceConfiguration,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}',
'{{ freeformTags }}',
'{{ groupAssociation }}',
{{ isEnabled }} /* required */,
'{{ serviceConfiguration }}' /* required */,
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

Manifest

# Description fields are for documentation purposes
- name: unified_agent_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the unified_agent_configurations resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that the resource belongs to.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: description
    value: "{{ description }}"
    description: |
      Description for this resource.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The user-friendly display name. This must be unique within the enclosing resource,
      and it's changeable. Avoid entering confidential information.
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: groupAssociation
    description: |
      Groups using the configuration.
    value:
      groupList:
        - "{{ groupList }}"
  - name: isEnabled
    value: {{ isEnabled }}
    description: |
      Whether or not this resource is currently enabled.
    default: true
  - name: serviceConfiguration
    description: |
      Top level Unified Agent service configuration object.
    value:
      configurationType: "{{ configurationType }}"
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: 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 (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

UPDATE examples

update

Update an existing unified agent configuration. This call<br /> fails if the log group does not exist.<br />

UPDATE oci.logging.unified_agent_configurations
SET 
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
groupAssociation = '{{ groupAssociation }}',
isEnabled = {{ isEnabled }},
serviceConfiguration = '{{ serviceConfiguration }}'
WHERE 
unifiedAgentConfigurationId = '{{ unifiedAgentConfigurationId }}' --required
AND region = '{{ region }}' --required
AND displayName = '{{ displayName }}' --required
AND isEnabled = {{ isEnabled }} --required
AND serviceConfiguration = '{{ serviceConfiguration }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}';

DELETE examples

delete

Delete unified agent configuration.

DELETE FROM oci.logging.unified_agent_configurations
WHERE unifiedAgentConfigurationId = '{{ unifiedAgentConfigurationId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.<br />For information about moving resources between compartments, see [Moving Resources Between Compartments](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />

EXEC oci.logging.unified_agent_configurations.change_compartment 
@unifiedAgentConfigurationId='{{ unifiedAgentConfigurationId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;