Référence de l'interface de ligne de commande de Event Notifications

Pour utiliser l'interface de ligne de commande (CLI) d' Event Notifications, vous pouvez installer le plug-in CLI Event Notifications à partir du référentiel de plug-ins IBM Cloud. Ce plug-in est conçu pour étendre les fonctionnalités offertes par l’interface de ligne de commande (CLI) d’ IBM Cloud.

Prérequis

Un compte IBM Cloud.
Un exemple de Event Notifications.
L'interface de ligne de commande(CLI)d' IBM Cloud, installée sur votre système local. Pour obtenir de l'aide sur l'utilisation de l'interface de ligne de commande (CLI) d' IBM Cloud, consultez la fiche de référence.

Lorsque vous vous connectez à l'interface CLI d' IBM Cloud, vous recevez une notification si des mises à jour sont disponibles. Veillez à maintenir votre interface CLI à jour afin de pouvoir accéder à toutes les nouvelles commandes et options disponibles pour le plug-in CLI Event Notifications.

Installation de l'interface de ligne de commande Event Notifications

Installez le plug-in CLI d' Event Notifications à l'aide de la commande plugin install.

ibmcloud plugin install event-notifications

Les versions du plugin antérieures à 1.15.2 sont obsolètes.

Event Notifications Commandes CLI

La commande init est obsolète et sera supprimée dans une prochaine version.

`ibmcloud event-notifications en-list`

Liste les instances dans la région cible définie. Vous pouvez retrouver le GUID de votre instance dans la liste des instances.

ibmcloud event-notifications en-list

Exemple

ibmcloud event-notifications en-list

Définir une région cible

Définissez la région dans laquelle vous souhaitez travailler à l'aide de la commande ibmcloud target.

ibmcloud target -r REGION

Vous pouvez également exporter un point de terminaison régional via la variable, comme IBMCLOUD_EN_ENDPOINT le montre l'exemple suivant.

export IBMCLOUD_EN_ENDPOINT= https://au-syd.event-notifications.cloud.ibm.com/event-notifications

Pour définir le point de terminaison régional comme public ou privé, consultez les options suivantes :

Points de terminaison publics disponibles :
- Dallas : https://us-south.event-notifications.cloud.ibm.com/event-notifications
- Londres : https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
- Sydney : https://au-syd.event-notifications.cloud.ibm.com/event-notifications
- Francfort : https://eu-de.event-notifications.cloud.ibm.com/event-notifications
- Madrid : https://eu-es.event-notifications.cloud.ibm.com/event-notifications
- Osaka : https://jp-osa.event-notifications.cloud.ibm.com/event-notifications
- Tokyo : https://jp-tok.event-notifications.cloud.ibm.com/event-notifications
- Toronto : https://ca-tor.event-notifications.cloud.ibm.com/event-notifications
- Sao Paulo : https://br-sao.event-notifications.cloud.ibm.com/event-notifications
- Montréal : https://ca-mon.event-notifications.cloud.ibm.com/event-notifications
- Washington DC : https://us-east.event-notifications.cloud.ibm.com/event-notifications
- Chennai : https://in-che.event-notifications.cloud.ibm.com/event-notifications
- Mumbai : https://in-mum.event-notifications.cloud.ibm.com/event-notifications
Points de terminaison privés disponibles :
- Dallas : https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
- Londres : https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
- Sydney : https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
- Francfort : https://private.eu-de.event-notifications.cloud.ibm.com/event-notifications
- Madrid : https://private.eu-es.event-notifications.cloud.ibm.com/event-notifications
- Osaka : https://private.jp-osa.event-notifications.cloud.ibm.com/event-notifications
- Tokyo : https://private.jp-tok.event-notifications.cloud.ibm.com/event-notifications
- Toronto : https://private.ca-tor.event-notifications.cloud.ibm.com/event-notifications
- Sao Paulo : https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications
- Montréal : https://private.ca-mon.event-notifications.cloud.ibm.com/event-notifications
- Washington DC : https://private.us-east.event-notifications.cloud.ibm.com/event-notifications
- Chennai : https://private.in-che.event-notifications.cloud.ibm.com/event-notifications
- Mumbai : https://private.in-mum.event-notifications.cloud.ibm.com/event-notifications

Vous pouvez également exporter la variable EVENT_NOTIFICATIONS_API_KEY pour configurer la clé API ou les identifiants de service de votre instance Event Notifications.

Sources

Opérer sur IBM Cloud {{site {{site.data.keyword.en_short}}

`ibmcloud event-notifications source-create`

Créez une source qui configure un service afin de générer des événements pouvant être consommés par Event Notifications. Vous devez fournir l'ID de l'instance d' Event Notifications pour laquelle vous configurez la source. Pour plus d'informations sur les types de sources et leur enregistrement auprès d' Event Notifications, consultez la section Ajouter une source Event Notifications.

À l'heure actuelle, l'interface de ligne de commande (CLI) ne prend en charge que la création de sources API.

ibmcloud event-notifications source-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] --enabled ENABLED [--store-notifications STORE-NOTIFICATIONS]

Les formats et source-create sources-create sont tous deux pris en charge. Utilisez source-create pour assurer la cohérence avec les autres commandes.

Options de commande

--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]/.

--name NAME (chaîne)

Nom à fournir pour la source de l'API. Obligatoire.

