list-resource-subscriptions¶

Description¶

Lists all resource subscriptions for a user.

list-resource-subscriptions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-resource-subscriptions
[--resource-crn <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--resource-crn (string)

The optional resource CRN, if specified, only subscriptions related to this resource will be returned.

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 50 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

resourceSubscriptions -> (array)

List of resource subscriptions for the user.

item -> (object)

ResourceSubscription holds a list of subscribed events and delivery details for a particular resource.

resourceCrn -> (string)

CRN of resource for which the event is subscribed.

serviceName -> (string)

Name of the service for which the event is scoped to. This should be service name as represented in a CRN.

resourceName -> (string)

Name of the resource for which the event is scoped to. This should be resource name as represented in a CRN.

subscribedEvents -> (array)

List of all events subscribed under the given resource.

item -> (object)

Details related to a subscribed event.

eventName -> (string)

Name of an event.

description -> (string)

Description of the event.

channels -> (array)

Subscribed channel preferences of the event.

eventTypeId -> (string)

ID of an event.

eventSeverityLists -> (array)

The list of severity for the event.

subscriptionId -> (string)

The Subscription identifier.

parentResourceCrn -> (string)

CRN of the parent resource of the resource for which the notification event is subscribed.

nextPageToken -> (string)

The token to use when requesting the next set of results. If not present, there are no additional results.

totalSubscriptions -> (integer)

This field represents the total number of resource subscriptions.

Form Factors¶

public, private