Guida di riferimento alla CLI Event Notifications

Per utilizzare " Event Notifications " tramite l'interfaccia a riga di comando (CLI), è possibile installare il plug-in CLI " Event Notifications " dal repository dei plug-in all'indirizzo IBM Cloud. Il plug-in è stato progettato per ampliare le funzionalità offerte dalla CLI di IBM Cloud.

Prerequisiti

Un account su IBM Cloud.
Un'istanza di Event Notifications.
La CLI di IBM Cloud installata sul tuo sistema locale. Per assistenza sull'utilizzo della CLI di IBM Cloud, consulta la scheda di riferimento.

Quando accedi alla CLI di IBM Cloud, ricevi una notifica se sono disponibili degli aggiornamenti. Assicurati di mantenere aggiornata la tua CLI, in modo da poter accedere a eventuali nuovi comandi e opzioni disponibili per il plug-in CLI di Event Notifications.

Installa la CLI Event Notifications

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

ibmcloud plugin install event-notifications

Le versioni del plugin precedenti alla 1.15.2 sono obsolete.

Event Notifications Comandi CLI

Il comando init è deprecato e verrà rimosso in una versione futura.

`ibmcloud event-notifications en-list`

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

ibmcloud event-notifications en-list

Esempio

ibmcloud event-notifications en-list

Imposta una regione di destinazione

Imposta la regione in cui desideri lavorare utilizzando il comando ibmcloud target .

ibmcloud target -r REGION

In alternativa, è possibile esportare un endpoint regionale tramite la variabile IBMCLOUD_EN_ENDPOINT, come illustrato nell'esempio seguente.

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

Per impostare l'endpoint regionale come pubblico o privato, consultare le seguenti opzioni:

Endpoint pubblici disponibili:
- 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
Endpoint privati disponibili:
- 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

È inoltre possibile esportare la variabile EVENT_NOTIFICATIONS_API_KEY per configurare la chiave API o le credenziali di servizio (chiave API) per la propria istanza di Event Notifications.

Origini

Operare su IBM Cloud Event Notifications fonte.

`ibmcloud event-notifications source-create`

Crea una sorgente che configuri un servizio in modo che generi eventi che Event Notifications possa utilizzare. È necessario specificare l'ID dell'istanza di Event Notifications per la quale si sta configurando l'origine. Per ulteriori informazioni sui tipi di sorgente e sulla loro registrazione su Event Notifications, consultare la sezione " Aggiunta di una sorgente Event Notifications ".

Attualmente la CLI supporta solo la creazione di sorgenti API.

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

Sono supportati sia source-create che sources-create. Utilizza " source-create " per garantire la coerenza con gli altri comandi.

Opzioni comando

--instance-id (stringa)

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

La lunghezza massima è di 36 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 da fornire per l'origine API. Obbligatorio.

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 (stringa)

La descrizione del codice sorgente dell'API.

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)

Attiva o disattiva la sorgente. Obbligatorio. Impostare su " true " per abilitare la sorgente.

--store-notifications (booleano)

Salva le notifiche. Imposta l'opzione " true " per archiviare le notifiche, in modo da poter visualizzare il contenuto degli eventi in arrivo a scopo di risoluzione dei problemi.

Esempio

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

`ibmcloud event-notifications source-update`

Aggiornare i parametri di origine utilizzando l'ID dell'origine. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la sorgente.

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

Opzioni comando

--instance-id (stringa)

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

--id (stringa)

L'identificatore univoco della fonte. Obbligatorio.

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

--name (stringa)

Il nome aggiornato della fonte dell'API.

--description (stringa)

La descrizione aggiornata del codice sorgente dell'API.

--enabled (booleano)

Attiva o disattiva la sorgente.

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

--store-notifications (booleano)

Salva le notifiche. È possibile visualizzare il payload degli eventi in arrivo a scopo di risoluzione dei problemi.

Il valore predefinito è false.

Esempio

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

`ibmcloud event-notifications sources`

