NAME

ons_subscription_unsubscribe -

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

DESCRIPTION

Unsubscribes the subscription from the topic.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

USAGE

oci ons subscription unsubscribe [OPTIONS]

REQUIRED PARAMETERS

--id [text]

The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the subscription to unsubscribe from.

--protocol [text]

The protocol used for the subscription.

Allowed values: * CUSTOM_HTTPS * EMAIL * HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) * ORACLE_FUNCTIONS * PAGERDUTY * SLACK * SMS

For information about subscription protocols, see To create a subscription <https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub>.

--token [text]

The subscription confirmation token.

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

GLOBAL PARAMETERS

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

EXAMPLES

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 <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export id=<substitute-value-of-id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ons/subscription/unsubscribe.html#cmdoption-id
    export protocol=<substitute-value-of-protocol> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ons/subscription/unsubscribe.html#cmdoption-protocol
    export token=<substitute-value-of-token> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/ons/subscription/unsubscribe.html#cmdoption-token
    oci ons subscription unsubscribe --id $id --protocol $protocol --token $token

AUTHOR

Oracle

COPYRIGHT

2016, 2022, Oracle