create-or-update-distribution-list¶
- subtitle
CreateOrUpdateDistributionList
- version
0.9.141
Description¶
Creates or updates a distribution list with the given preferences.
Synopsis¶
create-or-update-distribution-list
--resource-crn <value>
--resource-name <value>
--distribution-list-management-type <value>
[--event-channel-preferences <value>]
[--email-addresses <value>]
[--distribution-list-id <value>]
[--parent-resource-crn <value>]
[--slack-channel-ids <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]
Options¶
--resource-crn
(string)
CRN of resource to create a topic for.
--resource-name
(string)
The name of the resource to be subscribed.
--distribution-list-management-type
(string)
SYSTEM_MANAGED: Created by internal actors, modifiable only by internal users. USER_MANAGED: Created by non-internal actors, modifiable by internal or external users
--event-channel-preferences
(array)
Channel preference for individual events to be subscribed to, does not require notification type.
Shorthand Syntax:
eventTypeId=string,channels=string,string,eventSeverityLists=string,string ... (separate items with spaces)
JSON Syntax:
[
{
"eventTypeId": "string",
"channels": ["UNKNOWN"|"EMAIL"|"IN_APP"|"SLACK", ...],
"eventSeverityLists": ["string", ...]
}
...
]
--email-addresses
(array)
List of recipient email addresses.
Syntax:
"string" "string" ...
--distribution-list-id
(string)
Optional identifier of an existing distribution list, if specified, is used for an update.
--parent-resource-crn
(string)
Parent resource crn for which the resource authorization has to be done.
--slack-channel-ids
(array)
List of recipient Slack channel identifiers.
Syntax:
"string" "string" ...
--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¶
distributionListDetails -> (array)
Contains details of the distribution lists created or updated.
item -> (object)
Details of the distribution list.
distributionListId -> (string)
Identifier of the distribution list.
resourceCrn -> (string)
The resource-crn of the subscription.
Form Factors¶
public, private