CLI Event Notifications

L'interfaccia della riga di comando (CLI) di IBM Cloud offre funzionalità aggiuntive per l'offerta di servizi. La CLI di IBM Cloud supporta un framework plug-in per estenderne le funzionalità. È possibile installare il plug-in CLI di Event Notifications dal repository dei plug-in di IBM Cloud. Con il plug-in CLI del servizio Event Notifications, è possibile gestire facilmente le istanze del servizio Event Notifications utilizzando i comandi CLI disponibili.

Prerequisiti

Quando accedi alla CLI di IBM Cloud, ricevi una notifica quando sono disponibili degli aggiornamenti. Assicurati di tenere aggiornata la tua CLI in modo da poter usare i comandi e gli indicatori disponibili per il plugin della CLI Event Notifications.

Scheda di riferimento rapido IBM Cloud.

Nota: le versioni del plugin CLI precedenti alla 1.15.2 sono obsolete

Installa la CLI Event Notifications

Installare il plug-in CLI di Event Notifications utilizzando il comando plugin install .

ibmcloud plugin install en

Event Notifications Comandi CLI

Nota Il comando CLI Plugin init sarà deprecato in futuro

ibmcloud it it-list

Elenca le istanze nella regione di destinazione impostata. È possibile recuperare il GUID dell'istanza dalle istanze elencate.

ibmcloud en en-list

impostazione delle variabili d'ambiente di ibmcloud event-notifications

Imposta la regione su cui lavorerai configurando la regione di destinazione IBM Cloud: ibmcloud target -r <region> oppure esporta l'endpoint regionale tramite la variabile IBMCLOUD_EN_ENDPOINT; ad esempio, per Sydney utilizza quanto segue:

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

  • esportare la variabile IBMCLOUD_EN_ENDPOINT per impostare l'endpoint pubblico della regione Event Notifications.

    • Dallas: https://us-south.event-notifications.cloud.ibm.com/event-notifications
    • Londra: https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sydney: https://au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Francoforte: 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
    • San Paolo: https://br-sao.event-notifications.cloud.ibm.com/event-notifications
    • Montreal: 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
  • esportare la variabile IBMCLOUD_EN_ENDPOINT per impostare l'endpoint privato della regione Event Notifications.

    • Dallas: https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
    • Londra: https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
    • Sydney: https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
    • Francoforte: 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
    • San Paolo: https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications
    • Montreal: 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
  • esportare la variabile EVENT_NOTIFICATIONS_API_KEY per impostare l'istanza Event Notifications apikey.

EVENT_NOTIFICATIONS_API_KEY può essere la tua chiave API IBM Cloud o la chiave API delle credenziali di servizio dalla tua istanza Event Notifications.

Origini

Operare su IBM Cloud Event Notifications fonte.

ibmcloud creazione fonte notifiche eventi

  • Azione: Creare Source.

Attualmente la CLI supporta solo la creazione di sorgenti API.

ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]
  • Parametri da fornire:
--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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 (int64)

Il nome da fornire per l'origine API.

Il valore predefinito è . La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (stringa)

La descrizione della fonte. Facoltativo.

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--enabled ENABLED (booleano)

Il flag booleano per abilitare o disabilitare la sorgente. Facoltativo.

Il valore è impostato su true per abilitare la sorgente e su false per disabilitarla.

--store-notifications (bool)

Consente di visualizzare il contenuto degli eventi in arrivo ai fini della risoluzione dei problemi.

Il valore predefinito è false.

ibmcloud evento-notifiche aggiornamento sorgente

  • Azione: Aggiornare Source.
ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS]
  • Parametri da fornire:
--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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 (int64)

Nome della fonte API.

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 1 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (int64)

Fonte API Descrizione

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--enabled (booleano)

Stringa di ricerca per il filtro dei risultati.

Il valore è impostato su true per abilitare la sorgente e su false per disabilitarla.

--store-notifications (bool)

abilitare la visualizzazione del payload degli eventi in arrivo per la risoluzione dei problemi.

Il valore predefinito è `false`.

`--id` (stringa)
:  Identificativo univoco dell'Origine. Obbligatorio.

   La lunghezza massima è di `100` i caratteri. La lunghezza minima è di `1` e carattere. Il valore deve corrispondere all'espressione regolare `/[a-zA-Z0-9-:_]*/`.

elenco delle fonti di notifica degli eventi ibmcloud

  • Azione: Elencare tutti i Source.
ibmcloud event-notifications sources [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parametri da fornire:
--limit LIMIT (int64)

Il limite di pagine per i risultati impaginati.

Il valore massimo è 100. Il valore minimo è 1.

--offset OFFSET (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search SEARCH (stringa)

La stringa di ricerca per filtrare i risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore unico per l' IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force]

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

ibmcloud notifiche-eventi fonte ottenere

  • Azione: Approfondisci l'argomento su Source.
ibmcloud event-notifications source --id ID --instance-id INSTANCE-ID
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco dell'Origine. Obbligatorio.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

--offset OFFSET

L'offset per i risultati impaginati.

--search SEARCH

La stringa di ricerca per filtrare i risultati.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force]

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

ibmcloud notifiche eventi fonte eliminare

  • Azione: Cancellare il sito Source.
ibmcloud event-notifications source-delete  --instance-id INSTANCE-ID --id ID
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco dell'Origine. Obbligatorio.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force]

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

Destinazioni

Operare su IBM Cloud Event Notifications destinazione.

ibmcloud event-notifications destinazione creare

  • Azione: Crea una destinazione.
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]
  • Parametri da fornire:
