get-distribution-list¶

Description¶

Fetches an existing distribution list with events and channel preferences.

Synopsis¶

  get-distribution-list
--distribution-list-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--distribution-list-id (string)

The identifier for which the distribution list is requested.

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

distributionList -> (object)

The list of distribution lists.

resourceCrn -> (string)

CRN of resource the group has subscribed to.

resourceType -> (string)

Type of resource. This should be service name as represented in a CRN.

emailAddresses -> (array)

The list of email addresses if configured.

item -> (string)

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.

item -> (string)

Represents the types of channels.

eventTypeId -> (string)

ID of an event.

eventSeverityLists -> (array)

The list of severity for the event.

item -> (string)

distributionListId -> (string)

The distribution list identifier.

parentResourceCrn -> (string)

CRN of the parent resource of the Distribution List’s resource.

slackChannelIds -> (array)

The list of Slack channel ids configured.

item -> (string)

resourceName -> (string)

The name of the resource to be subscribed.

distributionListManagementType -> (string)

Represents the management types of distribution list.

Form Factors¶

public, private