Elenca tutte le fonti presenti in un'istanza specificata.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Eseguire più richieste per visualizzare tutte le pagine della raccolta di origine.

Esempio

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

`ibmcloud event-notifications source`

Ottieni i dettagli relativi a una fonte specifica.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della fonte. Obbligatorio.

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

Esempio

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

`ibmcloud event-notifications source-delete`

Elimina una fonte.

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

Opzioni comando

--id (stringa)

Identificativo univoco dell'Origine. Obbligatorio.

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

--instance-id (stringa)

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

--force

Ignora la richiesta di conferma e forza l'eliminazione della risorsa.

Esempio

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

Destinazioni

Operare su IBM Cloud Event Notifications destinazione.

`ibmcloud event-notifications destination-create`

Crea una destinazione che funga da destinatario per una notifica. Una destinazione può essere configurata per inviare notifiche a un utente umano o a un servizio automatizzato.

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]

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--name (stringa)

Il nome della destinazione. Obbligatorio.

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

--type (stringa)

Il tipo della destinazione. Destinazioni per utenti umani: smtp_ibm, sms_ibm, smtp_custom, sms_custom, event_streams, msteams, pagerduty, push_android, push_chrome, push_firefox, push_huawei, push_ios, push_safari, servicenow, slack. Destinazioni per servizi: ibmce, ibmcos, webhook. Obbligatorio.

La lunghezza minima è di 1 e carattere.

--description (stringa)

La descrizione della destinazione.

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

--collect-failed-events (booleano)

Impostare su true per raccogliere gli eventi non riusciti in un bucket Cloud Object Storage. Per raccogliere gli eventi non riusciti, abilita l'integrazione con Cloud Object Storage per questa istanza. Il valore predefinito è false.

--config ( DestinationConfig esempi )

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

--certificate (stringa)

Percorso del file del certificato per le destinazioni push APNs o iOS. Accetta file di certificati in formato “ p8 ” e “ p12 ”.

--certificate-content-type (stringa)

Il tipo di contenuto del certificato per le destinazioni iOS. I valori consentiti sono p8 e p12.

--icon16x16 (stringa)

Il percorso del file dell'icona di Safari è 16x16. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon16x16-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 16x16.

--icon16x162x (stringa)

Il percorso del file dell'icona di Safari è 16x16@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon16x162x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 16x16@2x.

--icon32x32 (stringa)

Il percorso del file dell'icona di Safari è 32x32. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon32x32-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 32x32.

--icon32x322x (stringa)

Il percorso del file dell'icona di Safari è 32x32@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon32x322x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 32x32@2x.

--icon128x128 (stringa)

Il percorso del file dell'icona di Safari è 128x128. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon128x128-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 128x128.

--icon128x1282x (stringa)

Il percorso del file dell'icona di Safari è 128x128@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon128x1282x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 128x128@2x.

Cloud Functions non è più supportata come destinazione.

Esempi

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

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

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

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

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

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

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

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

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

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

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

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

codice motore tipo di destinazione: lavoro

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

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

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

Procedura per 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
```
{
   "params" : {
      "domain": "mailx.com"
   }
}
```

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

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

L'esempio seguente mostra il formato dell'oggetto DestinationConfig per la destinazione App Configuration (app_configuration).
```
{
   "params" : {
      "type": "features",
      "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::",
      "environment_id": "stage",
      "feature_id": "test"
   }
}
```
È 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.

`ibmcloud event-notifications destinations`

Elenca tutte le destinazioni di un'istanza di Event Notifications.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta di destinazione.

Esempio

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

`ibmcloud event-notifications destination`

Ottieni i dettagli di una destinazione utilizzando il suo ID.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

Esempio

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

`ibmcloud event-notifications destination-update`

Aggiornare i parametri di destinazione utilizzando l'ID di destinazione.

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]

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

--name (stringa)

Il nome aggiornato della destinazione.

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

--description (stringa)

La descrizione aggiornata della destinazione.

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

--collect-failed-events (booleano)

Impostare su true per raccogliere gli eventi non riusciti in un bucket Cloud Object Storage. Il valore predefinito è false.