--instance-id (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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 (stringa)

Il nome della destinazione. Obbligatorio.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type TYPE (stringa)

Il tipo della destinazione. Le opzioni disponibili sono webhook, push_android, push_ios, push_chrome, push_firefox, push_huawei, push_safari, ibmce, ibmcos, msteams, pagerduty, servicenow, slack, smtp_custom, sms_custom, event_streams. Obbligatorio.

I valori consentiti sono: webhook, push_android, push_ios,push_chrome,push_firefox,push_huawei,push_safari,ibmce, ibmcos,msteams,pagerduty,servicenow,slack,smtp_custom,sms_custom,event_streams. La lunghezza minima è di 1.

--collect-failed-events (bool)

Se raccogliere l'evento non riuscito nel bucket Cloud Object Storage.

Il valore predefinito è `false`.

`--description DESCRIPTION` (stringa)
:  La descrizione della destinazione.

   Il valore predefinito è ` `. La lunghezza massima è di `255` i caratteri. La lunghezza minima è di `0` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/`.
--certificate CERTIFICATE (stringa)

Il percorso del file del certificato da fornire. Il tipo di file consentito è il certificato p8 e p12. Fornire il percorso del file in cui passare il certificato.

--certificate-content-type CERTIFICATE-CONTENT-TYPE (stringa)

Il tipo di contenuto del certificato da impostare nel caso di destinazione iOS. Il valore predefinito è ``. Le opzioni disponibili sono: p8 o p12.

--config CONFIG ( DestinationConfig esempi )

La configurazione necessaria per impostare i parametri specifici della destinazione.

Se si crea una destinazione senza " --config", la destinazione viene creata ma non funziona finché non viene configurata.

--icon16x16 (io.ReadCloser)
Icona Safari 16x16.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon16x16-content-type (stringa)

Il tipo di contenuto di Icon16x16.

--icon16x162x (io.ReadCloser)

Icona Safari 16x16@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon16x162x-content-type (stringa)

Il tipo di contenuto di Icon16x162x.

--icon32x32 (io.ReadCloser)

Icona di Safari 32x32.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x32-content-type (stringa)

Il tipo di contenuto di Icon32x32.

--icon32x322x (io.ReadCloser)

Icona di Safari 32x32@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x322x-content-type (stringa)

Il tipo di contenuto di Icon32x322x.

--icon128x128 (io.ReadCloser)

Icona di Safari 128x128.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x128-content-type (stringa)

Il tipo di contenuto di Icon128x128.

--icon128x1282x (io.ReadCloser)

Icona di Safari 128x128@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x1282x-content-type (stringa)

Il tipo di contenuto di Icon128x1282x.

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

Nota: Le Cloud Functions di destinazione Event Notifications sono state deprecate e non sono più supportate nella categoria delle destinazioni.

Esempi

  • L'esempio seguente mostra il formato dell'oggetto " DestinationConfig " per la destinazione " iOS " (push_ios) con certificato " P8 ". Impostare il parametro booleano pre_prod su true per configurare la destinazione come destinazione di pre-produzione, altrimenti impostare il valore su false:
   {
      "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'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " iOS " (push_ios) con certificato " P12 ". Impostare il parametro booleano `pre_prod` su *true* per configurare la destinazione come destinazione di pre-produzione, altrimenti impostare il valore su *false*.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione Chrome (push_chrome). Impostare il parametro booleano `pre_prod` su *true* per configurare la destinazione come destinazione di pre-produzione, altrimenti impostare il valore su *false*.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " Firefox " (push_firefox). Impostare il parametro booleano `pre_prod` su *true* per configurare la destinazione come destinazione di pre-produzione, altrimenti impostare il valore su *false*.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione Slack (slack) con il tipo incoming_webhook.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione Slack (slack) con il tipo direct_message.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione Safari (push_safari). Impostare il parametro booleano `pre_prod` su *true* per configurare la destinazione come destinazione di pre-produzione, altrimenti impostare il valore su *false*.

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione "MS Teams(msteams)".

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

- L'esempio seguente mostra il formato dell'oggetto `DestinationConfig` per la destinazione PagerDuty(pagerduty ).

   Si consiglia di utilizzare solo la chiave Routing durante la creazione della destinazione. La chiave API è deprecata e non potrà essere utilizzata in futuro.
   {: attention}

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


- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per Webhook(webhook).

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

- L'esempio seguente mostra il formato dell'oggetto push_android per la destinazione Android ( `DestinationConfig` ).

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


- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " ServiceNow(servicenow ").

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " Code Engine " (ibmce).

   codice motore tipo di destinazione: applicazione

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

   codice motore tipo di destinazione: lavoro

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


- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " IBM Cloud Object Storage " (ibmcos).

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


- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione Huawei (push_huawei).

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

- L'esempio seguente mostra il formato dell'oggetto dell' `DestinationConfig` e per la destinazione dell'e-mail personalizzata (smtp_custom). In caso di destinazione Sandbox e-mail personalizzata (smtp_custom_sandbox), i parametri di configurazione della destinazione non sono necessari.

   Processo Per eseguire la configurazione e la verifica del dominio personalizzato: <https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

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

- L'esempio seguente mostra il formato dell'oggetto " `DestinationConfig` " per la destinazione " Event Streams " (event_streams).

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

- L'esempio seguente mostra il formato dell'oggetto `DestinationConfig` per la destinazione App Configuration (app_configuration).

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

Nota: è possibile creare una destinazione SMS personalizzata senza `DestinationConfig`, ma questa non funzionerà finché i numeri personalizzati richiesti non saranno stati esplicitamente richiesti e configurati. Per richiedere numeri personalizzati, consultare il sito [Numeri personalizzati per SMS](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers).

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

- **Azione:** Elencare tutti i `Destination`.

```sh {: pre}
ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parametri da fornire:
--limit LIMIT (int64)

Il limite di pagine per i risultati impaginati.

Il valore massimo è 100. Il valore minimo è 1.

--offset OFFSET (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search SEARCH (stringa)

La stringa di ricerca per filtrare i risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--instance-id (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications destinazione get

  • Azione: Approfondisci l'argomento su Destination.
ibmcloud event-notifications destination --id ID --instance-id INSTANCE-ID
  • Parametri da fornire:
--id ID (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

aggiornamento della destinazione ibmcloud event-notifications

  • Azione: aggiornare il file esistente 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]
  • Parametri da fornire:
--instance-id (stringa)
Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.
La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificativo univoco della Destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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 (stringa)

Nome Destinazione.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (stringa)

Descrizione Destinazione.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (bool)

Se raccogliere l'evento non riuscito nel bucket Cloud Object Storage.

Il valore predefinito è false.

--config (DestinationConfig)

Payload che descrive la configurazione di una destinazione.

Fornire un'opzione stringa JSON o specificare un file JSON da cui leggere fornendo un'opzione filepath che inizia con @, ad esempio --config=@path/to/file.json.

--certificate (io.ReadCloser)

Certificato per APNS.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--certificate-content-type (stringa)

Il tipo di contenuto del Certificato.

--icon16x16 (io.ReadCloser)

Icona Safari 16x16.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon16x16-content-type (stringa)

Il tipo di contenuto di Icon16x16.

--icon16x162x (io.ReadCloser)

Icona Safari 16x16@2x.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon16x162x-content-type (stringa)

Il tipo di contenuto di Icon16x162x.

--icon32x32 (io.ReadCloser)

Icona di Safari 32x32.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon32x32-content-type (stringa)

Il tipo di contenuto di Icon32x32.

--icon32x322x (io.ReadCloser)

Icona di Safari 32x32@2x.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon32x322x-content-type (stringa)

Il tipo di contenuto di Icon32x322x.

--icon128x128 (io.ReadCloser)

Icona di Safari 128x128.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon128x128-content-type (stringa)

Il tipo di contenuto di Icon128x128.

--icon128x1282x (io.ReadCloser)

Icona di Safari 128x128@2x.

La lunghezza massima è di 5000 i caratteri. La lunghezza minima è di 1 e carattere.

--icon128x1282x-content-type (stringa)

Il tipo di contenuto di Icon128x1282x.

ibmcloud event-notifications destinazione eliminare

  • Azione: eliminare il file esistente Destination.
ibmcloud event-notifications destination-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parametri da fornire:
--id ID (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force] (booleano)

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

ibmcloud event-notifications enabled-countries

Ottenere i dettagli del paese di destinazione dell'SMS.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificativo univoco della Destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Esempio

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

ibmcloud event-notifications test-destination

Test di una destinazione.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificativo univoco della Destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

Esempio

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

ibmcloud event-notifications email-sandbox-destination-update

Aggiornare la destinazione sandbox alla produzione con un dominio personalizzato.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `32` i caratteri. La lunghezza minima è di `32` i caratteri. Il valore deve corrispondere all'espressione regolare `/[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 (stringa)

Identificativo univoco della Destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/.

--domain (stringa)

Dominio e-mail. Obbligatorio.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

Esempio

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

ibmcloud event-notifications verify-destination-update

Verificare i record SPF e DKIM del dominio personalizzato.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificativo univoco della Destinazione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--type (stringa)

Tipo di verifica. Obbligatorio.

La lunghezza massima è di 20 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-z]/.

Esempio

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

Argomenti

Operare sull'argomento IBM Cloud Event Notifications argomento.

argomento ibmcloud event-notifications create

  • Azione: Creare un nuovo Topic.
ibmcloud event-notifications topic-create --name NAME [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID
  • Parametri da fornire:
--name NAME (stringa)

Nome dell'Argomento Obbligatorio.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (stringa)

Descrizione dell'Argomento

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--instance-id INSTANCE-ID (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--sources SOURCES] (TopicCreateSourcesItem[])

Elenco delle fonti con le relative configurazioni dei filtri da allegare a questo argomento. Non si tratta semplicemente di un elenco di ID di origine: ogni voce include l'ID di origine e le regole di filtraggio che determinano quali eventi provenienti da quella origine vengono indirizzati a questo argomento. Consulta gli esempi per vedere la struttura completa.

Esempio

  • L'esempio seguente mostra il formato dell'oggetto TopicCreateSourcesItem[] per la sorgente Timer periodico.
    [
       {
          "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'esempio seguente illustra il formato dell'oggetto ` `TopicCreateSourcesItem[]` `.

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

- L'esempio seguente illustra il formato dell'oggetto ` `TopicUpdateSourcesItem[]` `.

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

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

- **Azione:** Elencare tutti i `Topic`.

```sh {: pre}
ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID
  • Parametri da fornire:
--limit LIMIT (int64)

Il limite di pagine per i risultati impaginati.

Il valore massimo è 100. Il valore minimo è 1.

--offset OFFSET (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search SEARCH (stringa)

La stringa di ricerca per filtrare i risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

argomento ibmcloud event-notifications get

  • Azione: Approfondisci l'argomento su Topic.
ibmcloud event-notifications topic --id ID [--include INCLUDE] --instance-id INSTANCE-ID
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco dell'Argomento. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

--include INCLUDE (stringa)

Include tutti gli argomenti secondari.

Il valore predefinito è ``. La lunghezza massima è di 20 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-z]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

aggiornamento dell'argomento ibmcloud event-notifications

  • Azione: aggiornare il file esistente Topic.
ibmcloud event-notifications topic-replace --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID
  • Parametri da fornire:
--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (stringa)

Identificativo univoco dell'Argomento. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--name (stringa)

Nome dell'Argomento

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (stringa)

Descrizione dell'Argomento

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--sources (TopicUpdateSourcesItem[])

Elenco delle nuove fonti con le relative configurazioni dei filtri da aggiungere a questo argomento. Non si tratta semplicemente di un elenco di ID di origine: ogni voce include l'ID di origine e le regole di filtraggio che determinano quali eventi provenienti da quella origine vengono indirizzati a questo argomento. Consulta gli esempi per vedere la struttura completa.

Questo flag aggiunge solo nuove fonti. Le fonti già associate all'argomento non possono essere sostituite né aggiornate: possono solo essere eliminate e aggiunte nuovamente. Per modificare i filtri di origine, rimuovere prima l'origine dall'argomento e poi aggiungerla nuovamente con la nuova configurazione del filtro.

eliminazione dell'argomento ibmcloud event-notifications

  • Azione: eliminare il file esistente Topic.
ibmcloud event-notifications topic-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco dell'Argomento. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force] (booleano)

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

Sottoscrizioni

Operare su IBM Cloud Event Notifications in abbonamento.

ibmcloud event-notifications crea abbonamento

  • Azione: Creare un nuovo Subscription.
ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES]
  • Parametri da fornire:
--name NAME (stringa)

Il nome da impostare per la sottoscrizione.

La lunghezza massima è di 50 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--description DESCRIPTION (stringa)

La descrizione da impostare per la sottoscrizione.

Il valore predefinito è ``. La lunghezza massima è di 255 caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--destination-id DESTINATION-ID (stringa)

L'ID di destinazione da impostare per la sottoscrizione.

La lunghezza massima è di 150 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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 TOPIC-ID (stringa)

L'ID dell'argomento da impostare per la sottoscrizione.

La lunghezza massima è di 150 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

--attributes ATTRIBUTES (SubscriptionCreateAttributes)

Gli attributi da impostare per la sottoscrizione.

Esempi

  • L'esempio seguente mostra il formato dell'oggetto SubscriptionCreateAttributes per i webhook.
   {
      "signing_enabled" : true,
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
   }
   ```

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per gli SMS.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per IBM Email.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per il tipo di destinazione Slack come incoming_webhook.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per il tipo di destinazione Slack come direct_message.

```json
{
   "channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
   "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
}
  • L'esempio seguente mostra il formato dell'oggetto SubscriptionCreateAttributes per ServiceNow.
   {
      "assigned_to" : "serviceuser@gmail.com",
      "assignment_group" : "incidentgroup"
   }
   ```

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per l'e-mail personalizzata.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per Custom Email Sandbox.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG",
      "from_email":"Testuser@mailx.com",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```
   - L'esempio seguente mostra il formato dell'oggetto " `SubscriptionCreateAttributes` " per Pagerduty/ Event Streams.

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per App Configuration. Quando si crea o si aggiorna un abbonamento per una **App Configuration** l'oggetto `attributes` ha una regola specifica:
      - Devi includere **uno dei due **`feature_flag_enabled` **O **`template_id_notification`
      - **Non** è possibile includere entrambe le proprietà contemporaneamente

      Ciò garantisce che venga creato un abbonamento per il caso d'uso corretto — ovvero **la valutazione dei flag di funzionalità** o **la creazione di modelli di notifica**, ma non entrambi contemporaneamente.

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

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

- **Azione:** Elencare tutti i `Subscription`.

```sh {: pre}
ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] --instance-id INSTANCE-ID
  • Parametri da fornire:
--limit LIMIT (int64)

Il limite di pagine per i risultati impaginati.

Il valore massimo è 100. Il valore minimo è 1.

--offset OFFSET (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search SEARCH (stringa)

La stringa di ricerca per filtrare i risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud notifiche-eventi abbonamento ottenere

  • Azione: Approfondisci l'argomento su Subscription.
ibmcloud event-notifications subscription --id ID --instance-id INSTANCE-ID
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco della Sottoscrizione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

eliminazione dell'abbonamento a ibmcloud event-notifications

  • Azione: eliminare il file esistente Subscription.
ibmcloud event-notifications subscription-delete --id ID --instance-id INSTANCE-ID [--force]
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco della Sottoscrizione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco per l'istanza IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--force] (booleano)

Attivare per forzare l'eliminazione della risorsa (per evitare la richiesta di conferma).

aggiornamento dell'abbonamento a ibmcloud event-notifications

  • Azione: aggiornare il file esistente Subscription.
ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]
  • Parametri da fornire:
--id ID (stringa)

Identificativo univoco della Sottoscrizione. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

[--name NAME] (stringa)

La descrizione aggiornata da impostare per la sottoscrizione.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

--instance-id INSTANCE-ID (stringa)

L'identificatore unico per l' IBM Cloud Event Notifications. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

[--description DESCRIPTION] (stringa)

La descrizione aggiornata da impostare per la sottoscrizione.

Il valore predefinito è ``. La lunghezza massima è di 100 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

[-attributes ATTRIBUTES] (SubscriptionUpdateAttributes)

Gli attributi da impostare per la sottoscrizione

Esempi

  • L'esempio seguente mostra il formato dell'oggetto SubscriptionUpdateAttributes per Webhook.
   {
      "signing_enabled": true
   }
   ```

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per IBM SMS.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per IBM Email.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per l'e-mail personalizzata.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per Custom Email Sandbox.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per Slack per il tipo `incoming_webhook`.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per Slack per il tipo `direct_message`.

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

- L'esempio seguente mostra il formato dell'oggetto `SubscriptionUpdateAttributes` per Service Now.

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

   - L'esempio seguente mostra il formato dell'oggetto " `SubscriptionUpdateAttributes` " per Pagerduty/ Event Streams.

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

   - L'esempio seguente mostra il formato dell'oggetto `SubscriptionCreateAttributes` per App Configuration. Quando si crea o si aggiorna un abbonamento per una **App Configuration** l'oggetto `attributes` ha una regola specifica:
      - Devi includere **uno dei due **`feature_flag_enabled` **O **`template_id_notification`
      - **Non** è possibile includere entrambe le proprietà contemporaneamente
               Ciò garantisce che venga creato un abbonamento per il caso d'uso corretto: **la valutazione dei flag di funzionalità** o **la creazione di modelli di notifica**, ma non entrambi contemporaneamente.

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

## Integrazioni {: #en-cli-integration}

Operare su IBM Cloud Event Notifications integrazione.

### integrazione delle notifiche degli eventi ibmcloud Creare {: #en-cli-integration-create-command}

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

Opzioni comando

--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza.

 La lunghezza massima è di `36` i caratteri. La lunghezza minima è di `36` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--type (stringa)

Tipo di integrazione collect_failed_events.

La lunghezza massima è di 50 i caratteri. La lunghezza minima è di 1 i caratteri. Il valore consentito è collect_failed_events.

--metadata (IntegrationCreateAttributes)

Schema di integrazione per l'aggiornamento

Metadati necessari per l'integrazione.

Esempi

  • L'esempio seguente illustra il formato dell'oggetto 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"
   }
   ```

### integrazione di eventi e notifiche ibmcloud sostituite {: #en-cli-integration-update-command}

Sostituire `Integration`.

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

Opzioni comando

--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza.

 La lunghezza massima è di `36` i caratteri. La lunghezza minima è di `36` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--type (stringa)

Tipo di integrazione KMS/hs-crypto (deprecato).

La lunghezza massima è di 50 i caratteri. La lunghezza minima è di 1 i caratteri. I valori ammessi sono KMS e collect_failed_events. Nota: il tipo hs-crypto è ormai deprecato. Non saranno supportate nuove risorse di integrazione con il tipo hs-crypto.

--metadata (IntegrationReplaceAttributes)

Schema di integrazione per l'aggiornamento

Metadati necessari per l'integrazione.

--id (stringa)

Identificatore unico per l'integrazione. Obbligatorio.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

Esempi

  • L'esempio seguente mostra il formato dell'oggetto IntegrationReplaceAttributes per kms.
   {
      "endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
      "crn" : "crn of key protect",
      "root_key_id" : "root key id"
   }
   ```

### elenco di integrazione di ibmcloud event-notifications {: #en-cli-integration-list-command}

Elenca tutti i siti `Integrations`.

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

Opzioni comando

--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza.

 La lunghezza massima è di `36` i caratteri. La lunghezza minima è di `36` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore minimo è 0.

--search (stringa)

Stringa di ricerca per il filtro dei risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

ibmcloud event-notifications Integrazione ottenere

Ottenere specifiche Integration.

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

Opzioni comando

--instance-id (stringa)

Identificatore univoco per l'istanza IBM Cloud Event Notifications istanza.

 La lunghezza massima è di `36` i caratteri. La lunghezza minima è di `36` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore unico per l'integrazione. Obbligatorio.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

Modelli

IBM Cloud Event Notifications Modelli.

ibmcloud event-notifications template-create

Creare un nuovo modello.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[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 (stringa)

Il template messaggio. Obbligatorio.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (stringa)

Il tipo di modello. Obbligatorio.

La lunghezza massima è di 24 i caratteri. La lunghezza minima è di 22 i caratteri. Il valore deve corrispondere all'espressione regolare /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Dati utili che descrivono una configurazione del modello. Obbligatorio.

Questa opzione JSON può invece essere fornita impostando i singoli campi con altre opzioni. Si esclude a vicenda da queste opzioni.

Fornire un'opzione stringa JSON o specificare un file JSON da cui leggere fornendo un'opzione filepath che inizia con @, ad esempio --params=@path/to/file.json.

--description (stringa)

La descrizione del modello.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params-body (stringa)

Corpo del modello. Questa opzione fornisce un valore per un sottocampo dell'opzione JSON "params". È un'opzione che si esclude a vicenda.

La lunghezza massima è di 20000 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

--params-subject (stringa)

L'oggetto del modello. Questa opzione fornisce un valore per un sottocampo dell'opzione JSON "params". È un'opzione che si esclude a vicenda.

La lunghezza massima è di 1000 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

Esempi

  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per la posta elettronica. Il tipo supportato è smtp_custom.notification|smtp_custom.invitation
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type smtp_custom.notification \
    --params '{"body": "exampleString", "subject": "exampleString"}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per Slack. Il tipo supportato è slack.notification.
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per Webhook. Il tipo supportato è webhook.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto " TemplateConfig " per Pagerduty. Il tipo supportato è pagerduty.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto " TemplateConfig " per " Event Streams ". Il tipo supportato è event_streams.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per Code Engine Job. Il tipo supportato è ibmcejob.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per Code Engine Applicazione/Funzione. Il tipo supportato è ibmceapp.notification
ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString
  • L'esempio seguente mostra il formato dell'oggetto TemplateConfig per App Configuration. Il tipo supportato è 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

Elencare tutti i modelli. Nota: Se l'opzione --all-pages non è impostata, il comando recupera solo una singola pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore predefinito è 10. Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore predefinito è 0. Il valore minimo è 0.

--search (stringa)

Stringa di ricerca per il filtro dei risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (bool)

Eseguire più richieste per visualizzare tutte le pagine della raccolta dei modelli.

Esempio

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

ibmcloud event-notifications template

Ottieni i dettagli di un modello.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `32` i caratteri. La lunghezza minima è di `32` i caratteri. Il valore deve corrispondere all'espressione regolare `/[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 (stringa)

Identificatore univoco del modello. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

ibmcloud event-notifications template-replace

Aggiornare i dettagli di un modello.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco del modello. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--name (stringa)

Nome modello.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (stringa)

Descrizione del modello.

La lunghezza massima è di 255 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (stringa)

Il tipo di modello.

La lunghezza massima è di 24 i caratteri. La lunghezza minima è di 22 i caratteri. Il valore deve corrispondere all'espressione regolare /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Dati utili che descrivono una configurazione del modello. Questa opzione JSON può invece essere fornita impostando i singoli campi con altre opzioni. Si esclude a vicenda da queste opzioni.

Fornire un'opzione stringa JSON o specificare un file JSON da cui leggere fornendo un'opzione filepath che inizia con @, ad esempio --params=@path/to/file.json.

Esempi

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

ibmcloud event-notifications template-delete

Eliminare un modello.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco del modello. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

ibmcloud event-notifications pre-defined-templates

Elenca tutti i modelli predefiniti.

Se l'opzione --all-pages non è impostata, il comando recupera solo una singola pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `32` i caratteri. La lunghezza minima è di `32` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.
--source (stringa)

Tipo di fonte. Obbligatorio.

La lunghezza massima è di 50 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

--type (stringa)

Tipo di destinazione. Obbligatorio.

La lunghezza massima è di 50 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore predefinito è 10. Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore predefinito è 0. Il valore minimo è 0.

--search (stringa)

Stringa di ricerca per il filtro dei risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (bool)

Eseguire più richieste per visualizzare tutte le pagine della raccolta per i modelli predefiniti.

Esempio

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

Configurazioni SMTP

Configurazioni SMTP delle IBM Cloud Event Notifications.

ibmcloud event-notifications smtp-configuration-create

Crea una nuova configurazione SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[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 (stringa)

Il nome della configurazione SMTP. Obbligatorio.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--domain (stringa)

Nome dominio. Obbligatorio.

La lunghezza massima è di 512 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

--description (stringa)

Descrizione della configurazione SMTP.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Esempio

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

ibmcloud event-notifications smtp-configurations

Elenca tutte le configurazioni SMTP. Nota: Se l'opzione --all-pages non è impostata, il comando recupera solo una singola pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore predefinito è 10. Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore predefinito è 0. Il valore minimo è 0.

--search (stringa)

Stringa di ricerca per il filtro dei risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (bool)

Eseguire più richieste per visualizzare tutte le pagine della raccolta relativa alle configurazioni SMTP.

Esempio

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

ibmcloud event-notifications smtp-user-create

Crea un nuovo utente SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--description (stringa)

Descrizione della configurazione SMTP.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--username-to-clone (stringa)

fornire il nome dell'utente da clonare.

La lunghezza massima è di 20 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /^[a-z0-9]{18}\\d{2}$/.

Esempio

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

ibmcloud event-notifications smtp-users

Elenca tutti gli utenti SMTP. Nota: Se l'opzione --all-pages non è impostata, il comando recupera solo una singola pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore predefinito è 10. Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore predefinito è 0. Il valore minimo è 0.

--search (stringa)

Stringa di ricerca per il filtro dei risultati.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (bool)

Eseguire più richieste per visualizzare tutte le pagine della raccolta relativa agli utenti SMTP.

Esempio

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

ibmcloud event-notifications smtp-configuration

Ottenere i dettagli di una configurazione SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

ibmcloud event-notifications smtp-configuration-update

Aggiornare i dettagli di SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--name (stringa)

Nome SMTP.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (stringa)

Descrizione SMTP.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Esempio

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

ibmcloud event-notifications smtp-configuration-delete

Cancellare una configurazione SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

ibmcloud event-notifications smtp-user

Ottenere i dettagli di un utente SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 5 i caratteri. Il valore deve corrispondere all'espressione regolare /.*/.

Esempio

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

ibmcloud event-notifications smtp-user-update

Aggiornare i dettagli dell'utente SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 5 i caratteri. Il valore deve corrispondere all'espressione regolare /.*/.

--description (stringa)

Descrizione dell'utente SMTP.

La lunghezza massima è di 250 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Esempio

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

ibmcloud event-notifications smtp-user-delete

Eliminare un utente SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 5 i caratteri. Il valore deve corrispondere all'espressione regolare /.*/.

Esempio

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

ibmcloud event-notifications smtp-allowed-ips

Ottenere i dettagli di un IP SMTP consentito.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

ibmcloud event-notifications smtp-allowed-ips-update

Nota: Il supporto per l'allowlisting legacy è stato deprecato. Il supporto è stato abilitato tramite restrizioni basate sul contesto. Per informazioni dettagliate, fare riferimento qui: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-smtp-configurations#en-smtp-configurations-cbr

ibmcloud event-notifications verify-smtp-update

Verificare i record SPF e DKIM di SMTP.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

La lunghezza massima è di 32 i caratteri. La lunghezza minima è di 32 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--type (stringa)

SMTP Tipo di verifica. Obbligatorio.

La lunghezza massima è di 20 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /.*/.

Esempio

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

Metriche

ibmcloud event-notifications metrics

Ottenere le metriche.

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]

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--gte (stringa)

GTE (maggiore di uguale), timestamp iniziale in UTC. Obbligatorio.

La lunghezza massima è di 28 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[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 (stringa)

LTE (meno di uguale), timestamp finale in UTC. Obbligatorio.

La lunghezza massima è di 28 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (stringa)

ID configurazione SMTP. Obbligatorio quando si effettuano query sulle metriche relative alle destinazioni dell'interfaccia SMTP.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--destination-type (stringa)

Tipo di destinazione per la quale vengono richieste le metriche. Valore supportato: smtp_custom. Obbligatorio quando si effettuano query sulle metriche per destinazioni e-mail personalizzate.

I valori ammessi sono: smtp_custom.

--destination-id (stringa)

Identificativo univoco della Destinazione.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subscription-id (stringa)

Identificativo univoco della Sottoscrizione.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--source-id (stringa)

Identificativo univoco dell'Origine.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

--email-to (stringa)

Indirizzo e-mail del destinatario.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (stringa)

Notifica Id.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subject (stringa)

Oggetto dell'e-mail.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

Esempio

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

Ottieni le metriche di rimbalzo.

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]

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `32` i caratteri. La lunghezza minima è di `32` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.
--gte (stringa)

GTE (maggiore di uguale), timestamp iniziale in UTC. Obbligatorio.

La lunghezza massima è di 28 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[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 (stringa)

LTE (meno di uguale), timestamp finale in UTC. Obbligatorio.

La lunghezza massima è di 28 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (stringa)

ID configurazione SMTP. Obbligatorio quando si effettuano query sulle metriche relative alle destinazioni dell'interfaccia SMTP.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--destination-type (stringa)

Tipo di destinazione per la quale vengono richieste le metriche. Valore supportato: smtp_custom. Obbligatorio quando si effettuano query sulle metriche per destinazioni e-mail personalizzate.

I valori ammessi sono: smtp_custom.

--destination-id (stringa)

Identificativo univoco della Destinazione.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subscription-id (stringa)

Identificativo univoco della Sottoscrizione.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--source-id (stringa)

Identificativo univoco dell'Origine.

La lunghezza massima è di 100 i caratteri. La lunghezza minima è di 1 e carattere. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9-:_]*/.

--email-to (stringa)

Indirizzo e-mail del destinatario.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (stringa)

Notifica Id.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--subject (stringa)

Oggetto dell'e-mail.

La lunghezza massima è di 256 i caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--limit (int64)

Limite pagina per i risultati riportati nella pagina.

Il valore predefinito è 10. Il valore massimo è 100. Il valore minimo è 1.

--offset (int64)

offset dei risultati paginati.

Il valore predefinito è 0. Il valore minimo è 0.

Esempio

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

Ottenere lo stato delle notifiche

Questo documento descrive i dettagli del payload per ottenere lo stato della notifica per le notifiche Webhook Destination Test.

ibmcloud event-notifications notifications-status

Ottieni lo stato di una notifica di test inviata a una destinazione webhook. Questo comando viene utilizzato specificatamente per recuperare lo stato di consegna delle notifiche di test dei webhook.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `32` i caratteri. La lunghezza minima è di `32` i caratteri. Il valore deve corrispondere all'espressione regolare `/[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 (stringa)

L'ID della notifica restituito durante il test di una destinazione webhook. Questo ID è specifico per le notifiche di test inviate alle destinazioni webhook. Obbligatorio.

La lunghezza massima è di 36 i caratteri. La lunghezza minima è di 36 i caratteri. Il valore deve corrispondere all'espressione regolare /[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}/.

Esempio

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

Invia notifiche

Questo documento descrive i dettagli del payload per l'invio di eventi utilizzando le sorgenti API in Event Notifications. Le sorgenti API possono essere utilizzate per inviare eventi dalle applicazioni backend. Le Event Notifications supportano due modalità per effettuare chiamate HTTP. Questo è conforme alle specifiche CloudEvents. Queste modalità sono la modalità binaria e la modalità strutturata. Maggiori dettagli qui - https://github.com/cloudevents/spec. Nella modalità Contenuto binario, il valore dei dati dell'evento viene inserito nel corpo della richiesta o della risposta HTTP così com'è, con il valore dell'attributo datacontenttype che dichiara il suo tipo di media nell'intestazione HTTP Content-Type; tutti gli altri attributi dell'evento sono mappati nelle intestazioni HTTP. Tutti i nomi degli attributi hanno il prefisso ce- e vengono aggiunti all'intestazione (a eccezione di data e datacontenttype). Quando gli attributi obbligatori di CloudEvents (specversion, id, type e source) sono passati come parte delle intestazioni, la richiesta è trattata in modalità binaria. Modalità strutturata. Nella modalità Contenuto strutturato, gli attributi dei metadati dell'evento e i dati dell'evento sono inseriti nel corpo della richiesta HTTP. Per la modalità strutturata, impostare l'intestazione Content-Type su application/cloudevents+json. Gli attributi obbligatori di CloudEvents (specversion, id, type e source) devono far parte del corpo della richiesta. Inoltre, i dati id sono forniti come datacontenttype, che è obbligatorio. Supportiamo solo il tipo di dato "application/json".

ibmcloud event-notifications send-notifications

Invia il corpo delle notifiche dall'istanza. Per ulteriori informazioni sul payload Event Notifications, vedere qui.

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

Opzioni comando

--instance-id (stringa)

Identificativo univoco per l'istanza di IBM Cloud Event Notifications. Obbligatorio.

 La lunghezza massima è di `256` i caratteri. La lunghezza minima è di `10` i caratteri. Il valore deve corrispondere all'espressione regolare `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.
--body (NotificationCreate)

Payload che descrive una richiesta di creazione di notifica.

Fornire un'opzione stringa JSON o specificare un file JSON da cui leggere fornendo un'opzione filepath che inizia con @, ad esempio --body=@path/to/file.json.

NotificationCreate

L'esempio seguente illustra il formato dell'oggetto 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" : "{ }"
}

Esempio

Con i parametri richiesti:

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

Con tutti i parametri:

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": "{}"}'

Proprietà aggiuntive che possono essere configurate per la notifica iOS

impostazioni della piattaforma iOS
Proprietà Tipo di proprietà Descrizione
badge numero intero Il numero da visualizzare come badge dell'icona dell'applicazione.
interactive_category stringa L'identificativo di categoria da utilizzare per le notifiche di push interattive.
ios_action_key stringa Il titolo per la chiave di azione.
payload Oggetto JSON Payload JSON personalizzato che viene inviato come parte del messaggio di notifica.
sound stringa Il nome del file audio nel bundle dell'applicazione. L'audio di questo file viene riprodotto come un avviso.
title_loc_key stringa La chiave di una stringa titolo nel file Localizable.strings per l'ubicazione corrente. La stringa della chiave può essere formattata utilizzando i specificatori %@ e %n$@ per incorporare le variabili specificate nell'array titleLocArgs.
loc_key stringa Una chiave corrispondente a una stringa di messaggio di avviso contenuta in un file Localizabl.strings per la localizzazione corrente (definita in base alle preferenze linguistiche dell'utente). La stringa della chiave può essere formattata con gli specificatori %@ e %n$@ per prendere le variabili specificate nell'array locArgs.
launch_image stringa Il nome di un file immagine contenuto nel bundle dell'app, con o senza estensione. L'immagine viene utilizzata come immagine di avvio quando gli utenti premono il pulsante di azione o spostano il cursore di azione.
title_loc_args stringa I valori della stringa della variabile che viene visualizzata al posto degli identificativi del formato in titolo-ubicazione-chiave.
loc_args stringa Valori variabili delle stringhe che devono apparire al posto dei specificatori di formato in locKey.
title stringa Il titolo delle notifiche rich push (supportato solo su iOS 10 e superiore).
subtitle stringa Il sottotitolo delle notifiche avanzate (supportate solo su iOS 10 e versioni successive).
body stringa Il corpo delle notifiche IOS.
attachment_url stringa Il link ai supporti delle notifiche iOS (video, audio, GIF, immagini - Supportato solo su iOS 10 e superiore).
type stringa Valori ammessi: DEFAULT, MIXED, SILENT.
apns_collapse_id stringa Più notifiche con lo stesso identificatore di collasso vengono visualizzate dall'utente come un'unica notifica.
apns_thread_id stringa Un identificatore specifico dell'applicazione per raggruppare le notifiche correlate. Questo valore corrisponde alla proprietà threadIdentifier dell'oggetto UNNotificationContent.
apns_group_summary_arg stringa La stringa che la notifica aggiunge alla stringa di formato del riepilogo della categoria.
apns_group_summary_arg_count numero intero Il numero di voci che la notifica aggiunge alla stringa di formato del riepilogo della categoria.

Proprietà aggiuntive che possono essere configurate per la notifica FCM

Impostazioni della piattaforma Android
Proprietà Tipo di proprietà Descrizione
icon stringa Specifica il nome dell'icona da visualizzare per la notifica. Assicurati che l'icona sia già nel pacchetto dell'applicazione client.
delay_while_idle Booleano Se impostato su true, questo parametro indica che il messaggio non deve essere inviato finché il dispositivo non diventa attivo.
sync Booleano La messaggistica del gruppo di dispositivi consente a ogni istanza dell'applicazione in un gruppo di riflettere lo stato di messaggistica più recente.
visibility stringa privata o pubblica - Visibilità di questa notifica, che determina come e quando le notifiche vengono visualizzate su una schermata di blocco protetta.
redact stringa I contenuti specificati vengono visualizzati su una schermata sicura e bloccata del dispositivo quando la visibilità è impostata su Privato.
payload Oggetto JSON Payload JSON personalizzato che viene inviato come parte del messaggio di notifica.
priority stringa Un valore stringa che indica la priorità di questa notifica. I valori ammessi sono "max", "high", "default", "low" e "min". Le notifiche a priorità alta/massima insieme al campo "suono" possono essere utilizzate per le notifiche Heads up in Android 5.0 o higher.sampleval 'low'.
sound stringa Il file audio (presente sul dispositivo) che verrà riprodotto, se possibile, all'arrivo della notifica sul dispositivo.
time_to_live numero intero Specifica per quanto tempo (in secondi) il messaggio deve essere conservato nell'archivio " GCM " se il dispositivo è offline.
lights Imposta il colore del LED di notifica alla ricezione di una notifica push.
ledArgb stringa Il colore del led. L'hardware fornisce l'approssimazione migliore.
ledOnMs numero intero Il tempo, espresso in millisecondi, durante il quale il LED rimane acceso mentre lampeggia. L'hardware fornisce l'approssimazione migliore.
ledOffMs stringa Il tempo, espresso in millisecondi, durante il quale il LED rimane spento mentre lampeggia. L'hardware fornisce l'approssimazione migliore.
android_title stringa Il titolo delle notifiche push di Rich.
group_id stringa Impostare questa notifica come parte di un gruppo di notifiche che condividono la stessa chiave. Le notifiche raggruppate possono essere visualizzate in un cluster o in uno stack sui dispositivi che supportano questo tipo di rendering.
style Opzioni da specificare per le notifiche espandibili di Android. I tipi di notifiche espandibili sono picture_notification, bigtext_notification, inbox_notification.
type stringa Specifica il tipo di notifiche espandibili. I valori possibili sono bigtext_notification, picture_notification, inbox_notification.
title stringa Specifica il titolo della notifica. Il titolo viene visualizzato quando si espande la notifica. Il titolo deve essere specificato per tutte e tre le notifiche espandibili.
type stringa Valori ammessi: DEFAULT, SILENT.
alert stringa Il valore di avviso di Notifica.

Script di esempio per il provisioning di Event Notifications tramite CLI

Lo script provision_event_notification.sh automatizza il provisioning e la configurazione di un'istanza Event Notifications.

Esempio di script per l'integrazione delle notifiche della piattaforma tramite CLI

Lo script en-platform-notification-src-and-email-dest.sh integra le notifiche della piattaforma con Event Notifications e indirizza le notifiche all'e-mail integrata di IBM o alla Sandbox del dominio personalizzato.

Esempio di script per l'integrazione di IBM Cloud Logs tramite CLI

Lo script en-icl-src-and-email-dest.sh integra IBM Cloud Logs con Event Notifications e indirizza le notifiche all'email integrata di IBM o alla Sandbox del dominio personalizzato.

Questo script presuppone che l'istanza IBM Cloud Logs e l'istanza Event Notifications siano nello stesso account.

Cronologia versione CLI

Trova un riepilogo delle modifiche per ciascuna versione del plug-in Event Notifications. Tieni aggiornata la tua CLI in modo da poter utilizzare tutti i comandi disponibili e le loro opzioni.

Le versioni del plugin CLI da 0.0.5 a 1.9.0 sono obsolete.

Modifiche al IBM Cloud Event Notifications CLI
Versione Data di rilascio Modifiche
1.5.0 10 maggio 2024 Supporto per la configurazione SMTP e i modelli Slack.
1.6.0 1° agosto 2024 Destinazione CF deprecata e MMS supportata.
1.7.0 9 agosto 2024 Supporto per le metriche e rimozione del supporto per gli IP consentiti SMTP dalla configurazione SMTP.
1.8.0 9 settembre 2024 Supporto per la destinazione Slack DM.
1.9.0 11 ottobre 2024 Supporto per i modelli Webhook.
1.10.0 4 novembre 2024 Rimosso il supporto per le Cloud Functions
1.11.0 7 gennaio 2025 Supporto per il timer periodico
1.12.0 27 febbraio 2025 Supporto per modello Pagerduty
1.13.0 6 marzo 2025 Supporto per destinazione, abbonamento e modelli di Event Streams.
1.14.0 28 aprile 2025 PagerDuty il parametro di destinazione deprecato api_key è contrassegnato come opzionale.
1.15.0 27 giugno 2025 Il contenuto markdown per la notifica.
1.16.0 1 agosto 2025 Code Engine e il supporto di modelli predefiniti.
1.17.0 4 settembre 2025 Supporto del test di destinazione webhook get notifications-status
1.18.0 25 dicembre 2025 Destinazione dell'appconfigurazione, abbonamento e supporto dei modelli
1.19.0 30 ottobre 2025 Supporto per le credenziali utente smtp clonate
1.20.0 15 dicembre 2025 Supporto per le metriche di rimbalzo
1.20.1 19 gennaio 2026 Correzione dei metadati del supporto endpoint privato e del problema di installazione del plugin EN in private.cloud.ibm.com
1.20.2 18 febbraio 2026 Aggiornamento della patch per la correzione della vulnerabilità del plugin CLI
1.21.0 7 aprile 2026 Aggiornamento del plugin CLI per la sandbox di visualizzazione, gli allegati e-mail e il supporto delle opzioni di origine per il debug del payload
1.21.1 25 maggio 2026 Deprecato il comando init e show e aggiunto il comando en instances listing. È stata fornita una correzione per impostare automaticamente l'endpoint EN in base alla regione di destinazione impostata.
1.21.2 29 giugno 2026 Correzione di un bug relativo alle metriche SMTP per supportare il flag "SMTP Config ID" e contrassegnare il tipo di destinazione come opzionale.
1.21.3 6 agosto 2026 Correzione di una vulnerabilità del plugin CLI, miglioramenti all'usabilità e modifiche estetiche