Exemples

• L'exemple suivant illustre le format de l'objet DestinationConfig pour la destination iOS (push_ios) avec le certificat P8. Attribuez la valeur true au paramètre booléen pre_prod pour configurer la destination en tant que destination de préproduction ou attribuez la valeur false au paramètre booléen :

   {
      "params" : {
         "cert_type" : "p8",
         "is_sandbox" : true,
         "key_id": "production",
         "team_id": "1234",
         "bundle_id": "test1",
         "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```


- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination iOS (push_ios) avec le certificat P12. Attribuez la valeur *true* au paramètre booléen `pre_prod` pour configurer la destination en tant que destination de préproduction ou attribuez la valeur *false* au paramètre booléen.

```json
   {
      "params" : {
         "cert_type" : "p12",
         "is_sandbox" : true,
         "password": "apnspasswordvalue",
         "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Chrome (push_chrome). Attribuez la valeur *true* au paramètre booléen `pre_prod` pour configurer la destination en tant que destination de préproduction ou attribuez la valeur *false* au paramètre booléen.

```json
   {
      "params" : {
         "api_key": "chromeapikey",
         "website_url" : "https://testwebsite.com",
         "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Firefox (push_firefox). Attribuez la valeur *true* au paramètre booléen `pre_prod` pour configurer la destination en tant que destination de préproduction ou attribuez la valeur *false* au paramètre booléen.

```json
   {
      "params" : {
         "website_url" : "https://testwebsite.com",
         "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- L'exemple suivant montre le format de l'objet `DestinationConfig` pour la destination Slack (slack) avec le type incoming_webhook.

```json
   {
      "params" : {
         "type" : "incoming_webhook",
         "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk"
      }
   }
   ```

- L'exemple suivant montre le format de l'objet `DestinationConfig` pour la destination Slack (slack) avec le type direct_message.

```json
   {
      "params" : {
         "type" : "direct_message",
         "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec"
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Safari (push_safari). Attribuez la valeur *true* au paramètre booléen `pre_prod` pour configurer la destination en tant que destination de préproduction ou attribuez la valeur *false* au paramètre booléen.

```json
   {
      "params": {
         "cert_type":"p12",
         "certificate_name":"Users/Testuser/Documents/safari.p12",
         "password":"safarinew",
         "url_format_string":"https://test.com",
         "website_name":"testwebsite",
         "website_push_id":"test",
         "website_url":"https://test.com",
         "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination MS Teams (msteams).

```json
   {
      "params" : {
         "url" : "https://xyz.webhook.office.com"
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination PagerDuty(pagerduty.

   Il est recommandé de n'utiliser que la clé de routage lors de la création de la destination. La clé API est obsolète et ne pourra plus être utilisée à l'avenir.
   {: attention}

   ```json
   {
      "params" : {
         "routing_key" : "routingkeytoconnecttoPD",
         "api_key" : "cffunctionnamespaceserviceidapikey"
      }
   }
   ```


- L'exemple suivant illustre le format de l'objet `DestinationConfig` Webhook (webhook).

```json
   {
      "params" : {
         "url" : "exampleString",
         "verb" : "get",
         "custom_headers" : { },
         "sensitive_headers" : [ "exampleString" ]
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Android (push_android).

```json
   {
      "params" : {
         "project_id" : "6232305230320",
         "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f",
         "client_email" : "testuser.123@gmail.com",
         "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```


- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination ServiceNow(servicenow ).

```json
   {
      "params" : {
         "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96",
         "client_secret": "testsecrets",
         "username": "testuser",
         "password": "user_password",
         "instance_name": "testinstancenje"
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Code Engine (ibmce).

   code moteur destination type : application

   ```json
   {
      "params" : {
         "type" : "application",
         "url" : "https://codeengine.test.com",
         "verb" : "get",
         "custom_headers" : { },
         "sensitive_headers" : [ "exampleString" ]
      }
   }
   ```

   code moteur destination type : emploi

   ```json
   {
      "params" : {
         "type" : "job",
         "job_name" : "custom-job",
         "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::"
      }
   }
   ```


- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination IBM Cloud Object Storage (ibmcos).

```json
   {
      "params" : {
         "bucket_name" : "cos-destination-en-bucket",
         "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773",
         "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud"
      }
   }
   ```


- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Huawei (push_huawei).

```json
   {
      "params" : {
         "client_id" : "359705ceddd100eyfew",
         "client_secret": "testsecrets",
         "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination E-mail personnalisé (smtp_custom). Dans le cas de la destination Custom Email Sandbox (smtp_custom_sandbox), les paramètres de configuration de la destination ne sont pas nécessaires.

   Processus Pour effectuer la configuration et la vérification du domaine personnalisé : <https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

   ```json
   {
      "params" : {
         "domain": "mailx.com"
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination Event Streams (event_streams).

```json
   {
      "params" : {
        "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::",
        "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com",
        "topic": "demo_topic"
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `DestinationConfig` pour la destination App Configuration (app_configuration).

```json
   {
      "params" : {
        "type": "features",
        "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::",
        "environment_id": "stage",
        "feature_id": "test"
      }
   }
   ```

Remarque : il est possible de créer une destination SMS personnalisée sans `DestinationConfig`, mais celle-ci ne fonctionnera pas tant que les numéros personnalisés requis n'auront pas été explicitement demandés et configurés. Pour demander des numéros personnalisés, consultez la page [Numéros SMS personnalisés](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers).

### ibmcloud event-notifications destination list {: #en-cli-destination-list-command}

- **Action :** énumérer tous les `Destination`.

```sh {: pre}
ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID

• Paramètres à fournir :

--limit LIMIT (int64)

Limite de page pour les résultats paginés.

La valeur maximale est 100. La valeur minimale est 1.

--offset OFFSET (int64)

Décalage des résultats paginés.

Valeur minimale : 0.

--search SEARCH (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--instance-id (chaîne)

L'identifiant unique pour l'instance IBM Cloud Event Notifications

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identificateur unique de la destination. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Exemple

ibmcloud event-notifications enabled-countries \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identificateur unique de la destination. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Exemple

ibmcloud event-notifications test-destination \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `32` caractères. La longueur minimale est de `32` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--id (chaîne)

Identificateur unique de la destination. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/.

--domain (chaîne)

Domaine de l'email. Obligatoire.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

Exemple

ibmcloud event-notifications email-sandbox-destination-update \
    --instance-id=exampleString \
    --id=exampleString \
    --domain=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identificateur unique de la destination. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--type (chaîne)

Type de vérification. Obligatoire.

La longueur maximale est de 20 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-z]/.

Exemple

ibmcloud event-notifications verify-destination-update \
    --instance-id exampleString \
    --id exampleString \
    --type exampleString

Exemple

• L'exemple suivant montre le format de l'objet TopicCreateSourcesItem[] pour la source Periodic Timer.

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_schedule_filter": {
                   "starts_at": "2024-12-23T12:00:00.000Z",
                   "ends_at": "2024-12-23T20:00:00.000Z",
                   "expression": "* * * * *"
                   }
             }
          ]
       }
    ]
   ```

- L'exemple suivant illustre le format de l'objet `TopicCreateSourcesItem[]`.

```json
   [
      {
         "id" : "exampleString",
         "rules" : [
            {
               "enabled" : true,
               "event_type_filter" : "$.*",
               "notification_filter" : "exampleString"
            }
         ]
      }
   ]
   ```

- L'exemple suivant illustre le format de l'objet `TopicUpdateSourcesItem[]`.

```json
   [
      {
         "id" : "exampleString",
         "rules" : [
            {
               "enabled" : true,
               "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'",
               "notification_filter" : "$.notification.findings[0].severity == \'MODERATE\'",
               "rule_id" : "exampleString"
            }
         ]
      }
   ]
   ```

### ibmcloud event-notifications topic list {: #en-cli-topic-list-command}

- **Action :** énumérer tous les `Topic`.

```sh {: pre}
ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID

• Paramètres à fournir :

--limit LIMIT (int64)

Limite de page pour les résultats paginés.

La valeur maximale est 100. La valeur minimale est 1.

--offset OFFSET (int64)

Décalage des résultats paginés.

Valeur minimale : 0.

--search SEARCH (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (chaîne)

L'identifiant unique pour l'instance IBM Cloud Event Notifications Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Exemples

• L'exemple suivant illustre le format de l'objet SubscriptionCreateAttributes pour le webhook.

   {
      "signing_enabled" : true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour SMS.

```json
   {
      "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour les e-mails IBM.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG"
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour le type de destination Slack incoming_webhook.

```json
   {
      "attachment_color" : "#FF0000",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour le type de destination Slack direct_message.

```json
{
   "channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}

• L'exemple suivant illustre le format de l'objet SubscriptionCreateAttributes pour ServiceNow.

   {
      "assigned_to" : "serviceuser@gmail.com",
      "assignment_group" : "incidentgroup"
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour les e-mails personnalisés.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- L'exemple suivant montre le format de l'objet `SubscriptionCreateAttributes` pour Custom Email Sandbox.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG",
      "from_email":"Testuser@mailx.com",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```
   - L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour Pagerduty/ Event Streams.

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour App Configuration. Lors de la création ou de la mise à jour d'un abonnement pour une **App Configuration** destination, l'objet `attributes` a une règle spécifique :
      - Vous devez inclure **soit** `feature_flag_enabled` **, soit** `template_id_notification`
      - Vous **ne pouvez pas** inclure ces deux propriétés en même temps

      Cela garantit qu'un abonnement est créé pour le cas d'utilisation approprié — soit **l'évaluation d'un indicateur de fonctionnalité**, soit **la création de modèles de notification**, mais pas les deux à la fois.

   ```json
   {
      "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
   }
   ```
   ```json
   {
      "feature_flag_enabled": false,
   }
   ```

### ibmcloud event-notifications subscription list {: #en-cli-subscription-list-command}

- **Action :** énumérer tous les `Subscription`.

```sh {: pre}
ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] --instance-id INSTANCE-ID

• Paramètres à fournir :

--limit LIMIT (int64)

Limite de page pour les résultats paginés.

La valeur maximale est 100. La valeur minimale est 1.

--offset OFFSET (int64)

Décalage des résultats paginés.

Valeur minimale : 0.

--search SEARCH (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (chaîne)

L'identifiant unique pour l'instance IBM Cloud Event Notifications Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Exemples

• L'exemple suivant illustre le format de l'objet SubscriptionUpdateAttributes pour Webhook.

   {
      "signing_enabled": true
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionUpdateAttributes` pour les SMS d' IBM.

```json
   {
      "invited": {
         "add": ["+8xxxxxxxxxx"],
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      },
      "subscribed": {
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      },
      "unsubscribed": {
         "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
      }
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionUpdateAttributes` pour les e-mails IBM.

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "from_name": "IBM",
      "add_notification_payload": true
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionUpdateAttributes` pour les e-mails personnalisés.

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "from_name": "IBM",
      "from_email": "test@email.com",
      "add_notification_payload": true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```

- L'exemple suivant montre le format de l'objet `SubscriptionUpdateAttributes` pour Custom Email Sandbox.

```json
   {
      "invited": {
         "add": ["example1@gmail.com"],
         "remove": []
      },
      "subscribed": {
         "remove": ["example2@gmail.com"]
      },
      "unsubscribed": {
         "remove": ["example3@gmail.com"]
      },
      "reply_to_mail": "example@ibm.com",
      "reply_to_name": "USA news",
      "add_notification_payload": true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```

- L'exemple suivant montre le format de l'objet `SubscriptionUpdateAttributes` pour Slack pour le type `incoming_webhook`.

```json
   {
      "attachment_color" : "#FF0000",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- L'exemple suivant montre le format de l'objet `SubscriptionUpdateAttributes` pour Slack pour le type `direct_message`.

```json
   {
      "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}],
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

- L'exemple suivant illustre le format de l'objet `SubscriptionUpdateAttributes` pour Service Now.

```json
   {
      "assigned_to" : "serviceuser@gmail.com",
      "assignment_group" : "incidentgroup"
   }
   ```

   - L'exemple suivant illustre le format de l'objet `SubscriptionUpdateAttributes` pour Pagerduty/ Event Streams.

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
   }
   ```

   - L'exemple suivant illustre le format de l'objet `SubscriptionCreateAttributes` pour App Configuration. Lors de la création ou de la mise à jour d'un abonnement pour une **App Configuration** destination, l'objet `attributes` a une règle spécifique :
      - Vous devez inclure **soit** `feature_flag_enabled` **, soit** `template_id_notification`
      - Vous **ne pouvez pas** inclure ces deux propriétés en même temps
               Cela permet de s'assurer qu'un abonnement est créé pour le cas d'utilisation approprié — soit **l'évaluation d'un indicateur de fonctionnalité**, soit **la création de modèles de notification**, mais pas les deux à la fois.

   ```json
   {
      "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
   }
   ```
   ```json
   {
      "feature_flag_enabled": false,
   }
   ```

## Intégrations {: #en-cli-integration}

Opérer sur l'intégration IBM Cloud {{site {{site.data.keyword.en_short}}

### ibmcloud event-notifications integration Créer {: #en-cli-integration-create-command}

```sh
ibmcloud event-notifications integration-create --instance-id INSTANCE-ID --type TYPE --metadata METADATA

Options de commande

--instance-id (chaîne)

Identifiant unique pour l'instance IBM Cloud {{site {{site.data.keyword.en_short}}

 La longueur maximale est de `36` caractères. La longueur minimale est de `36` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--type (chaîne)

Type d'intégration collect_failed_events.

La longueur maximale est de 50 caractères. La longueur minimale est de 1 caractères. La valeur autorisée est collect_failed_events.

--metadata (IntegrationCreateAttributes)

Schéma d'intégration pour la mise à jour

Métadonnées nécessaires à l'intégration.

Exemples

• L'exemple suivant illustre le format de l'objet IntegrationCreateAttributes.

   {
      "endpoint": "https://s3.us-west.cloud-object-storage.appdomain.cloud",
      "crn": "crn:v1:bluemix:public:cloud-object-storage:global:xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx::",
      "bucket_name": "cloud-object-storage"
   }
   ```

### Remplacement de l'intégration des notifications d'événements IBM Cloud {: #en-cli-integration-update-command}

Remplacer `Integration`.

```sh
ibmcloud event-notifications integration-replace --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA

Options de commande

--instance-id (chaîne)

Identifiant unique pour l'instance IBM Cloud {{site {{site.data.keyword.en_short}}

 La longueur maximale est de `36` caractères. La longueur minimale est de `36` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--type (chaîne)

Type d'intégration KMS/hs-crypto (obsolète).

La longueur maximale est de 50 caractères. La longueur minimale est de 1 caractères. Les valeurs autorisées sont KMS et collect_failed_events. Note : Le type hs-crypto est désormais obsolète. Aucune nouvelle ressource d'intégration de type hs-crypto ne sera prise en charge.

--metadata (IntegrationReplaceAttributes)

Schéma d'intégration pour la mise à jour

Métadonnées nécessaires à l'intégration.

--id (chaîne)

Identifiant unique pour l'intégration. Obligatoire.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9-:_]*/.

Exemples

• L'exemple suivant illustre le format de l'objet IntegrationReplaceAttributes pour kms.

   {
      "endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
      "crn" : "crn of key protect",
      "root_key_id" : "root key id"
   }
   ```

### liste d'intégration des notifications d'événements ibmcloud {: #en-cli-integration-list-command}

Liste de l'ensemble des `Integrations`.

```sh
ibmcloud event-notifications integrations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID

Options de commande

--instance-id (chaîne)

Identifiant unique pour l'instance IBM Cloud {{site {{site.data.keyword.en_short}}

 La longueur maximale est de `36` caractères. La longueur minimale est de `36` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur maximale est 100. La valeur minimale est 1.

--offset (int64)

décaler pour les résultats paginés.

Valeur minimale : 0.

--search (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

Options de commande

--instance-id (chaîne)

Identifiant unique pour l'instance IBM Cloud {{site {{site.data.keyword.en_short}}

 La longueur maximale est de `36` caractères. La longueur minimale est de `36` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour l'intégration. Obligatoire.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9-:_]*/.

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--name (chaîne)

Modèle du message. Obligatoire.

La longueur maximale est de 255 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (chaîne)

Le type de modèle. Obligatoire.

La longueur maximale est de 24 caractères. La longueur minimale est de 22 caractères. La valeur doit correspondre à l'expression régulière /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Contenu décrivant la configuration d'un modèle. Obligatoire.

Cette option JSON peut être fournie en définissant des champs individuels avec d'autres options. Elle s'exclut mutuellement de ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin de fichier qui commence par @, par exemple --params=@path/to/file.json.

--description (chaîne)

La description du modèle.

La longueur maximale est de 255 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params-body (chaîne)

Corps du modèle. Cette option fournit une valeur pour un sous-champ de l'option JSON "params". Elle s'exclut mutuellement de cette option.

La longueur maximale est de 20000 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

--params-subject (chaîne)

Le sujet du modèle. Cette option fournit une valeur pour un sous-champ de l'option JSON "params". Elle s'exclut mutuellement de cette option.

La longueur maximale est de 1000 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

Exemples

• L'exemple suivant illustre le format de l'objet TemplateConfig pour la messagerie électronique. Le type pris en charge est smtp_custom.notification|smtp_custom.invitation

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type smtp_custom.notification \
    --params '{"body": "exampleString", "subject": "exampleString"}' \
    --description exampleString

• L'exemple suivant illustre le format de l'objet TemplateConfig pour Slack. Le type pris en charge est slack.notification.

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• L'exemple suivant illustre le format de l'objet TemplateConfig pour Webhook. Le type pris en charge est webhook.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• L'exemple suivant illustre le format de l'objet TemplateConfig pour Pagerduty. Le type pris en charge est pagerduty.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString

• L'exemple suivant illustre le format de l'objet TemplateConfig pour Event Streams. Le type pris en charge est event_streams.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString

• L'exemple suivant montre le format de l'objet TemplateConfig pour le travail Code Engine. Le type pris en charge est ibmcejob.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString

• L'exemple suivant montre le format de l'objet TemplateConfig pour Code Engine Application/Fonction. Le type pris en charge est ibmceapp.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString

• L'exemple suivant illustre le format de l'objet TemplateConfig pour App Configuration. Le type pris en charge est app_configuration.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type app_configuration.notification\
    --params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \
    --description exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur par défaut est 10. La valeur maximale est 100. Valeur minimale : 1.

--offset (int64)

décaler pour les résultats paginés.

La valeur par défaut est 0. La valeur minimale est 0.

--search (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection de modèles.

Exemple

ibmcloud event-notifications templates \
    --instance-id exampleString \
    --limit 10 \
    --offset 0 \
    --search exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `32` caractères. La longueur minimale est de `32` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--id (chaîne)

Identifiant unique pour le modèle. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications template \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour le modèle. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--name (chaîne)

Nom du modèle.

La longueur maximale est de 255 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (chaîne)

Description du modèle.

La longueur maximale est de 255 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (chaîne)

Le type de modèle.

La longueur maximale est de 24 caractères. La longueur minimale est de 22 caractères. La valeur doit correspondre à l'expression régulière /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Contenu décrivant la configuration d'un modèle. Cette option JSON peut être fournie en définissant des champs individuels avec d'autres options. Elle s'exclut mutuellement de ces options.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin de fichier qui commence par @, par exemple --params=@path/to/file.json.

Exemples

ibmcloud event-notifications template-update \
    --instance-id exampleString \
    --id exampleString \
    --name exampleString \
    --description exampleString \
    --type exampleString \
    --params '{"body": "exampleString", "subject": "exampleString"}'

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour le modèle. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications template-delete \
    --instance-id exampleString \
    --id exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `32` caractères. La longueur minimale est de `32` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--source (chaîne)

Type de source. Obligatoire.

La longueur maximale est de 50 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

--type (chaîne)

Type de destination. Obligatoire.

La longueur maximale est de 50 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur par défaut est 10. La valeur maximale est 100. Valeur minimale : 1.

--offset (int64)

décaler pour les résultats paginés.

La valeur par défaut est 0. La valeur minimale est 0.

--search (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection pre-defined-templates.

Exemple

ibmcloud event-notifications pre-defined-templates \
    --instance-id=exampleString \
    --source=exampleString \
    --type=exampleString \
    --limit=10 \
    --offset=0 \
    --search=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--name (chaîne)

Le nom de la configuration SMTP. Obligatoire.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--domain (chaîne)

Nom de domaine. Obligatoire.

La longueur maximale est de 512 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

--description (chaîne)

Description de la configuration SMTP.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemple

ibmcloud event-notifications smtp-configuration-create \
    --instance-id=exampleString \
    --name=exampleString \
    --domain=exampleString \
    --description=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur par défaut est 10. La valeur maximale est 100. Valeur minimale : 1.

--offset (int64)

décaler pour les résultats paginés.

La valeur par défaut est 0. La valeur minimale est 0.

--search (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection relative aux configurations SMTP.

Exemple

ibmcloud event-notifications smtp-configurations \
    --instance-id=exampleString \
    --limit=10 \
    --offset=0 \
    --search=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--description (chaîne)

Description de la configuration SMTP.

La longueur maximale est de 250 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--username-to-clone (chaîne)

fournit le nom de l'utilisateur à cloner.

La longueur maximale est de 20 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /^[a-z0-9]{18}\\d{2}$/.

Exemple

ibmcloud event-notifications smtp-user-create \
    --instance-id=exampleString \
    --id=exampleString \
    --description=exampleString \
    --username-to-clone=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur par défaut est 10. La valeur maximale est 100. Valeur minimale : 1.

--offset (int64)

décaler pour les résultats paginés.

La valeur par défaut est 0. La valeur minimale est 0.

--search (chaîne)

Chaîne de recherche pour le filtrage des résultats.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection destinée aux utilisateurs SMTP.

Exemple

ibmcloud event-notifications smtp-users \
    --instance-id=exampleString \
    --id=exampleString \
    --limit=10 \
    --offset=0 \
    --search=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications smtp-configuration \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--name (chaîne)

Nom SMTP.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (chaîne)

Description SMTP.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemple

ibmcloud event-notifications smtp-configuration-update \
    --instance-id=exampleString \
    --id=exampleString \
    --name=exampleString \
    --description=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications smtp-configuration-delete \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (chaîne)

UserID. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /.*/.

Exemple

ibmcloud event-notifications smtp-user \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (chaîne)

UserID. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /.*/.

--description (chaîne)

Description de l'utilisateur SMTP.

La longueur maximale est de 250 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemple

ibmcloud event-notifications smtp-user-update \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString \
    --description=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (chaîne)

UserID. Obligatoire.

La longueur maximale est de 256 caractères. La longueur minimale est de 5 caractères. La valeur doit correspondre à l'expression régulière /.*/.

Exemple

ibmcloud event-notifications smtp-user-delete \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications smtp-allowed-ips \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

La longueur maximale est de 32 caractères. La longueur minimale est de 32 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--type (chaîne)

SMTP Type de vérification. Obligatoire.

La longueur maximale est de 20 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /.*/.

Exemple

ibmcloud event-notifications verify-smtp-update \
    --instance-id=exampleString \
    --id=exampleString \
    --type=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--gte (chaîne)

GTE (plus grand qu'égal), date de début en UTC. Obligatoire.

La longueur maximale est de 28 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--lte (chaîne)

LTE (inférieur à égal), date de fin en UTC. Obligatoire.

La longueur maximale est de 28 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (chaîne)

ID de configuration SMTP. Obligatoire lors de l'interrogation des métriques relatives aux destinations de l'interface SMTP.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--destination-type (chaîne)

Type de destination pour lequel des indicateurs sont demandés. Valeur prise en charge : smtp_custom. Obligatoire lors de la consultation des métriques pour les destinations e-mail personnalisées.

Les valeurs admises sont: smtp_custom.

--destination-id (chaîne)

Identificateur unique de la destination.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subscription-id (chaîne)

Identificateur unique de l'abonnement.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--source-id (chaîne)

Identificateur unique de la source.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9-:_]*/.

--email-to (chaîne)

Adresse électronique du destinataire.

La longueur maximale est de 256 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (chaîne)

Identifiant de notification.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subject (chaîne)

l'objet de l'e-mail.

La longueur maximale est de 256 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

Exemple

ibmcloud event-notifications metrics \
    --instance-id=exampleString \
    --destination-type=smtp_custom \
    --gte=exampleString \
    --lte=exampleString \
    --destination-id=exampleString \
    --subscription-id=exampleString \
    --source-id=exampleString \
    --email-to=exampleString \
    --notification-id=exampleString \
    --subject=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `32` caractères. La longueur minimale est de `32` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--gte (chaîne)

GTE (plus grand qu'égal), date de début en UTC. Obligatoire.

La longueur maximale est de 28 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--lte (chaîne)

LTE (inférieur à égal), date de fin en UTC. Obligatoire.

La longueur maximale est de 28 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (chaîne)

ID de configuration SMTP. Obligatoire lors de l'interrogation des métriques relatives aux destinations de l'interface SMTP.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--destination-type (chaîne)

Type de destination pour lequel des indicateurs sont demandés. Valeur prise en charge : smtp_custom. Obligatoire lors de la consultation des métriques pour les destinations e-mail personnalisées.

Les valeurs admises sont: smtp_custom.

--destination-id (chaîne)

Identificateur unique de la destination.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subscription-id (chaîne)

Identificateur unique de l'abonnement.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--source-id (chaîne)

Identificateur unique de la source.

La longueur maximale est de 100 caractères. La longueur minimale est de caractères 1. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9-:_]*/.

--email-to (chaîne)

Adresse électronique du destinataire.

La longueur maximale est de 256 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (chaîne)

Identifiant de notification.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subject (chaîne)

l'objet de l'e-mail.

La longueur maximale est de 256 caractères. La longueur minimale est de 0 caractères. La valeur doit correspondre à l'expression régulière /[a-zA-Z0-9]/.

--limit (int64)

Limite de page pour les résultats paginés.

La valeur par défaut est 10. La valeur maximale est 100. Valeur minimale : 1.

--offset (int64)

décaler pour les résultats paginés.

La valeur par défaut est 0. La valeur minimale est 0.

Exemple

ibmcloud event-notifications bounce-metrics \
    --instance-id=exampleString \
    --destination-type=smtp_custom \
    --gte=exampleString \
    --lte=exampleString \
    --destination-id=exampleString \
    --subscription-id=exampleString \
    --source-id=exampleString \
    --email-to=exampleString \
    --notification-id=exampleString \
    --subject=exampleString \
    --limit=10 \
    --offset=0

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `32` caractères. La longueur minimale est de `32` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--id (chaîne)

L'identifiant de notification renvoyé lors du test d'une destination de webhook. Cet identifiant est spécifique aux notifications de test envoyées vers des destinations webhook. Obligatoire.

La longueur maximale est de 36 caractères. La longueur minimale est de 36 caractères. La valeur doit correspondre à l'expression régulière /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

Exemple

ibmcloud event-notifications notifications-status \
    --instance-id=exampleString \
    --id=exampleString

Options de commande

--instance-id (chaîne)

Identificateur unique de l'instance d'IBM Cloud Event Notifications. Obligatoire.

 La longueur maximale est de `256` caractères. La longueur minimale est de `10` caractères. La valeur doit correspondre à l'expression régulière `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--body (NotificationCreate)

Charge utile décrivant une demande de création de notification.

Fournir une option de chaîne JSON ou spécifier un fichier JSON à lire en fournissant une option de chemin de fichier qui commence par @, par exemple --body=@path/to/file.json.

Exemple

Avec les paramètres requis :

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "type": "*", "id": "exampleString", "source": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "short message", "ibmendefaultlong": "long message", "data": {"name": "exampleString"}, "datacontenttype": "application/json"}'

Avec tous les paramètres :

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "id": "exampleString", "source": "exampleString", "type": "exampleString", "ibmenseverity": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "exampleString", "ibmendefaultlong": "exampleString", "ibmensubject": "exampleString", "ibmentemplates": [\"template-id\"], "ibmenmailto": "exampleString","ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]", "ibmensmsto": "exampleString","ibmenmms": "{\"content\": \"VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO\",\"content_type\": \"image/png\"}", "ibmenhtmlbody": "exampleString", "subject": "exampleString", "data": {"anyKey": "anyValue"}, "datacontenttype": "application/json", "ibmenpushto": "{\"fcm_devices\": [\"exampleString\"], \"apns_devices\": [\"exampleString\"], \"huawei_devices\": [\"exampleString\"], \"safari_devices\": [\"exampleString\"], \"chrome_devices\": [\"exampleString\"], \"firefox_devices\": [\"exampleString\"], \"user_ids\": [\"exampleString\"], \"tags\": [\"exampleString\"], \"platforms\": [\"push_android\"]}", "ibmenfcmbody": "{}", "ibmenapnsbody": "{}", "ibmenapnsheaders": "{}", "ibmenchromebody": "{}", "ibmenchromeheaders": "{}", "ibmenfirefoxbody": "{}", "ibmenfirefoxheaders": "{}", "ibmenhuaweibody": "{}", "ibmensafaribody": "{}"}'

Propriétés supplémentaires pouvant être configurées pour la notification iOS.

Propriétés supplémentaires pouvant être configurées pour la notification FCM