--config (DestinationConfig)

La configurazione aggiornata per la 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 (stringa)

Percorso del file del certificato per le destinazioni push APNs o iOS. Accetta file di certificati in formato “ p8 ” e “ p12 ”.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--certificate-content-type (stringa)

Il tipo di contenuto del certificato per le destinazioni iOS. I valori consentiti sono p8 e p12.

--icon16x16 (stringa)

Il percorso del file dell'icona di Safari è 16x16. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon16x16-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 16x16.

--icon16x162x (stringa)

Il percorso del file dell'icona di Safari è 16x16@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon16x162x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 16x16@2x.

--icon32x32 (stringa)

Il percorso del file dell'icona di Safari è 32x32. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon32x32-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 32x32.

--icon32x322x (stringa)

Il percorso del file dell'icona di Safari è 32x32@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon32x322x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 32x32@2x.

--icon128x128 (stringa)

Il percorso del file dell'icona di Safari è 128x128. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon128x128-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 128x128.

--icon128x1282x (stringa)

Il percorso del file dell'icona di Safari è 128x128@2x. Per le destinazioni dell’ push_safari.

La lunghezza massima è di 5000 caratteri. La lunghezza minima è di 1.

--icon128x1282x-content-type (stringa)

Il tipo di contenuto dell'icona di Safari 128x128@2x.

Esempio

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

`ibmcloud event-notifications destination-delete`

Eliminare una destinazione utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la destinazione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

--force (booleano)

Esegui il comando a tutti i costi.

Esempio

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

`ibmcloud event-notifications enabled-countries`

Ottieni i dettagli relativi al Paese in cui è attivo il servizio per una destinazione SMS utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la destinazione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco del destinatario dell'SMS. Obbligatorio.

Esempio

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

`ibmcloud event-notifications test-destination`

Verifica la configurazione di una destinazione utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la destinazione. Per l'elenco delle destinazioni supportate, consultare la sezione " Verifica di una destinazione ".

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

Esempio

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

`ibmcloud event-notifications sandbox-destination-update`

Eseguire l’aggiornamento di una destinazione e-mail in ambiente di test all’ambiente di produzione con un dominio personalizzato.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

--domain (stringa)

Il dominio dell'e-mail. Obbligatorio.

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

Esempio

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

`ibmcloud event-notifications verify-destination-update`

Verifica i record SPF e DKIM di un dominio personalizzato.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della destinazione. Obbligatorio.

--type (stringa)

Il tipo di verifica per un indirizzo e-mail con dominio personalizzato. I valori consentiti sono spf e dkim. Obbligatorio.

La lunghezza massima è di 20 caratteri. La lunghezza minima è di 1. 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.

`ibmcloud event-notifications topic-create`

Crea un argomento per ricevere eventi dalle fonti e inviare notifiche alle destinazioni iscritte. Un argomento può effettuare la connessione a più origini. Per creare un argomento, è necessario specificare l'ID dell'istanza di Event Notifications.

Per ulteriori informazioni, consulta la sezione " Creazione di un argomento ".

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

Opzioni comando