La valeur par défaut est . La longueur maximale est de caractères 255. 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 code source de l'API.

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

--enabled (booléen)

Activer ou désactiver la source. Obligatoire. Réglez sur true pour activer la source.

--store-notifications (booléen)

Notifications de la boutique. Activez l'option pour true stocker les notifications afin de pouvoir consulter le contenu des événements entrants à des fins de dépannage.

Exemple

ibmcloud event-notifications source-create \
   --instance-id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

`ibmcloud event-notifications source-update`

Mettez à jour les paramètres de la source à l'aide de l'ID de la source. Vous devez également fournir l'identifiant de l'instance d' Event Notifications pour laquelle la source est configurée.

ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

L'identifiant unique de la source. 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-:_]*/.

--name (chaîne)

Nouveau nom de la source de l'API.

--description (chaîne)

Description mise à jour de la source de l'API.

--enabled (booléen)

Activer ou désactiver la source.

La valeur est fixée à true (vrai) pour activer la source et à false (faux) pour la désactiver.

--store-notifications (booléen)

Notifications de la boutique. Vous pouvez consulter la charge utile des événements entrants à des fins de dépannage.

La valeur par défaut est false.

Exemple

ibmcloud event-notifications source-update \
   --instance-id=exampleString \
   --id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

`ibmcloud event-notifications sources`

Répertorier toutes les sources dans une instance donnée.

ibmcloud event-notifications sources --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--limit (int64)

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

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

--offset (int64)

Décalage des 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]/.

--all-pages (booléen)

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

Exemple

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

`ibmcloud event-notifications source`

Obtenir les détails d'une source spécifique.

ibmcloud event-notifications source --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la source. 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-:_]*/.

Exemple

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

`ibmcloud event-notifications source-delete`

Supprimer une source.

ibmcloud event-notifications source-delete  --instance-id INSTANCE-ID --id ID

Options de commande

--id (chaîne)

Identificateur unique de la source. 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-:_]*/.

--instance-id (chaîne)

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

--force

Ignorer l'invite de confirmation et forcer la suppression de la ressource.

Exemple

ibmcloud event-notifications source-delete \
  --instance-id=exampleString \
  --id=exampleString

Destinations

