list-ccd-offers

Description

Lists the CCD offers for the requested subscription. A FLEX offer is no longer returned after it is either accepted, rejected or expired.

Usage

oci ccd-offers ccd-offer-collection list-ccd-offers [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment (remember that the tenancy is simply the root compartment).

--subscription-id [text]

The subscription ID associated with the CCD offer.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--display-name [text]

Filter by the resource display name.

--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

--lifecycle-details [text]

The life cycle details of a CCD offer that’s being requested. The accepted values are Scheduled, Current, Canceled, or Ended. If a null or empty value is passed, it will return for all resources.

Accepted values are:

CANCELED, CURRENT, ENDED, SCHEDULED
--lifecycle-state [text]

The life cycle of a CCD offer that’s being requested, which always defaults to Active. If you want to filter by scheduled, current, canceled, or ended, use the lifecycleDetails query parameter.

Accepted values are:

ACTIVE
--limit [integer]

The maximum number of items to return in a paginated “List” call.

--page [text]

The value of the opc-next-page response header from the previous “List” call.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The sort by field to use, whether “DISPLAYNAME” or “TIMECREATED”. By default, it is TIMECREATED.

Accepted values are:

DISPLAYNAME, TIMECREATED
--sort-order [text]

The sort order to use, whether “asc” or “desc”. By default, it is ascending.

Accepted values are:

ASC, DESC
--source-type [text]

Filter CCD offers or commitments by the commercial workflow that created the associated offer.

Accepted values are:

CONTRACT_COMMITMENT, CONTRACT_OFFER, FLEX, OCI_GENERATED
--type-of-offer [text]

The CCD offer type to use when filtering results.

Accepted values are:

CONTRACTUAL, CUSTOM, FLEX, PRIVATE, STANDARD

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/ccd-offers/ccd-offer-collection/list-ccd-offers.html#cmdoption-compartment-id
    export subscription_id=<substitute-value-of-subscription_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ccd-offers/ccd-offer-collection/list-ccd-offers.html#cmdoption-subscription-id

    oci ccd-offers ccd-offer-collection list-ccd-offers --compartment-id $compartment_id --subscription-id $subscription_id