--instance-id INSTANCE-ID (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--name NAME (stringa)

Il titolo dell'argomento. Obbligatorio.

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

--description DESCRIPTION (stringa)

Descrizione dell'argomento.

--sources SOURCES (TopicCreateSourcesItem[])

La configurazione della sorgente e del filtro da associare all'argomento. Vedi gli esempi di configurazione del codice sorgente.

Esempio

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

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

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

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

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

`ibmcloud event-notifications topics`

Elenca tutti gli argomenti creati per un'istanza di Event Notifications. È necessario specificare l'ID dell'istanza.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta di argomenti.

Esempio

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

`ibmcloud event-notifications topic`

Ottieni i dettagli di un argomento utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato l'argomento.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'argomento. Obbligatorio.

--include (stringa)

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

Esempio

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

`ibmcloud event-notifications topic-update`

Aggiorna i dettagli di un argomento utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato l'argomento.

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

È possibile utilizzare topic-replace come alias di topic-update. Il comando topic-replace è deprecato e verrà rimosso in una versione futura.

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'argomento. Obbligatorio.

--name (stringa)

Il nome aggiornato dell'argomento.

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

--description (stringa)

La descrizione aggiornata dell'argomento.

--sources (TopicUpdateSourcesItem[])

I dettagli aggiornati relativi alle fonti e ai filtri. Vedi gli esempi di configurazione del codice sorgente.

Questa opzione aggiunge solo nuove fonti. Le fonti già associate all'argomento non possono essere sostituite né aggiornate. Per modificare i filtri di origine, rimuovere l'origine dall'argomento e aggiungerla nuovamente con la nuova configurazione dei filtri.

Esempio

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

`ibmcloud event-notifications topic-delete`

Elimina un argomento utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato l'argomento.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'argomento. Obbligatorio.

--force (booleano)

Esegui il comando a tutti i costi.

Esempio

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

Sottoscrizioni

Operare su IBM Cloud Event Notifications in abbonamento.

`ibmcloud event-notifications subscription-create`

Crea un abbonamento che colleghi una destinazione a un argomento per la distribuzione degli eventi. Una destinazione può sottoscrivere argomenti e più destinazioni possono sottoscrivere lo stesso argomento. Per creare un abbonamento, è necessario specificare l'ID dell'istanza di Event Notifications.

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

Opzioni comando

--name (stringa)

Il nome dell'abbonamento. Obbligatorio.

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

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--description (stringa)

Descrizione dell'abbonamento.

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

--destination-id (stringa)

L'ID della destinazione da collegare all'argomento. Obbligatorio.

La lunghezza massima è di 150 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 (stringa)

L'ID dell'argomento per l'abbonamento. Obbligatorio.

--attributes (SubscriptionCreateAttributes)

Gli attributi necessari per creare l'abbonamento. Vedi gli esempi di attributi.

Esempi

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

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.

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

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

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

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

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

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

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

`ibmcloud event-notifications subscriptions`

Elenca tutti gli abbonamenti configurati per un'istanza di Event Notifications. È necessario specificare l'ID dell'istanza.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--offset (int64)

L'offset per i risultati impaginati.

Il valore minimo è 0.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta dell'abbonamento.

Esempio

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

`ibmcloud event-notifications subscription`

Ottieni i dettagli di un abbonamento utilizzando il relativo ID. È necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la sottoscrizione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'abbonamento. Obbligatorio.

Esempio

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

`ibmcloud event-notifications subscription-delete`

Elimina un abbonamento utilizzando il relativo ID. È necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la sottoscrizione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'abbonamento. Obbligatorio.

--force (booleano)

Esegui il comando a tutti i costi.

Esempio

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

`ibmcloud event-notifications subscription-update`

Aggiornare i parametri di un abbonamento utilizzando il relativo ID. È necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata la sottoscrizione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'abbonamento. Obbligatorio.

--name (stringa)

Il nome aggiornato dell'abbonamento.

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

--description (stringa)

La descrizione aggiornata dell'abbonamento.

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 (SubscriptionUpdateAttributes)

Gli attributi aggiornati. Vedi gli esempi di attributi.

Esempi

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

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

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

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

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

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

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

{
   "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.
```
{
   "assigned_to" : "serviceuser@gmail.com",
   "assignment_group" : "incidentgroup"
}
```
- L'esempio seguente mostra il formato dell'oggetto " SubscriptionUpdateAttributes " per Pagerduty/ Event Streams.
```
{
   "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 — ovvero la valutazione dei flag di funzionalità o la creazione di modelli di notifica, ma non entrambi contemporaneamente.
```
{
   "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
}
```
```
{
   "feature_flag_enabled": false,
}
```

Integrazioni

Operare su IBM Cloud Event Notifications integrazione.

`ibmcloud event-notifications integration-create`

Crea un'integrazione che colleghi Event Notifications con IBM Cloud e Object Storage.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--type (stringa)

Il tipo di integrazione. Il tipo supportato è collect_failed_events. Obbligatorio.

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

--metadata (stringa)

I metadati di integrazione necessari per creare l'integrazione. Consulta l'esempio per indicazioni sulla formattazione. Obbligatorio.

Esempi

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

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

`ibmcloud event-notifications integration-update`

Aggiornare un'integrazione esistente utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata l'integrazione.

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

Al momento, puoi anche utilizzare integration-replace per aggiornare la tua integrazione. Tuttavia, il comando integration-replace è deprecato e verrà rimosso in una versione futura.

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--type (stringa)

Il tipo di integrazione. I valori consentiti sono kms, hs-crypto e collect_failed_events. Obbligatorio.

La lunghezza massima è di 50 caratteri. La lunghezza minima è di 1 i caratteri.

--metadata (stringa)

I metadati di integrazione necessari per aggiornare l'integrazione. Consulta l'esempio per indicazioni sulla formattazione. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'integrazione. Obbligatorio.

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

Esempi

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

L'esempio seguente illustra il formato dell'oggetto IntegrationReplaceAttributes per Key Protect.

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

`ibmcloud event-notifications integrations`

Elenca le integrazioni create per un'istanza di Event Notifications.

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

Opzioni comando

--instance-id (stringa)

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

--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 caratteri. La lunghezza minima è di 0 i caratteri. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta di integrazioni.

Esempio

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

`ibmcloud event-notifications integration`

Ottieni i dettagli di un'integrazione utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurata l'integrazione.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco dell'integrazione. Obbligatorio.

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

Esempio

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

Modelli

IBM Cloud Event Notifications modelli.

`ibmcloud event-notifications template-create`

Crea un modello per inviti e notifiche. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale si configura il modello.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

La lunghezza massima è di 256 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 del modello. Obbligatorio.

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

--type (stringa)

Il tipo di modello. I tipi supportati sono smtp_custom.invitation, smtp_custom.notification, webhook.notification, slack.notification, pagerduty.notification e event_streams.notification. Obbligatorio.

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

--params (TemplateConfig)

I parametri del modello per la notifica. Obbligatorio. Vedi i parametri 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.

--description (stringa)

Descrizione del modello.

La lunghezza massima è di 255 caratteri. La lunghezza minima è di 1. 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 caratteri. La lunghezza minima è di 1. 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 caratteri. La lunghezza minima è di 1. Il valore deve corrispondere all'espressione regolare /.*/.

Esempi

L'esempio seguente illustra il formato dell'oggetto " TemplateConfig " per le e-mail. I tipi supportati sono smtp_custom.notification e smtp_custom.invitation.

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

Elenca tutti i modelli definiti dall'utente creati per un'istanza di Event Notifications. È necessario specificare l'ID dell'istanza.

Se non si imposta l'opzione " --all-pages ", il comando recupera solo una pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

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

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta di 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 utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato il modello.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

La lunghezza massima è di 32 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'identificativo univoco del modello. Obbligatorio.

Esempio

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

`ibmcloud event-notifications template-update`

Aggiornare i dettagli di un modello esistente creato in un'istanza di Event Notifications.

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

È possibile utilizzare template-update al posto di template-replace. Entrambi i comandi sono attualmente supportati, ma " template-replace " verrà deprecato in una versione futura.

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificativo univoco del modello. Obbligatorio.

--name (stringa)

Il nome aggiornato del modello.

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

--description (stringa)

La descrizione aggiornata del modello.

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

--params (TemplateConfig)

I parametri aggiornati del modello. Vedi i parametri 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-replace \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --params='{"body": "exampleString", "subject": "exampleString"}'

`ibmcloud event-notifications template-delete`

Elimina un modello utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato il modello.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificativo univoco del modello. Obbligatorio.

-f, --force (booleano)

Esegui il comando a tutti i costi.

Esempio

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

`ibmcloud event-notifications pre-defined-templates`

Elenca i modelli predefiniti per un'istanza di Event Notifications.

Se non si imposta l'opzione " --all-pages ", il comando recupera solo una 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)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--source (stringa)

Il tipo di origine per il modello predefinito. Obbligatorio.

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

--type (stringa)

Il tipo di modello per il modello predefinito, in base alla destinazione. Obbligatorio.

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

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

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

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

Esegui più richieste per visualizzare tutte le pagine della raccolta di modelli predefiniti.

Esempio

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

`ibmcloud event-notifications pre-defined-template`

Ottieni i dettagli di un modello predefinito utilizzando il suo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è configurato il modello predefinito.

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

Opzioni comando

--instance-id (stringa): L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.
--id (stringa): L'identificatore univoco del modello predefinito. Obbligatorio.

Esempio

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

Configurazioni SMTP

Configurazioni SMTP delle IBM Cloud Event Notifications.

`ibmcloud event-notifications smtp-configuration-create`

Creare una configurazione SMTP per l'invio della posta. Per ulteriori informazioni, consultare la sezione " Configurazioni SMTP ".

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--name (stringa)

Il nome della configurazione SMTP. Obbligatorio.

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

--domain (stringa)

Il nome di dominio per la configurazione SMTP. Obbligatorio.

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

--description (stringa)

Descrizione della configurazione SMTP.

La lunghezza massima è di 250 caratteri. La lunghezza minima è di 1. 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 per un'istanza di Event Notifications.

Se non si imposta l'opzione " --all-pages ", il comando recupera solo una pagina della raccolta.

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

Opzioni comando

--instance-id (stringa)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--limit (int64)

Il limite di pagine per i risultati impaginati.

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

--offset (int64)

L'offset per i risultati impaginati.

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

--search (stringa)

La stringa di ricerca per filtrare i risultati.

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

--all-pages (booleano)

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

Esempio

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

`ibmcloud event-notifications smtp-user-create`

Creare un utente SMTP per una configurazione SMTP. È necessario specificare l'ID della configurazione SMTP e l'ID dell'istanza di Event Notifications.

Le credenziali SMTP vengono visualizzate una sola volta. Copiateli e conservateli in un luogo sicuro, poiché non sarà possibile recuperarli in seguito.

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)

L'identificatore univoco dell'istanza " IBM Cloud " Event Notifications. Obbligatorio.

--id (stringa)

L'identificatore univoco della configurazione SMTP. Obbligatorio.

--description (stringa)

La descrizione dell'utente SMTP.

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

--username-to-clone (stringa)

Il nome utente dell'utente SMTP da clonare.

La lunghezza massima è di 20 caratteri. La lunghezza minima è di 1. 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 associati a una configurazione SMTP.

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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--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 caratteri. La lunghezza minima è di 1. Il valore deve corrispondere all'espressione regolare /[a-zA-Z0-9]/.

--all-pages (booleano)

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`

Ottieni i dettagli relativi alla configurazione SMTP di un'istanza di Event Notifications.

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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

Esempio

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

`ibmcloud event-notifications smtp-configuration-update`

Aggiornare una configurazione SMTP utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è stata configurata l'impostazione 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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--name (stringa)

Nome SMTP.

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

--description (stringa)

Descrizione SMTP.

La lunghezza massima è di 250 caratteri. La lunghezza minima è di 1. 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`

Eliminare una configurazione SMTP utilizzando il relativo ID. È inoltre necessario specificare l'ID dell'istanza di Event Notifications per la quale è stata configurata l'impostazione SMTP.

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

Opzioni comando

--instance-id (stringa)

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

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

Esempio

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

`ibmcloud event-notifications smtp-user`

Ottenere i dettagli di un utente SMTP utilizzando l'ID utente e l'ID di configurazione 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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 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 un utente SMTP utilizzando l'ID utente e l'ID di configurazione 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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 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 caratteri. La lunghezza minima è di 1. 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 utilizzando l'ID utente e l'ID di configurazione SMTP.

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

Opzioni comando

--instance-id (stringa)

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

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--user-id (stringa)

UserID. Obbligatorio.

La lunghezza massima è di 256 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`

Ottieni tutti gli indirizzi IP consentiti per una configurazione SMTP.

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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

Esempio

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

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

Il supporto per le liste di autorizzazione legacy è stato deprecato. L'inserimento nell'elenco delle eccezioni è ora abilitato tramite le restrizioni basate sul contesto. Per ulteriori informazioni, consultare la sezione " Configurazioni SMTP ".

`ibmcloud event-notifications verify-smtp-update`

Verificare la configurazione SMTP del dominio per SPF, SKIM e en_authorization.

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.

--id (stringa)

Identificatore univoco per SMTP. Obbligatorio.

--type (stringa)

Tipo di verifica SMTP. I valori consentiti sono spf, dkim e en_authorization. Obbligatorio.

La lunghezza massima è di 20 caratteri. La lunghezza minima è di 1. 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`

Recupera le metriche relative a un'istanza di Event Notifications.

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

Opzioni comando

--instance-id (stringa)

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

--gte (stringa)

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

La lunghezza massima è di 28 caratteri. La lunghezza minima è di 1. 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 caratteri. La lunghezza minima è di 1. 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.

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

--subscription-id (stringa)

Identificativo univoco della Sottoscrizione.

--source-id (stringa)

Identificativo univoco dell'Origine.

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

--email-to (stringa)

Indirizzo e-mail del destinatario.

La lunghezza massima è di 256 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.

--subject (stringa)

Oggetto dell'e-mail.

La lunghezza massima è di 256 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`

Recupera le metriche relative ai bounce per un’istanza di Event Notifications.

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

Opzioni comando

--instance-id (stringa)

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

--gte (stringa)

Timestamp di inizio maggiore o uguale (GTE) in UTC. Obbligatorio.

La lunghezza massima è di 28 caratteri. La lunghezza minima è di 1. 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)

Timestamp di inizio "Less than equal" (LTE) in UTC. Obbligatorio.

La lunghezza massima è di 28 caratteri. La lunghezza minima è di 1. 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.

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

--subscription-id (stringa)

Identificativo univoco della Sottoscrizione.

--source-id (stringa)

Identificativo univoco dell'Origine.

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

--email-to (stringa)

Indirizzo e-mail del destinatario.

--notification-id (stringa)

ID notifica.

--subject (stringa)

Oggetto dell'e-mail.

La lunghezza massima è di 256 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

`ibmcloud event-notifications notifications-status`

Recupera lo stato della notifica relativa a una notifica di test della destinazione di un 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.

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

Esempio

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

Invia notifiche

Invia eventi dalle tue applicazioni backend utilizzando le fonti API. Event Notifications supporta due CloudEvents modalità di contenuto:

Modalità binaria — I dati dell'evento vengono inseriti nel corpo della richiesta HTTP così come sono, mentre l'attributo datacontenttype ne dichiara il tipo di media nell'intestazione Content-Type. Tutti gli altri attributi vengono mappati alle intestazioni HTTP precedute dal prefisso ce-. Le richieste vengono gestite in modalità binaria quando gli attributi obbligatori di " CloudEvents " (specversion, id, type e source) vengono passati come intestazioni.
Modalità strutturata — I metadati e i dati relativi all'evento vengono inseriti nel corpo della richiesta HTTP. Imposta l'intestazione " Content-Type " su " application/cloudevents+json". Gli attributi obbligatori (specversion, id, type e source) devono essere presenti nel corpo della richiesta. Il campo " datacontenttype " è obbligatorio e deve essere impostato su application/json.

`ibmcloud event-notifications send-notifications`

Invia una notifica da un'istanza del servizio. Per ulteriori informazioni sul payload della notifica, consulta la documentazione.

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.

--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 (determinata dalle 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 di stringa da inserire 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 si tenterà di riprodurre quando la notifica arriverà 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 Rich Push.
`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.

Esempi di script

È possibile utilizzare i seguenti script come ausilio nello sviluppo.

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.