Opérer sur IBM Cloud {{site {{site.data.keyword.en_short}}

`ibmcloud event-notifications destination-create`

Créer une destination qui servira de cible de livraison pour une notification. Une destination peut être configurée pour envoyer des notifications à un utilisateur humain ou à un service automatisé.

ibmcloud event-notifications destination-create --instance-id INSTANCE-ID --name NAME --type TYPE [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--name (chaîne)

Nom de la destination. 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 la destination. Destinations pour les utilisateurs humains : smtp_ibm, sms_ibm, smtp_custom, sms_custom, event_streams, msteams, pagerduty, push_android, push_chrome, push_firefox, push_huawei, push_ios, push_safari, servicenow, slack. Destinations pour les services : ibmce, ibmcos, webhook. Obligatoire.

La longueur minimale est de caractères 1.

--description (chaîne)

Description de la destination.

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

--collect-failed-events (booléen)

Configurez true pour collecter les événements ayant échoué dans un compartiment Cloud Object Storage. Pour collecter les événements d'échec, activez l'intégration d' Cloud Object Storage s pour cette instance. La valeur par défaut est false.

--config ( DestinationConfig exemples )

La configuration de la destination. Si vous créez une destination sans « --config », celle-ci est créée mais ne fonctionne pas tant que vous ne l'avez pas configurée.

--certificate (chaîne)

Chemin d'accès au fichier de certificat pour les destinations de notification APNs ou iOS. Prend en charge les fichiers de certificats au format p8 et p12.

--certificate-content-type (chaîne)

Type de contenu du certificat pour les destinations iOS. Les valeurs autorisées sont p8 et p12.

--icon16x16 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 16x16. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon16x16-content-type (chaîne)

Le type de contenu de l'icône Safari 16x16.

--icon16x162x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 16x16@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon16x162x-content-type (chaîne)

Le type de contenu de l'icône Safari 16x16@2x.

--icon32x32 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 32x32. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon32x32-content-type (chaîne)

Le type de contenu de l'icône Safari 32x32.

--icon32x322x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 32x32@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon32x322x-content-type (chaîne)

Le type de contenu de l'icône Safari 32x32@2x.

--icon128x128 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 128x128. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon128x128-content-type (chaîne)

Le type de contenu de l'icône Safari 128x128.

--icon128x1282x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 128x128@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon128x1282x-content-type (chaîne)

Le type de contenu de l'icône Safari 128x128@2x.

Cloud Functions n'est plus pris en charge en tant que destination.

Exemples

ibmcloud event-notifications destination-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=webhook \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString

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.

{
   "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.

{
   "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.
```
{
   "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.

{
   "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.

{
   "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.

{
   "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).
```
{
   "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.
```
{
   "params" : {
      "routing_key" : "routingkeytoconnecttoPD",
      "api_key" : "cffunctionnamespaceserviceidapikey"
   }
}
```

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

{
   "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).

{
   "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.

{
   "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

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

code moteur destination type : emploi

{
   "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).

{
   "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).

{
   "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.

Procédure de configuration et de vérification d'un domaine personnalisé : https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify
```
{
   "params" : {
      "domain": "mailx.com"
   }
}
```

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

{
   "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).
```
{
   "params" : {
      "type": "features",
      "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::",
      "environment_id": "stage",
      "feature_id": "test"
   }
}
```
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.

`ibmcloud event-notifications destinations`

Répertorier toutes les destinations d'une instance d' Event Notifications.

ibmcloud event-notifications destinations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--limit (int64)

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

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

--offset (int64)

Décalage des 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]/.

--all-pages (booléen)

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

Exemple

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

`ibmcloud event-notifications destination`

Obtenir les détails d'une destination à l'aide de son identifiant.

ibmcloud event-notifications destination --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

Exemple

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

`ibmcloud event-notifications destination-update`

Mettez à jour les paramètres de destination à l'aide de l'ID de destination.

ibmcloud event-notifications destination-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

--name (chaîne)

Le nom mis à jour de la destination.

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 mise à jour de la destination.

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-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (booléen)

Configurez true pour collecter les événements ayant échoué dans un compartiment Cloud Object Storage. La valeur par défaut est false.

--config (DestinationConfig)

La configuration mise à jour pour la destination.

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 --config=@path/to/file.json.

--certificate (chaîne)

Chemin d'accès au fichier de certificat pour les destinations de notification APNs ou iOS. Prend en charge les fichiers de certificats au format p8 et p12.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--certificate-content-type (chaîne)

Type de contenu du certificat pour les destinations iOS. Les valeurs autorisées sont p8 et p12.

--icon16x16 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 16x16. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon16x16-content-type (chaîne)

Le type de contenu de l'icône Safari 16x16.

--icon16x162x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 16x16@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon16x162x-content-type (chaîne)

Le type de contenu de l'icône Safari 16x16@2x.

--icon32x32 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 32x32. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon32x32-content-type (chaîne)

Le type de contenu de l'icône Safari 32x32.

--icon32x322x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 32x32@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon32x322x-content-type (chaîne)

Le type de contenu de l'icône Safari 32x32@2x.

--icon128x128 (chaîne)

Chemin d'accès au fichier de l'icône Safari : 128x128. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon128x128-content-type (chaîne)

Le type de contenu de l'icône Safari 128x128.

--icon128x1282x (chaîne)

Chemin d'accès au fichier de l'icône Safari : 128x128@2x. Pour les destinations push_safari.

La longueur maximale est de 5000 caractères. La longueur minimale est de caractères 1.

--icon128x1282x-content-type (chaîne)

Le type de contenu de l'icône Safari 128x128@2x.

Exemple

ibmcloud event-notifications destination-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString

`ibmcloud event-notifications destination-delete`

Supprimer une destination à l'aide de son ID. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle la destination est configurée.

ibmcloud event-notifications destination-delete --instance-id INSTANCE-ID --id ID [--force]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

--force (booléen)

Forcer l'exécution de la commande.

Exemple

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

`ibmcloud event-notifications enabled-countries`

Obtenir les informations relatives aux pays pris en charge pour une destination SMS à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle la destination est configurée.

ibmcloud event-notifications enabled-countries --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la destination SMS. Obligatoire.

Exemple

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

`ibmcloud event-notifications test-destination`

Testez une configuration de destination à l'aide de son ID. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle la destination est configurée. Pour consulter la liste des destinations prises en charge, reportez-vous à la section Tester une destination.

ibmcloud event-notifications test-destination --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

Exemple

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

`ibmcloud event-notifications sandbox-destination-update`

Mettre à niveau une destination de messagerie du bac à sable vers l'environnement de production avec un domaine personnalisé.

ibmcloud event-notifications sandbox-destination-update --instance-id INSTANCE-ID --id ID --domain DOMAIN

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

--domain (chaîne)

Le domaine de messagerie. 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 sandbox-destination-update \
    --instance-id=exampleString \
    --id=exampleString \
    --domain=exampleString

`ibmcloud event-notifications verify-destination-update`

Vérifier les enregistrements SPF et DKIM d'un domaine personnalisé.

ibmcloud event-notifications verify-destination-update --instance-id INSTANCE-ID --id ID --type TYPE

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

L'identifiant unique de la destination. Obligatoire.

--type (chaîne)

Type de vérification pour une adresse e-mail de domaine personnalisée. Les valeurs autorisées sont spf et dkim. 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

Rubriques

Opérer sur IBM Cloud {{site {{site.data.keyword.en_short}}

`ibmcloud event-notifications topic-create`

Créez un sujet pour recevoir des événements provenant de sources et envoyer des notifications aux destinations abonnées. Un sujet peut se connecter à plusieurs sources. Pour créer un sujet, vous devez fournir l'ID de l'instance d' Event Notifications.

Pour plus d'informations, consultez la section Création d'une rubrique.

ibmcloud event-notifications topic-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--sources SOURCES]

Options de commande

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

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--name NAME (chaîne)

Intitulé de la rubrique. 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-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (chaîne)

Description du sujet.

--sources SOURCES (TopicCreateSourcesItem[])

Configuration de la source et du filtre à associer au sujet. Voir les exemples de configuration source.

Exemple

ibmcloud event-notifications topic-create \
  --instance-id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'

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[].

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

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

[
   {
      "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 topics`

Répertorier tous les sujets créés pour une instance d' Event Notifications. Vous devez fournir l'ID de l'instance.

ibmcloud event-notifications topics --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--limit (int64)

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

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

--offset (int64)

Décalage des 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]/.

--all-pages (booléen)

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

Exemple

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

`ibmcloud event-notifications topic`

Accédez aux détails d'un sujet à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle le sujet est configuré.

ibmcloud event-notifications topic --instance-id INSTANCE-ID --id ID [--include INCLUDE]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la rubrique. Obligatoire.

--include (chaîne)

Inclure des sous-thèmes.

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

Exemple

ibmcloud event-notifications topic \
  --instance-id=exampleString \
  --id=exampleString \
  --include=exampleString

`ibmcloud event-notifications topic-update`

Mettre à jour les détails d'un sujet à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle le sujet est configuré.

ibmcloud event-notifications topic-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES]

Vous pouvez utiliser topic-replace comme alias de topic-update. La commande topic-replace est obsolète et sera supprimée dans une prochaine version.

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la rubrique. Obligatoire.

--name (chaîne)

Nouveau nom de la rubrique.

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 mise à jour du sujet.

--sources (TopicUpdateSourcesItem[])

Les détails et filtres de la source ont été mis à jour. Voir les exemples de configuration source.

Cette option ajoute uniquement de nouvelles sources. Les sources déjà associées au sujet ne peuvent être ni remplacées ni mises à jour. Pour modifier les filtres de source, supprimez la source du sujet, puis ajoutez-la à nouveau avec la nouvelle configuration de filtre.

Exemple

ibmcloud event-notifications topic-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'

`ibmcloud event-notifications topic-delete`

Supprimer une rubrique à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle le sujet est configuré.

ibmcloud event-notifications topic-delete --instance-id INSTANCE-ID --id ID [--force]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la rubrique. Obligatoire.

--force (booléen)

Forcer l'exécution de la commande.

Exemple

ibmcloud event-notifications topic-delete \
  --instance-id=exampleString \
  --id=exampleString

Abonnements

Fonctionne sur l'abonnement IBM Cloud {{site {{site.data.keyword.en_short}}

`ibmcloud event-notifications subscription-create`

Créez un abonnement qui associe une destination à un sujet pour la diffusion d'événements. Une destination peut s'abonner à des sujets, et plusieurs destinations peuvent s'abonner au même sujet. Pour créer un abonnement, vous devez fournir l'ID de l'instance d' Event Notifications.

ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES]

Options de commande

--name (chaîne)

Nom de l'abonnement. 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 /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--description (chaîne)

Description de l'abonnement.

La valeur par défaut est ``. 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-_\/.?:'";,+=!#@$%^&*() ]*/.

--destination-id (chaîne)

L'identifiant de destination permettant d'accéder à la rubrique. Obligatoire.

La longueur maximale est de 150 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}/.

--topic-id (chaîne)

L'identifiant du sujet pour l'abonnement. Obligatoire.

--attributes (SubscriptionCreateAttributes)

Les attributs requis pour créer l'abonnement. Voir les exemples d'attributs.

Exemples

ibmcloud event-notifications subscription-create \
  --instance-id=exampleString \
  --name=exampleString \
  --destination-id=exampleString \
  --topic-id=exampleString \
  --description=exampleString \
  --attributes='{"invited": ["exampleString"]}'

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.

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

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

{
   "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.

{
   "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.

{
"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.

{
   "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.

{
   "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.
```
{
   "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.
```
{
   "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
}
```
```
{
   "feature_flag_enabled": false,
}
```

`ibmcloud event-notifications subscriptions`

Répertorier tous les abonnements configurés pour une instance d’ Event Notifications. Vous devez fournir l'ID de l'instance.

ibmcloud event-notifications subscriptions --instance-id INSTANCE-ID [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--all-pages]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--offset (int64)

Décalage des résultats paginés.

Valeur minimale : 0.

--limit (int64)

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

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

--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]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection d'abonnements.

Exemple

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

`ibmcloud event-notifications subscription`

Obtenir les détails d'un abonnement à l'aide de son identifiant. Vous devez fournir l'ID de l'instance d' Event Notifications pour laquelle l'abonnement est configuré.

ibmcloud event-notifications subscription --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de l'abonnement. Obligatoire.

Exemple

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

`ibmcloud event-notifications subscription-delete`

Supprimer un abonnement à l'aide de son identifiant. Vous devez fournir l'ID de l'instance d' Event Notifications pour laquelle l'abonnement est configuré.

ibmcloud event-notifications subscription-delete --instance-id INSTANCE-ID --id ID [--force]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de l'abonnement. Obligatoire.

--force (booléen)

Forcer l'exécution de la commande.

Exemple

ibmcloud event-notifications subscription-delete \
  --instance-id=exampleString \
  --id=exampleString

`ibmcloud event-notifications subscription-update`

Mettre à jour les paramètres d’un abonnement à l’aide de son identifiant. Vous devez fournir l'ID de l'instance d' Event Notifications pour laquelle l'abonnement est configuré.

ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de l'abonnement. Obligatoire.

--name (chaîne)

Le nouveau nom de l'abonnement.

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-:_]*/.

--description (chaîne)

Description mise à jour de l'abonnement.

La valeur par défaut est ``. 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-:_]*/.

--attributes (SubscriptionUpdateAttributes)

Les attributs mis à jour. Voir les exemples d'attributs.

Exemples

ibmcloud event-notifications subscription-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --attributes='{"invited": {"add": ["exampleString"], "remove": ["exampleString"]}, "subscribed": {"remove": ["exampleString"]}, "unsubscribed": {"remove": ["exampleString"]}}'

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.

{
   "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 l'e-mail IBM.

{
   "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.

{
   "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.

{
   "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.

{
   "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.

{
   "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.
```
{
   "assigned_to" : "serviceuser@gmail.com",
   "assignment_group" : "incidentgroup"
}
```
- L'exemple suivant illustre le format de l'objet SubscriptionUpdateAttributes pour Pagerduty/ Event Streams.
```
{
   "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 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.
```
{
   "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
}
```
```
{
   "feature_flag_enabled": false,
}
```

Intégrations

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

`ibmcloud event-notifications integration-create`

Créez une intégration reliant Event Notifications à IBM Cloud Object Storage.

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

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--type (chaîne)

Le type d'intégration. Le type pris en charge est collect_failed_events. Obligatoire.

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 (chaîne)

Les métadonnées d'intégration nécessaires à la création de l'intégration. Consultez l'exemple pour obtenir de l'aide sur la mise en forme. Obligatoire.

Exemples

ibmcloud event-notifications integration-create \
  --instance-id=exampleString \
  --type=collect_failed_events \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "bucket_name": "exampleString"}'

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"
}

`ibmcloud event-notifications integration-update`

Mettez à jour une intégration existante à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle l'intégration est configurée.

ibmcloud event-notifications integration-update --instance-id INSTANCE-ID --id ID --type TYPE --metadata METADATA

Pour l'instant, vous pouvez également utiliser integration-replace pour mettre à jour votre intégration. Cependant, la commande integration-replace est obsolète et sera supprimée dans une prochaine version.

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--type (chaîne)

Le type d'intégration. Les valeurs autorisées sont kms, hs-crypto, et collect_failed_events. Obligatoire.

La longueur maximale est de 50 caractères. La longueur minimale est de 1 caractères.

--metadata (chaîne)

Les métadonnées d'intégration nécessaires à la mise à jour de l'intégration. Consultez l'exemple pour obtenir de l'aide sur la mise en forme. Obligatoire.

--id (chaîne)

Identifiant unique de 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

ibmcloud event-notifications integration-update \
  --instance-id=exampleString \
  --id=exampleString \
  --type=exampleString \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "root_key_id": "exampleString", "bucket_name": "exampleString"}'

L'exemple suivant illustre le format de l'objet IntegrationReplaceAttributes pour Key Protect.

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

`ibmcloud event-notifications integrations`

Répertoriez les intégrations créées pour une instance d' Event Notifications.

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

Options de commande

--instance-id (chaîne)

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

--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]/.

--all-pages (booléen)

Envoyez plusieurs requêtes pour afficher toutes les pages de la collection d'intégrations.

Exemple

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

`ibmcloud event-notifications integration`

Obtenir les détails d'une intégration à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle l'intégration est configurée.

ibmcloud event-notifications integration --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de 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-:_]*/.

Exemple

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

Modèles

IBM Cloud Event Notifications modèles.

`ibmcloud event-notifications template-create`

Créer un modèle pour les invitations et les notifications. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle vous configurez le modèle.

ibmcloud event-notifications template-create --instance-id INSTANCE-ID --name NAME --type TYPE --params PARAMS [--description DESCRIPTION]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance 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)

Nom du modèle. 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)

Type de modèle. Les types pris en charge sont smtp_custom.invitation, smtp_custom.notification, webhook.notification, slack.notification, pagerduty.notification, et event_streams.notification. 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)

Les paramètres du modèle pour la notification. Obligatoire. Voir les paramètres du 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.

--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-_\/.?:'";,+=!#@$%^&*() ]*/.

--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 d'un e-mail. Les types pris en charge sont smtp_custom.notification et smtp_custom.invitation.

ibmcloud event-notifications template-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=exampleString \
  --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

`ibmcloud event-notifications templates`

Répertoriez tous les modèles définis par l'utilisateur qui ont été créés pour une instance d' Event Notifications. Vous devez fournir l'ID de l'instance.

Si vous ne définissez pas l'option --all-pages, la commande ne récupère qu'une seule page de la collection.

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

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--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écalage des 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

`ibmcloud event-notifications template`

Obtenez les détails d'un modèle à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle le modèle est configuré.

ibmcloud event-notifications template --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance 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 du modèle. Obligatoire.

Exemple

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

`ibmcloud event-notifications template-update`

Mettre à jour les détails d'un modèle existant créé sous une instance d' Event Notifications.

ibmcloud event-notifications template-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--params PARAMS]

Vous pouvez utiliser template-update à la place de template-replace. Ces deux commandes sont actuellement prises en charge, mais template-replace seront obsolètes dans une prochaine version.

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique du modèle. Obligatoire.

--name (chaîne)

Nom du modèle mis à jour.

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 mise à jour 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 (TemplateConfig)

Les paramètres du modèle mis à jour. Voir les paramètres du 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-replace \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --params='{"body": "exampleString", "subject": "exampleString"}'

`ibmcloud event-notifications template-delete`

Supprimer un modèle à l'aide de son ID. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle le modèle est configuré.

ibmcloud event-notifications template-delete --instance-id INSTANCE-ID --id ID [--force]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique du modèle. Obligatoire.

-f, --force (booléen)

Forcer l'exécution de la commande.

Exemple

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

`ibmcloud event-notifications pre-defined-templates`

Liste des modèles prédéfinis pour une instance d' Event Notifications.

Si vous ne définissez pas l'option --all-pages, la commande ne récupère qu'une seule page de la collection.

ibmcloud event-notifications pre-defined-templates --instance-id INSTANCE-ID [--source SOURCE] [--type TYPE] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--source (chaîne)

Le type de source du modèle prédéfini. 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)

Le type de modèle pour le modèle prédéfini, en fonction de la 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écalage des 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 prédéfinis.

Exemple

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

`ibmcloud event-notifications pre-defined-template`

Obtenir les détails d'un modèle prédéfini à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications e pour laquelle le modèle prédéfini est configuré.

ibmcloud event-notifications pre-defined-template --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne): Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.
--id (chaîne): Identifiant unique du modèle prédéfini. Obligatoire.

Exemple

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

Configurations SMTP

IBM Cloud Event Notifications Configurations SMTP.

`ibmcloud event-notifications smtp-configuration-create`

Configurez un serveur SMTP pour l'envoi d'e-mails. Pour plus d'informations, consultez la section Configurations SMTP.

ibmcloud event-notifications smtp-configuration-create --instance-id INSTANCE-ID --name NAME --domain DOMAIN [--description DESCRIPTION]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--name (chaîne)

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)

Le nom de domaine pour la configuration SMTP. 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

`ibmcloud event-notifications smtp-configurations`

Répertorier toutes les configurations SMTP d'une instance d' Event Notifications.

Si vous ne définissez pas l'option --all-pages, la commande ne récupère qu'une seule page de la collection.

ibmcloud event-notifications smtp-configurations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--all-pages]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--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écalage des 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)

Lancez plusieurs requêtes pour afficher toutes les pages de la collection de configurations SMTP.

Exemple

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

`ibmcloud event-notifications smtp-user-create`

Créer un utilisateur SMTP pour une configuration SMTP. Vous devez fournir l'ID de la configuration SMTP et l'ID de l'instance d' Event Notifications.

Les identifiants SMTP ne s'affichent qu'une seule fois. Copiez-les et conservez-les en lieu sûr, car ils ne pourront plus être récupérés ultérieurement.

ibmcloud event-notifications smtp-user-create --instance-id INSTANCE-ID --id ID [--description DESCRIPTION] [--username-to-clone USERNAME-TO-CLONE]

Options de commande

--instance-id (chaîne)

Identifiant unique de l'instance IBM Cloud Event Notifications. Obligatoire.

--id (chaîne)

Identifiant unique de la configuration SMTP. Obligatoire.

--description (chaîne)

Description de l'utilisateur 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)

Le nom d'utilisateur de l'utilisateur SMTP à 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

`ibmcloud event-notifications smtp-users`

Répertorier tous les utilisateurs SMTP d'une configuration SMTP.

Si l'option --all-pages n'est pas définie, la commande ne récupère qu'une seule page de la collection.

ibmcloud event-notifications smtp-users --instance-id INSTANCE-ID --id ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

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

`ibmcloud event-notifications smtp-configuration`

Obtenir des détails sur la configuration SMTP d'une instance d' Event Notifications.

ibmcloud event-notifications smtp-configuration --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

Exemple

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

`ibmcloud event-notifications smtp-configuration-update`

Mettre à jour une configuration SMTP à l'aide de son identifiant. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle la configuration SMTP est définie.

ibmcloud event-notifications smtp-configuration-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

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

`ibmcloud event-notifications smtp-configuration-delete`

Supprimer une configuration SMTP à l'aide de son ID. Vous devez également fournir l'ID de l'instance d' Event Notifications pour laquelle la configuration SMTP est définie.

ibmcloud event-notifications smtp-configuration-delete --instance-id INSTANCE-ID --id ID [--force]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

Exemple

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

`ibmcloud event-notifications smtp-user`

Obtenez les détails d'un utilisateur SMTP à l'aide de l'ID utilisateur et de l'ID de configuration SMTP.

ibmcloud event-notifications smtp-user --instance-id INSTANCE-ID --id ID --user-id USER-ID

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

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

`ibmcloud event-notifications smtp-user-update`

Mettez à jour un utilisateur SMTP à l'aide de l'ID utilisateur et de l'ID de configuration SMTP.

ibmcloud event-notifications smtp-user-update --instance-id INSTANCE-ID --id ID --user-id USER-ID [--description DESCRIPTION]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

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

`ibmcloud event-notifications smtp-user-delete`

Supprimez un utilisateur SMTP à l'aide de son ID utilisateur et de son ID de configuration SMTP.

ibmcloud event-notifications smtp-user-delete --instance-id INSTANCE-ID --id ID --user-id USER-ID [--force]

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

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

`ibmcloud event-notifications smtp-allowed-ips`

Obtenir toutes les adresses IP autorisées pour une configuration SMTP.

ibmcloud event-notifications smtp-allowed-ips --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

Exemple

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

`ibmcloud event-notifications smtp-allowed-ips-update`

La prise en charge de l'ancienne liste blanche a été dépréciée. La liste blanche est désormais activée via les restrictions basées sur le contexte. Pour plus d'informations, consultez la section Configurations SMTP.

`ibmcloud event-notifications verify-smtp-update`

Vérifier la configuration SMTP du domaine pour SPF, SKIM et en_authorization.

ibmcloud event-notifications verify-smtp-update --instance-id INSTANCE-ID --id ID --type TYPE

Options de commande

--instance-id (chaîne)

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

--id (chaîne)

Identifiant unique pour SMTP. Obligatoire.

--type (chaîne)

Type de vérification SMTP. Les valeurs autorisées sont spf, dkim, et en_authorization. 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

Mesures

`ibmcloud event-notifications metrics`

Récupérer les métriques d'une instance d' Event Notifications.

ibmcloud event-notifications metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT]

Options de commande

--instance-id (chaîne)

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

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

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

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

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

--subscription-id (chaîne)

Identificateur unique de l'abonnement.

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

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

`ibmcloud event-notifications bounce-metrics`

Récupérer les indicateurs de rebond pour une instance d' Event Notifications.

ibmcloud event-notifications bounce-metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT] [--limit LIMIT] [--offset OFFSET]

Options de commande

--instance-id (chaîne)

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

--gte (chaîne)

Horodatage de début supérieur ou égal à (GTE) en UTC. Obligatoire.

--lte (chaîne)

Horodatage de début Less than equal (LTE) en UTC. Obligatoire.

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

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

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

--subscription-id (chaîne)

Identificateur unique de l'abonnement.

--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 e-mail du destinataire.

--notification-id (chaîne)

ID de notification.

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

Obtenir l'état des notifications

`ibmcloud event-notifications notifications-status`

Obtenir le statut de notification pour une notification de test de destination de webhook.

ibmcloud event-notifications notifications-status --instance-id INSTANCE-ID --id ID

Options de commande

--instance-id (chaîne)

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

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

Exemple

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

Envoyer des notifications

Envoyez des événements depuis vos applications backend à l'aide de sources API. L' Event Notifications prend en charge deux modes de contenu CloudEvents:

**Mode binaire** — Les données de l'événement sont placées telles quelles dans le corps de la requête HTTP , l' `datacontenttype` attribut Media-Type indiquant leur type de média dans l' `Content-Type` en-tête Header.
Tous les autres attributs sont mappés vers des en-têtes de type HTTP préfixés par `ce-`. Les requêtes sont traitées en mode binaire lorsque les attributs obligatoires CloudEvents (`specversion`, `id`, `type`, et `source`) sont transmis en en-têtes.
Mode structuré — Les métadonnées et les données d'événement sont placées dans le corps de la requête HTTP. Définissez l'en-tête Content-Type sur application/cloudevents+json. Les attributs obligatoires (specversion, id, type, et source) doivent figurer dans le corps de la requête. Le champ datacontenttype est obligatoire et doit être défini sur application/json.

`ibmcloud event-notifications send-notifications`

Envoyer une notification depuis une instance du service. Pour plus d'informations sur le contenu des notifications, consultez la documentation.

ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY]

