submit-subscription-usage-batch

Description

Asynchronously submits a UTF-8 CSV usage file for marketplace offers. The file must not exceed 50 MB or 10,000 rows and must include required usage columns.

Usage

oci self partner-integeration create-subscription-usage-record-details submit-subscription-usage-batch [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment associated with the usage records request.

--submit-subscription-usage-batch-details [text]

UTF-8 CSV file with no more than 10,000 usage records and a maximum size of 50 MB. Required columns are MarketplaceOfferId, Id, Amount, CurrencyCode, UsageStartTime, UsageEndTime, and UsageDimensionName. Optional columns are ConsumedQuantity, CustomerTenancyId, BillingIdentifier, ProductSku, UnitOfMeasure, UnitPrice, ContractDuration, and AdditionalMetadata. When provided in CSV, AdditionalMetadata must be a JSON array of ExtendedMetadata objects. MarketplaceOfferId must be a subscription or private offer OCID.

Optional Parameters

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

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state ACCEPTED --wait-for-state CANCELED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, NEEDS_ATTENTION, SUCCEEDED, WAITING
--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

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/self/partner-integeration/create-subscription-usage-record-details/submit-subscription-usage-batch.html#cmdoption-compartment-id
    export submit_subscription_usage_batch_details=<substitute-value-of-submit_subscription_usage_batch_details> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/self/partner-integeration/create-subscription-usage-record-details/submit-subscription-usage-batch.html#cmdoption-submit-subscription-usage-batch-details

    oci self partner-integeration create-subscription-usage-record-details submit-subscription-usage-batch --compartment-id $compartment_id --submit-subscription-usage-batch-details $submit_subscription_usage_batch_details