search-associations

Description

Search associations in the given compartment based on the search criteria.

Usage

oci stack-monitoring resource search-associations [OPTIONS]

Required Parameters

--compartment-id, -c [text]

Compartment Identifier OCID.

Optional Parameters

--association-type [text]

Association type filter to search associated resources.

--destination-resource-id [text]

Destination Monitored Resource Identifier OCID.

--destination-resource-name [text]

Source Monitored Resource Name.

--destination-resource-type [text]

Source Monitored Resource Type.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--if-match [text]

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.

--limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for assocType is descending.

Accepted values are:

ASSOC_TYPE, TIME_CREATED
--sort-order [text]

The sort order to use, either ‘ASC’ or ‘DESC’.

Accepted values are:

ASC, DESC
--source-resource-id [text]

Source Monitored Resource Identifier OCID.

--source-resource-name [text]

Source Monitored Resource Name.

--source-resource-type [text]

Source Monitored Resource Type.

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/stack-monitoring/resource/search-associations.html#cmdoption-compartment-id

    oci stack-monitoring resource search-associations --compartment-id $compartment_id