Options de commande

--instance-id (chaîne)

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

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

NotificationCreate

L'exemple suivant illustre le format de l'objet NotificationCreate.

{
  "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" : "[\"886f8f4c-8605-47hb-85a1-8682b9377468483\"]",
  "ibmenmailto" : "exampleString",
  "ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]",
  "ibmensmsto" : "exampleString",
  "ibmenmms": {"content": "VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO","content_type": "image/png"},
  "ibmenmarkdownn": "This is a *italic* message.\n- Item 1\n- Item 2\n**bold text** with more text data\n~~strike through~~\n1. order 1\n2. order 2\n```fenced code block```\n> block code\n`code`\n[Click here](https://example.com) for more info."
    "ibmenhtmlbody" : "exampleString",
    "subject" : "exampleString",
   "attachments": [
    {
      "content": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQK",
      "filename": "test.txt",
      "content_type": "text/plain",
      "disposition": "attachment"
    }
    ],
    "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" : "{ }"
}

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.

paramètres de la plate-forme iOS
Propriété	Type de propriété	Description
`badge`	integer	Numéro à afficher en tant que badge de l'icône de l'application.
`interactive_category`	chaîne	Identificateur de catégorie à utiliser pour les notifications push interactives.
`ios_action_key`	chaîne	Titre de la clé d'action.
`payload`	Objet JSON	Contenu JSON personnalisé qui est envoyé dans le cadre du message de notification.
`sound`	chaîne	Nom du fichier son dans le bundle d'applications. Le son de ce fichier est utilisé pour une alerte.
`title_loc_key`	chaîne	Clé d'une chaîne de titre dans le fichier Localizable.strings pour la localisation en cours. La chaîne de clé peut être formatée avec les spécificateurs %@ et %n$@ pour inclure les variables spécifiées dans le tableau titleLocArgs.
`loc_key`	chaîne	Clé d'une chaîne de message d'alerte dans un fichier Localizabl.strings pour la localisation en cours (qui est définie par la préférence de langue de l'utilisateur). La chaîne de clé peut être formatée avec les spécificateurs %@ et %n$@ pour inclure les variables spécifiées dans le tableau locArgs.
`launch_image`	chaîne	Nom de fichier d'un fichier image dans le bundle de l'application, avec ou sans extension. L'image est utilisée comme image de lancement lorsque les utilisateurs appuient sur le bouton d'action ou déplacement le curseur d'action.
`title_loc_args`	chaîne	Valeurs de chaîne de variables à afficher à la place des spécificateurs de format dans title-loc-key.
`loc_args`	chaîne	Valeurs de chaîne de variables à afficher à la place des spécificateurs de format dans locKey.
`title`	chaîne	Titre des notifications push Rich (pris en charge sous iOS 10 et versions ultérieures uniquement).
`subtitle`	chaîne	Sous-titre des notifications enrichies (pris en charge sous iOS 10 et versions ultérieures uniquement).
`body`	chaîne	Corps des notifications iOS.
`attachment_url`	chaîne	Lien vers le support des notifications iOS (vidéo, audio, GIF, images - pris en charge sous iOS 10 et versions ultérieures uniquement).
`type`	chaîne	Valeurs admises : DEFAULT, MIXED, SILENT.
`apns_collapse_id`	chaîne	Plusieurs notifications avec le même identificateur de réduction sont affichées à l'utilisateur sous forme de notification unique.
`apns_thread_id`	chaîne	Identificateur spécifique à l'application pour le regroupement des notifications associées. Cette valeur correspond à la propriété threadIdentifier de l'objet UNNotificationContent.
`apns_group_summary_arg`	chaîne	Chaîne que la notification ajoute à la chaîne de format récapitulative de la catégorie.
`apns_group_summary_arg_count`	integer	ombre d'éléments que la notification ajoute à la chaîne de format récapitulative de la catégorie.

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

Paramètres de la plate-forme Android
Propriété	Type de propriété	Description
`icon`	chaîne	Indiquez le nom de l'icône à afficher pour la notification. Assurez-vous que l'icône est déjà incluse dans le package de l'application client.
`delay_while_idle`	Booléen	Lorsque cette valeur est définie sur true, ce paramètre indique que le message ne doit pas être envoyé tant que le périphérique n'est pas actif.
`sync`	Booléen	La messagerie de groupe de périphériques permet à chaque instance d'application d'un groupe de refléter le dernier état de messagerie.
`visibility`	chaîne	privé ou public - Visibilité de cette notification, qui détermine comment et quand les notifications s'affichent sur un écran verrouillé et sécurisé.
`redact`	chaîne	Le contenu spécifié s'affiche sur un écran verrouillé sécurisé sur le périphérique lorsque la visibilité est définie sur Privé.
`payload`	Objet JSON	Contenu JSON personnalisé qui est envoyé dans le cadre du message de notification.
`priority`	chaîne	Valeur de chaîne qui indique la priorité de cette notification. Les valeurs autorisées sont 'max', 'high', 'default', 'low' et 'min'. Les notifications de priorité élevée (high/max) associées à une zone 'sound' peuvent être utilisées comme notifications d'avertissement dans Android version 5.0 ou higher.sampleval='low'.
`sound`	chaîne	Fichier son (sur l'appareil) qui sera tenté de jouer lors de l'arrivée de la notification sur l'appareil.
`time_to_live`	integer	Indique la durée (en secondes) de conservation du message dans le stockage GCM si le périphérique est hors ligne.
`lights`		Définit la couleur du voyant de notification lors de la réception d'une notification push.
`ledArgb`	chaîne	Couleur du voyant. Le matériel utilise sa meilleure approximation.
`ledOnMs`	integer	Durée d'allumage du voyant (en millisecondes) lorsqu'il clignote. Le matériel utilise sa meilleure approximation.
`ledOffMs`	chaîne	Durée d'extinction du voyant (en millisecondes) lorsqu'il clignote. Le matériel utilise sa meilleure approximation.
`android_title`	chaîne	Titre des notifications push Rich.
`group_id`	chaîne	Définissez cette notification pour qu'elle fasse partie d'un groupe de notifications partageant la même clé. Les notifications groupées peuvent s'afficher dans un cluster ou une pile sur des appareils qui prennent en charge ce rendu.
`style`		Options à spécifier pour les notifications extensibles Android. Les types de notifications extensibles sont picture_notification, bigtext_notification, inbox_notification.
`type`	chaîne	Spécifie le type des notifications extensibles. Les valeurs possibles sont bigtext_notification, picture_notification, inbox_notification.
`title`	chaîne	Spécifie le titre de la notification. Le titre s'affiche lorsque la notification est développée. Un titre doit être spécifié pour les trois notifications pouvant être développées.
`type`	chaîne	Valeurs autorisées : DEFAULT, SILENT.
`alert`	chaîne	Valeur d'alerte de la notification.

Des scripts d'échantillon

Vous pouvez utiliser les scripts suivants pour faciliter le développement.

Exemple de script pour Event Notifications provisioning using CLI

Le script provision_event_notification.sh automatise le provisionnement et la configuration d'une instance Event Notifications.

Exemple de script pour l'intégration des notifications de plate-forme à l'aide de l'interface de programmation

Le script en-platform-notification-src-and-email-dest.sh intègre les notifications de la plateforme avec Event Notifications et achemine les notifications vers IBM Inbuilt Email ou Custom Domain Sandbox.

Exemple de script pour l'intégration de IBM Cloud Logs à l'aide de l'interface de programmation

Le script en-icl-src-and-email-dest.sh intègre IBM Cloud Logs avec Event Notifications et achemine les notifications vers IBM Inbuilt Email ou Custom Domain Sandbox.

Ce script suppose que les instances IBM Cloud Logs et Event Notifications se trouvent sur le même compte.