Event Notifications CLI

La interfaz comando línea de comandos (CLI) de IBM Cloud proporciona capacidades adicionales para la oferta de servicios. La CLI de IBM Cloud admite un marco de complementos para ampliar su capacidad. Puede instalar el plugin de CLI de Event Notifications desde el repositorio de plugins de IBM Cloud. Con el complemento de la CLI del servicio Event Notifications, puedes gestionar fácilmente las instancias del servicio Event Notifications mediante los comandos de la CLI disponibles.

Requisitos previos

Una cuenta de IBM Cloud. Si no tiene una cuenta, pulse aquí para crear una.
Una instancia del servicio IBM Cloud Event Notifications.
IBM Cloud CLI en su sistema local.

Al iniciar sesión en la CLI de IBM Cloud, se te notificará cuando haya actualizaciones disponibles. Asegúrese de mantener la CLI al día para que pueda utilizar los mandatos y las señales disponibles para el plugin de la CLI de Event Notifications.

Tarjeta de referencia rápida IBM Cloud.

Nota: Las versiones del complemento CLI anteriores a 1.15.2 han quedado obsoletas.

Instalar la CLI de Event Notifications

Instala el complemento de la CLI de Event Notifications utilizando el comando plugin install.

ibmcloud plugin install en

Event Notifications Comandos CLI

Nota El comando CLI Plugin init será obsoleto en el futuro

ibmcloud es es-lista

Enumera las instancias de la región de destino establecida. Puede recuperar el GUID de su instancia de las instancias listadas.

ibmcloud en en-list

Conjunto de variables de entorno de notificaciones de sucesos de ibmcloud

Configure la región en la que va a trabajar estableciendo la región de destino de IBM Cloud (ibmcloud target -r ) o exportando el punto final regional a través de la variable IBMCLOUD_EN_ENDPOINT; por ejemplo, utilice lo siguiente para Sídney:

export IBMCLOUD_EN_ENDPOINT= https://au-syd.event-notifications.cloud.ibm.com/event-notifications
Exporta la variable IBMCLOUD_EN_ENDPOINT para configurar el punto final público de la región Event Notifications.
- Dallas: https://us-south.event-notifications.cloud.ibm.com/event-notifications
- Londres: https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
- Sídney: https://au-syd.event-notifications.cloud.ibm.com/event-notifications
- Fráncfort: 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
- En Tokio: https://jp-tok.event-notifications.cloud.ibm.com/event-notifications
- Toronto: https://ca-tor.event-notifications.cloud.ibm.com/event-notifications
- São Paulo: https://br-sao.event-notifications.cloud.ibm.com/event-notifications
- Montreal: https://ca-mon.event-notifications.cloud.ibm.com/event-notifications
- Washington D. C.: 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
Exporta la variable IBMCLOUD_EN_ENDPOINT para configurar el punto final privado de la región Event Notifications.
- Dallas: https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
- Londres: https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
- Sídney: https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
- Fráncfort: 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
- En Tokio: https://private.jp-tok.event-notifications.cloud.ibm.com/event-notifications
- Toronto: https://private.ca-tor.event-notifications.cloud.ibm.com/event-notifications
- São Paulo: https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications
- Montreal: https://private.ca-mon.event-notifications.cloud.ibm.com/event-notifications
- Washington D. C.: 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
Exporta la variable EVENT_NOTIFICATIONS_API_KEY para configurar la instancia de Event Notificationsapikey.

EVENT_NOTIFICATIONS_API_KEY puede ser su clave API de IBM Cloud o la clave API de credenciales de servicio de su instancia de Event Notifications.

Orígenes

Operar en IBM Cloud Event Notifications fuente.

ibmcloud event-notifications source create

Acción: Crear Source.

Actualmente, la CLI solo permite crear fuentes de API.

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

Parámetros que se deben proporcionar:

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name NAME (int64)

El nombre que se debe proporcionar para la fuente de la API.

El valor predeterminado es . La longitud máxima es de caracteres 255. La longitud mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (cadena)

La descripción del origen. Opcional.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--enabled ENABLED (booleano)

El indicador booleano para activar o desactivar la fuente. Opcional.

El valor se establece en true para habilitar la fuente y en false para deshabilitarla.

--store-notifications (booleano)

Permite ver la carga útil de los eventos entrantes para solucionar problemas.

El valor predeterminado es false.

ibmcloud event-notifications source update

Acción: Actualizar Source.

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

Parámetros que se deben proporcionar:

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia. Obligatorio.

--name (int64)

API Nombre de la fuente.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La longitud mínima es de 1 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (int64)

API Fuente Descripción

--enabled (booleano)

Serie de búsqueda para filtrar resultados.

El valor se establece en true para habilitar la fuente y en false para deshabilitarla.

--store-notifications (booleano)

habilitar para ver la carga útil de los eventos entrantes para la solución de problemas.

El valor predeterminado es `false`.

`--id` (cadena)
:  Identificador exclusivo para el Origen. Obligatorio.

   La longitud máxima es de `100` caracteres. La extensión mínima es de caracteres `1`. El valor debe coincidir con la expresión regular `/[a-zA-Z0-9-:_]*/`.

ibmcloud event-notifications lista de orígenes

Acción: Enumerar todos los Source.

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

Parámetros que se deben proporcionar:

--limit LIMIT (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset OFFSET (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search SEARCH (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force]

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

ibmcloud event-notifications obtener origen

Acción: Sé específico Source.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo para el Origen. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--offset OFFSET

El desplazamiento para los resultados paginados.

--search SEARCH

La serie de búsqueda para filtrar resultados.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force]

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

ibmcloud event-notifications source delete

Acción: Borrar Source.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo para el Origen. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force]

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

Destinos

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} destino.

ibmcloud event-notifications destination create

Acción: Crear un destino.

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]

Parámetros que se deben proporcionar:

--instance-id (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia.

--name NAME (cadena)

El nombre del destino. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type TYPE (cadena)

El tipo de destino. Las opciones disponibles son webhook, push_android, push_ios, push_chrome, push_firefox, push_huawei, push_safari, ibmce, ibmcos, msteams, pagerduty, servicenow, slack, smtp_custom, sms_custom, event_streams. Obligatorio.

Los valores permitidos son: webhook, push_android, push_ios,push_chrome,push_firefox,push_huawei,push_safari,ibmce, ibmcos,msteams,pagerduty,servicenow,slack,smtp_custom,sms_custom, event_streams. La extensión mínima es de caracteres 1.

--collect-failed-events (booleano)

Si se recoge el evento fallido en el bucket de Cloud Object Storage.

El valor predeterminado es `false`.

`--description DESCRIPTION` (cadena)
:  La descripción del destino.

   El valor predeterminado es ` `. La longitud máxima es de caracteres `255`. La longitud mínima es de caracteres `0`. El valor debe coincidir con la expresión regular `/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/`.

--certificate CERTIFICATE (cadena)

La vía de acceso del archivo de certificado que debe proporcionarse. El tipo de archivo permitido es el certificado p8 y p12. Proporcione la ubicación del archivo para pasar el certificado.

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

El tipo de contenido de certificado que se debe establecer en el caso de destino de IOS. El valor por defecto es ``. Las opciones disponibles son: p8 o p12.

--config CONFIG ( DestinationConfig ejemplos )

La configuración necesaria para establecer los parámetros específicos del destino.

Si creas un destino sin « --config », el destino se creará, pero no funcionará hasta que lo configures.

--icon16x16 (io.ReadCloser): Icono Safari 16x16.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x16-content-type (cadena)

El tipo de contenido de Icon16x16.

--icon16x162x (io.ReadCloser)

Icono Safari 16x16@2x.

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

--icon16x162x-content-type (cadena)

El tipo de contenido de Icon16x162x.

--icon32x32 (io.ReadCloser)

Icono de Safari 32x32.

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

--icon32x32-content-type (cadena)

El tipo de contenido de Icon32x32.

--icon32x322x (io.ReadCloser)

Icono de Safari 32x32@2x.

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

--icon32x322x-content-type (cadena)

El tipo de contenido de Icon32x322x.

--icon128x128 (io.ReadCloser)

Icono de Safari 128x128.

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

--icon128x128-content-type (cadena)

El tipo de contenido de Icon128x128.

--icon128x1282x (io.ReadCloser)

Icono de Safari 128x128@2x.

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

--icon128x1282x-content-type (cadena)

El tipo de contenido de Icon128x1282x.

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

Nota: Las Cloud Functions destino de Event Notifications eventos han quedado obsoletas y ya no se admiten en la categoría de destinos.

Ejemplos

El siguiente ejemplo muestra el formato del DestinationConfig objeto para un destino de iOS (push_ios) con un certificado de P8. Establezca el parámetro booleano pre_prod en true para configurar el destino como destino de preproducción o en 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)
      }
   }
   ```


- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para un destino de iOS (push_ios) con un certificado de P12. Establezca el parámetro booleano `pre_prod` en *true* para configurar el destino como destino de preproducción o en *false*.

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino Chrome (push_chrome). Establezca el parámetro booleano `pre_prod` en *true* para configurar el destino como destino de preproducción o en *false*.

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

- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para el destino Firefox (push_firefox). Establezca el parámetro booleano `pre_prod` en *true* para configurar el destino como destino de preproducción o en *false*.

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

- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para el destino Slack (slack) con el tipo incoming_webhook.

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

- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para el destino Slack (slack) con el tipo como direct_message.

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

- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para el destino Safari (push_safari). Establezca el parámetro booleano `pre_prod` en *true* para configurar el destino como destino de preproducción o en *false*.

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino MS Teams (msteams).

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

- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para el destino PagerDuty(pagerduty ).

   Se recomienda utilizar sólo la tecla Enrutar al crear el destino. La clave API está obsoleta y no podrá utilizarse en el futuro.
   {: attention}

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


- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para Webhook (webhook).

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino Android (push_android).

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


- El siguiente ejemplo muestra el formato del objeto `DestinationConfig` para un destino de ServiceNow(servicenow, Servicio de gestión de aplicaciones.

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino Code Engine (ibmce).

   código motor destino tipo: aplicación

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

   código motor destino tipo: trabajo

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


- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino IBM Cloud Object Storage (ibmcos).

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


- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino Huawei (push_huawei).

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino de correo electrónico personalizado (smtp_custom). En el caso del destino Sandbox de correo electrónico personalizado (smtp_custom_sandbox), los parámetros de configuración de destino no son necesarios.

   Proceso Para realizar la configuración y verificación del dominio personalizado: <https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino Event Streams (event_streams).

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

- El siguiente ejemplo muestra el formato del `DestinationConfig` objeto para el destino App Configuration (app_configuration).

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

Nota: Se puede crear un destino de SMS personalizado sin `DestinationConfig`, pero no funcionará hasta que se soliciten y configuren explícitamente los números personalizados necesarios. Para solicitar números personalizados, consulta [la sección «Números personalizados de SMS](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers) ».

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

- **Acción:** Enumerar todos los `Destination`.

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

Parámetros que se deben proporcionar:

--limit LIMIT (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset OFFSET (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search SEARCH (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--instance-id (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia.

ibmcloud event-notifications destino get

Acción: Sé específico Destination.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

El identificador exclusivo para el destino. Obligatorio.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

ibmcloud event-notifications actualización de destino

Acción: Actualizar los existentes Destination.

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

Parámetros que se deben proporcionar:

--instance-id (cadena): Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador exclusivo del Destino. Obligatorio.

--name (cadena)

Nombre del Destino.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción del Destino.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (booleano)

Si se recoge el evento fallido en el bucket de Cloud Object Storage.

El valor predeterminado es false.

--config (DestinationConfig)

Carga útil que describe una configuración de destino.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --config=@path/to/file.json.

--certificate (io.ReadCloser)

Certificado para APNS.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--certificate-content-type (cadena)

El tipo de contenido del certificado.

--icon16x16 (io.ReadCloser)

Icono Safari 16x16.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x16-content-type (cadena)

El tipo de contenido de Icon16x16.

--icon16x162x (io.ReadCloser)

Icono Safari 16x16@2x.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon16x162x-content-type (cadena)

El tipo de contenido de Icon16x162x.

--icon32x32 (io.ReadCloser)

Icono de Safari 32x32.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x32-content-type (cadena)

El tipo de contenido de Icon32x32.

--icon32x322x (io.ReadCloser)

Icono de Safari 32x32@2x.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon32x322x-content-type (cadena)

El tipo de contenido de Icon32x322x.

--icon128x128 (io.ReadCloser)

Icono de Safari 128x128.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x128-content-type (cadena)

El tipo de contenido de Icon128x128.

--icon128x1282x (io.ReadCloser)

Icono de Safari 128x128@2x.

La longitud máxima es de 5000 caracteres. La extensión mínima es de caracteres 1.

--icon128x1282x-content-type (cadena)

El tipo de contenido de Icon128x1282x.

ibmcloud event-notifications suprimir destino

Acción: Eliminar los existentes Destination.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

El identificador exclusivo para el destino. Obligatorio.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force] (booleano)

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

`ibmcloud event-notifications enabled-countries`

Obtener los detalles del país habilitado de destino del SMS.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador exclusivo del Destino. Obligatorio.

Ejemplo

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

`ibmcloud event-notifications test-destination`

Probar un destino.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador exclusivo del Destino. Obligatorio.

Ejemplo

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

`ibmcloud event-notifications email-sandbox-destination-update`

Actualizar destino sandbox a producción con dominio personalizado.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `32` caracteres. La longitud mínima es de `32` caracteres. El valor debe coincidir con la expresión regular `/[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 (cadena)

Identificador exclusivo del Destino. Obligatorio.

La longitud máxima es de 36 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/.

--domain (cadena)

Dominio de correo electrónico. Obligatorio.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

`ibmcloud event-notifications verify-destination-update`

Verifique los registros SPF y DKIM del dominio personalizado.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador exclusivo del Destino. Obligatorio.

--type (cadena)

Tipo de verificación. Obligatorio.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-z]/.

Ejemplo

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

Temas

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} tema.

ibmcloud event-notifications crear tema

Acción: Crear nuevo Topic.

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

Parámetros que se deben proporcionar:

--name NAME (cadena)

Nombre del tema. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description DESCRIPTION (cadena)

Descripción del tema.

--instance-id INSTANCE-ID (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--sources SOURCES] (TopicCreateSourcesItem[])

Lista de fuentes con sus configuraciones de filtro para adjuntar a este tema. No se trata simplemente de una lista de identificadores de origen: cada entrada incluye el identificador de origen y las reglas de filtrado que determinan qué eventos de ese origen se envían a este tema. Consulta los ejemplos para ver la estructura completa.

Ejemplo

El siguiente ejemplo muestra el formato del objeto TopicCreateSourcesItem[] para la fuente Temporizador periódico.

    [
       {
          "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": "* * * * *"
                   }
             }
          ]
       }
    ]
   ```

- El siguiente ejemplo muestra el formato del objeto `TopicCreateSourcesItem[]`.

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

- El siguiente ejemplo muestra el formato del objeto `TopicUpdateSourcesItem[]`.

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

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

- **Acción:** Enumerar todos los `Topic`.

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

Parámetros que se deben proporcionar:

--limit LIMIT (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset OFFSET (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search SEARCH (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

ibmcloud event-notifications obtener tema

Acción: Sé específico Topic.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo del Tema. Obligatorio.

--include INCLUDE (cadena)

Incluir subtemas.

El valor por defecto es ``. La longitud máxima es 20 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-z]/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

ibmcloud event-notifications actualización de tema

Acción: Actualizar los existentes Topic.

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

Parámetros que se deben proporcionar:

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

--id (cadena)

Identificador exclusivo del Tema. Obligatorio.

--name (cadena)

Nombre del tema.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

--description (cadena)

Descripción del tema.

--sources (TopicUpdateSourcesItem[])

Lista de nuevas fuentes con sus configuraciones de filtro para añadir a este tema. No se trata simplemente de una lista de identificadores de origen: cada entrada incluye el identificador de origen y las reglas de filtrado que determinan qué eventos de ese origen se envían a este tema. Consulta los ejemplos para ver la estructura completa.

Esta opción solo añade nuevas fuentes. Las fuentes que ya están asociadas al tema no se pueden sustituir ni actualizar; solo se pueden eliminar y volver a añadir. Para modificar los filtros de origen, elimina primero el origen del tema y, a continuación, vuelve a añadirlo con la nueva configuración de filtros.

ibmcloud event-notifications supresión de tema

Acción: Eliminar los existentes Topic.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo del Tema. Obligatorio.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force] (booleano)

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

Suscripciones

Funciona con IBM Cloud {{site {{site.data.keyword.en_short}} suscripción.

ibmcloud event-notifications creación de suscripción

Acción: Crear nuevo Subscription.

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

Parámetros que se deben proporcionar:

--name NAME (cadena)

El nombre que se debe establecer para la suscripción.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia.

--description DESCRIPTION (cadena)

La descripción que se debe establecer para la suscripción.

El valor por defecto es ``. La longitud máxima es 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--destination-id DESTINATION-ID (cadena)

El ID de destino que se debe establecer para la suscripción.

La longitud máxima es de 150 caracteres. La longitud mínima es de 36 caracteres. El valor debe coincidir con la expresión regular /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

--topic-id TOPIC-ID (cadena)

El ID de tema que se debe establecer para la suscripción.

--attributes ATTRIBUTES (SubscriptionCreateAttributes)

Los atributos que deben configurarse para la suscripción.

Ejemplos

El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para el webhook.

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

- El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para SMS.

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

- El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para el correo electrónico de IBM.

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

- El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para el tipo de destino de Slack incoming_webhook.

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

- El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para el tipo de destino de Slack direct_message.

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

El siguiente ejemplo muestra el formato del SubscriptionCreateAttributes objeto para ServiceNow.

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

- El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para el correo electrónico personalizado.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- El siguiente ejemplo muestra el formato del objeto `SubscriptionCreateAttributes` para Custom Email Sandbox.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
      "from_name":"ABC ORG",
      "from_email":"Testuser@mailx.com",
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
      "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
   }
   ```
   - El siguiente ejemplo muestra el formato del objeto `SubscriptionCreateAttributes` para Pagerduty/ Event Streams.

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para App Configuration. Al crear o actualizar una suscripción para un **App Configuration** destino, el objeto `attributes` tiene una regla específica:
      - **Debe** incluir `feature_flag_enabled` **o** `template_id_notification`
      - **No** puedes incluir ambas propiedades a la vez

      De este modo se garantiza que se cree una suscripción para el caso de uso correcto: ya sea **la evaluación de indicadores de funcionalidad** o **la creación de plantillas de notificaciones**, pero no ambas cosas a la vez.

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

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

- **Acción:** Enumerar todos los `Subscription`.

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

Parámetros que se deben proporcionar:

--limit LIMIT (int64)

El límite de páginas para los resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset OFFSET (int64)

El desplazamiento para los resultados paginados.

El valor mínimo es 0.

--search SEARCH (cadena)

La serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

ibmcloud event-notifications obtener suscripción

Acción: Sé específico Subscription.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo de la Suscripción. Obligatorio.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

ibmcloud event-notifications supresión de suscripción

Acción: Eliminar los existentes Subscription.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo de la Suscripción. Obligatorio.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--force] (booleano)

Active para forzar la supresión de recursos (para omitir la solicitud de confirmación).

ibmcloud event-notifications actualización de suscripción

Acción: Actualizar los existentes Subscription.

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

Parámetros que se deben proporcionar:

--id ID (cadena)

Identificador exclusivo de la Suscripción. Obligatorio.

[--name NAME] (cadena)

La descripción actualizada que se debe establecer para la suscripción.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--instance-id INSTANCE-ID (cadena)

El identificador único de la instancia IBM Cloud Event Notifications instancia. Obligatorio.

[--description DESCRIPTION] (cadena)

La descripción actualizada que se debe establecer para la suscripción.

El valor por defecto es ``. La longitud máxima es 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

[-attributes ATTRIBUTES] (SubscriptionUpdateAttributes)

Los atributos que se deben establecer para la suscripción

Ejemplos

El siguiente ejemplo muestra el formato del SubscriptionUpdateAttributes objeto para Webhook.

   {
      "signing_enabled": true
   }
   ```

- El siguiente ejemplo muestra el formato del `SubscriptionUpdateAttributes` objeto para un SMS de IBM.

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

- El siguiente ejemplo muestra el formato del `SubscriptionUpdateAttributes` objeto para el correo electrónico de IBM.

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

- El siguiente ejemplo muestra el formato del `SubscriptionUpdateAttributes` objeto para el correo electrónico personalizado.

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

- El siguiente ejemplo muestra el formato del objeto `SubscriptionUpdateAttributes` para Custom Email Sandbox.

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

- El siguiente ejemplo muestra el formato del objeto `SubscriptionUpdateAttributes` para Slack para el tipo como `incoming_webhook`.

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

- El siguiente ejemplo muestra el formato del objeto `SubscriptionUpdateAttributes` para Slack para el tipo como `direct_message`.

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

- El siguiente ejemplo muestra el formato del `SubscriptionUpdateAttributes` objeto para Service Now.

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

   - El siguiente ejemplo muestra el formato del objeto `SubscriptionUpdateAttributes` para Pagerduty/ Event Streams.

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

   - El siguiente ejemplo muestra el formato del `SubscriptionCreateAttributes` objeto para App Configuration. Al crear o actualizar una suscripción para un **App Configuration** destino, el objeto `attributes` tiene una regla específica:
      - **Debe** incluir `feature_flag_enabled` **o** `template_id_notification`
      - **No** puedes incluir ambas propiedades a la vez
               De este modo se garantiza que se cree una suscripción para el caso de uso correcto: ya sea **la evaluación de indicadores de funcionalidades** o **la creación de plantillas de notificaciones**, pero no ambas cosas a la vez.

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

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

Operar en IBM Cloud {{site {{site.data.keyword.en_short}} integración.

### integración de notificaciones de eventos ibmcloud Crear {: #en-cli-integration-create-command}

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

Opciones de comando

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

 La longitud máxima es de `36` caracteres. La longitud mínima es de `36` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--type (cadena)

Tipo de integración collect_failed_events.

La longitud máxima es de 50 caracteres. La longitud mínima es de 1 caracteres. El valor permitido es collect_failed_events.

--metadata (IntegrationCreateAttributes)

Esquema de integración para la actualización

Metadatos necesarios para la integración.

Ejemplos

El siguiente ejemplo muestra el formato del objeto 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"
   }
   ```

### sustitución de la integración de notificaciones de eventos de ibmcloud {: #en-cli-integration-update-command}

Sustituir `Integration`.

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

Opciones de comando

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

 La longitud máxima es de `36` caracteres. La longitud mínima es de `36` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--type (cadena)

Tipo de integración KMS/hs-crypto(obsoleto).

La longitud máxima es de 50 caracteres. La longitud mínima es de 1 caracteres. Los valores permitidos son KMS y collect_failed_events. Nota: El tipo hs-crypto ya está obsoleto. No se admitirán nuevos recursos de integración con el tipo hs-crypto.

--metadata (IntegrationReplaceAttributes)

Esquema de integración para la actualización

Metadatos necesarios para la integración.

--id (cadena)

Identificador único para la integración. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

Ejemplos

El siguiente ejemplo muestra el formato del IntegrationReplaceAttributes objeto para kms.

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

### lista de integración de notificaciones de eventos ibmcloud {: #en-cli-integration-list-command}

Listar todos los `Integrations`.

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

Opciones de comando

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

 La longitud máxima es de `36` caracteres. La longitud mínima es de `36` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Límite de página para resultados paginados.

El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

ibmcloud event-notifications Integración get

Obtener Integration específico.

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

Opciones de comando

--instance-id (cadena)

Identificador único para la instancia IBM Cloud Event Notifications instancia.

 La longitud máxima es de `36` caracteres. La longitud mínima es de `36` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para la integración. Obligatorio.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

Plantillas

IBM Cloud Event Notifications Plantillas.

`ibmcloud event-notifications template-create`

Cree una nueva Plantilla.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[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 (cadena)

Plantilla del mensaje. Obligatorio.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (cadena)

El tipo de plantilla. Obligatorio.

La longitud máxima es de 24 caracteres. La longitud mínima es de 22 caracteres. El valor debe coincidir con la expresión regular /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Contenido que describe la configuración de una plantilla. Obligatorio.

En su lugar, esta opción JSON puede proporcionarse configurando campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --params=@path/to/file.json.

--description (cadena)

La descripción de la plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params-body (cadena)

Cuerpo de la plantilla. Esta opción proporciona un valor para un subcampo de la opción JSON 'params'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 20000 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--params-subject (cadena)

El asunto de la plantilla. Esta opción proporciona un valor para un subcampo de la opción JSON 'params'. Es mutuamente excluyente con esa opción.

La longitud máxima es de 1000 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplos

El siguiente ejemplo muestra el formato del TemplateConfig objeto para el correo electrónico. El tipo admitido es smtp_custom.notification|smtp_custom.invitation

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

El siguiente ejemplo muestra el formato del TemplateConfig objeto para Slack. El tipo admitido es slack.notification.

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

El siguiente ejemplo muestra el formato del TemplateConfig objeto para Webhook. El tipo admitido es webhook.notification

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

El siguiente ejemplo muestra el formato del TemplateConfig objeto para Pagerduty. El tipo admitido es pagerduty.notification

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

El siguiente ejemplo muestra el formato del TemplateConfig objeto para Event Streams. El tipo admitido es event_streams.notification

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

El siguiente ejemplo muestra el formato del objeto TemplateConfig para Code Engine Job. El tipo admitido es ibmcejob.notification

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

El siguiente ejemplo muestra el formato del objeto TemplateConfig para Code Engine Aplicación/Función. El tipo admitido es ibmceapp.notification

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

El siguiente ejemplo muestra el formato del TemplateConfig objeto para App Configuration. El tipo admitido es 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`

Enumera todas las plantillas. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de plantillas.

Ejemplo

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

`ibmcloud event-notifications template`

Obtener detalles de una plantilla.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `32` caracteres. La longitud mínima es de `32` caracteres. El valor debe coincidir con la expresión regular `/[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 (cadena)

Identificador único de la plantilla. Obligatorio.

La longitud máxima es de 32 caracteres. La longitud mínima es de 32 caracteres. El valor debe coincidir con la expresión regular /[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}/.

Ejemplo

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

`ibmcloud event-notifications template-replace`

Actualizar los detalles de una plantilla.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único de la plantilla. Obligatorio.

--name (cadena)

Nombre de plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción de la plantilla.

La longitud máxima es de 255 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (cadena)

El tipo de plantilla.

La longitud máxima es de 24 caracteres. La longitud mínima es de 22 caracteres. El valor debe coincidir con la expresión regular /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Contenido que describe la configuración de una plantilla. En su lugar, esta opción JSON puede proporcionarse configurando campos individuales con otras opciones. Es mutuamente excluyente con esas opciones.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --params=@path/to/file.json.

Ejemplos

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

`ibmcloud event-notifications template-delete`

Suprima una plantilla.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único de la plantilla. Obligatorio.

Ejemplo

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

`ibmcloud event-notifications pre-defined-templates`

Lista todas las plantillas predefinidas.

Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `32` caracteres. La longitud mínima es de `32` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--source (cadena)

Tipo de fuente. Obligatorio.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--type (cadena)

Tipo de destino. Obligatorio.

La longitud máxima es de 50 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de plantillas predefinidas.

Ejemplo

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

Configuraciones de SMTP

Configuraciones SMTP IBM Cloud Event Notifications.

`ibmcloud event-notifications smtp-configuration-create`

Crea una nueva configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[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 (cadena)

El nombre de la configuración SMTP. Obligatorio.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--domain (cadena)

Nombre de dominio. Obligatorio.

La longitud máxima es de 512 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

--description (cadena)

Descripción de la configuración de SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

`ibmcloud event-notifications smtp-configurations`

Listar todas las configuraciones SMTP. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de configuraciones SMTP.

Ejemplo

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

`ibmcloud event-notifications smtp-user-create`

Crear un nuevo usuario SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--description (cadena)

Descripción de la configuración de SMTP.

La longitud máxima es de 250 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--username-to-clone (cadena)

proporciona el nombre del usuario a clonar.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /^[a-z0-9]{18}\\d{2}$/.

Ejemplo

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

`ibmcloud event-notifications smtp-users`

Lista todos los usuarios SMTP. Nota: Si no se establece la opción --all-pages, el comando sólo recuperará una única página de la colección.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

--search (cadena)

Serie de búsqueda para filtrar resultados.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--all-pages (booleano)

Realiza varias solicitudes para mostrar todas las páginas de la colección de smtp-users.

Ejemplo

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

`ibmcloud event-notifications smtp-configuration`

Obtener detalles de una configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

Ejemplo

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

`ibmcloud event-notifications smtp-configuration-update`

Actualizar detalles de SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--name (cadena)

Nombre SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (cadena)

Descripción SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

`ibmcloud event-notifications smtp-configuration-delete`

Borrar una configuración SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

Ejemplo

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

`ibmcloud event-notifications smtp-user`

Obtener detalles de un usuario SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

`ibmcloud event-notifications smtp-user-update`

Actualizar los detalles del usuario SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

--description (cadena)

Descripción del usuario SMTP.

La longitud máxima es de 250 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Ejemplo

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

`ibmcloud event-notifications smtp-user-delete`

Eliminar un usuario SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--user-id (cadena)

UserID. Obligatorio.

La longitud máxima es de 256 caracteres. La longitud mínima es de 5 caracteres. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

`ibmcloud event-notifications smtp-allowed-ips`

Obtener detalles de una IP SMTP permitida.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

Ejemplo

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

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

Nota: La compatibilidad con las listas de permisos heredadas ha quedado obsoleta. La compatibilidad se ha habilitado mediante Restricciones basadas en el contexto. Si desea información detallada, consulte aquí: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-smtp-configurations#en-smtp-configurations-cbr

`ibmcloud event-notifications verify-smtp-update`

Verificar los registros SPF y DKIM de SMTP.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--id (cadena)

Identificador único para SMTP. Obligatorio.

--type (cadena)

SMTP Tipo de verificación. Obligatorio.

La longitud máxima es de 20 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /.*/.

Ejemplo

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

Métricas

`ibmcloud event-notifications metrics`

Obtén métricas.

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]

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--gte (cadena)

GTE (mayor que igual), fecha de inicio en UTC. Obligatorio.

La longitud máxima es de 28 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[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 (cadena)

LTE (menos que igual), marca de tiempo final en UTC. Obligatorio.

--smtp-config-id (cadena)

ID de configuración de SMTP. Es obligatorio al consultar métricas de destinos de la interfaz SMTP.

--destination-type (cadena)

Tipo de destino para el que se solicitan las métricas. Valor admitido: smtp_custom. Es obligatorio al consultar métricas para destinos de correo electrónico personalizados.

Los valores permitidos son: smtp_custom.

--destination-id (cadena)

Identificador exclusivo del Destino.

--subscription-id (cadena)

Identificador exclusivo de la Suscripción.

--source-id (cadena)

Identificador exclusivo para el Origen.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--email-to (cadena)

Correo electrónico del receptor.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (cadena)

Notificación Id.

--subject (cadena)

asunto del correo electrónico.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

Ejemplo

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`

Obtenga métricas de rebote.

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]

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `32` caracteres. La longitud mínima es de `32` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/`.

--gte (cadena)

GTE (mayor que igual), fecha de inicio en UTC. Obligatorio.

--lte (cadena)

LTE (menos que igual), marca de tiempo final en UTC. Obligatorio.

--smtp-config-id (cadena)

ID de configuración de SMTP. Es obligatorio al consultar métricas de destinos de la interfaz SMTP.

--destination-type (cadena)

Tipo de destino para el que se solicitan las métricas. Valor admitido: smtp_custom. Es obligatorio al consultar métricas para destinos de correo electrónico personalizados.

Los valores permitidos son: smtp_custom.

--destination-id (cadena)

Identificador exclusivo del Destino.

--subscription-id (cadena)

Identificador exclusivo de la Suscripción.

--source-id (cadena)

Identificador exclusivo para el Origen.

La longitud máxima es de 100 caracteres. La extensión mínima es de caracteres 1. El valor debe coincidir con la expresión regular /[a-zA-Z0-9-:_]*/.

--email-to (cadena)

Correo electrónico del receptor.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (cadena)

Notificación Id.

--subject (cadena)

asunto del correo electrónico.

La longitud máxima es de 256 caracteres. La longitud mínima es de 0 caracteres. El valor debe coincidir con la expresión regular /[a-zA-Z0-9]/.

--limit (int64)

Límite de página para resultados paginados.

El valor predeterminado es 10. El valor máximo es 100. El valor mínimo es 1.

--offset (int64)

compensación para resultados paginados.

El valor predeterminado es 0. El valor mínimo es 0.

Ejemplo

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

Obtener el estado de las notificaciones

Este documento describe los detalles de la carga útil para obtener el estado de las notificaciones de prueba de destino de Webhook.

`ibmcloud event-notifications notifications-status`

Consulta el estado de una notificación de prueba enviada a un destino de webhook. Este comando se utiliza específicamente para consultar el estado de entrega de las notificaciones de prueba de webhooks.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `32` caracteres. La longitud mínima es de `32` caracteres. El valor debe coincidir con la expresión regular `/[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 (cadena)

El ID de notificación que se devuelve al probar un destino de webhook. Este ID es específico para las notificaciones de prueba enviadas a destinos de webhook. Obligatorio.

Ejemplo

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

Enviar notificaciones

Este documento describe los detalles de la carga útil para el envío de eventos mediante las fuentes de la API en Event Notifications. Los orígenes de API se pueden utilizar para enviar sucesos desde las aplicaciones en segundo plano. Event Notifications Admite dos modos para realizar llamadas a HTTP. Esto cumple con la especificación CloudEvents. Estos modos son el modo binario y el modo estructurado. Más detalles aquí: https://github.com/cloudevents/spec. En el modo de contenido binario, el valor de los datos del evento se incluye tal cual en el cuerpo de la solicitud o respuesta HTTP, y el valor del atributo datacontenttype declara su tipo de medio en el encabezado Content-Type de HTTP; el resto de atributos del evento se asignan a los encabezados de HTTP. Todos los nombres de atributos llevan el prefijo ce- y se añaden al encabezado (excepto data y datacontenttype). Cuando los atributos obligatorios de CloudEvents (specversion, id, type y source) se pasan como parte de las cabeceras, la solicitud se trata como modo binario. Modo estructurado. En el modo de contenido estructurado, los atributos de metadatos de los eventos y los datos de los eventos se incluyen en el cuerpo de la solicitud HTTP. Para el modo estructurado, establezca el encabezado Content-Type en application/cloudevents+json. Los atributos obligatorios de CloudEvents (specversion, id, type y source) deben formar parte del cuerpo de la solicitud. Además, los datos de id se proporcionan como datacontenttype, que es obligatorio. Sólo admitimos datacontenttype como "application/json".

`ibmcloud event-notifications send-notifications`

Enviar cuerpo de Notificaciones desde la instancia. Para más información sobre la carga útil de Event Notifications, consulte aquí.

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

Opciones de comando

--instance-id (cadena)

Identificador exclusivo de la instancia de IBM Cloud Event Notifications. Obligatorio.

 La longitud máxima es de `256` caracteres. La longitud mínima es de `10` caracteres. El valor debe coincidir con la expresión regular `/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/`.

--body (NotificationCreate)

Carga útil que describe una solicitud de creación de notificación.

Proporcione una opción de cadena JSON o especifique un archivo JSON del que leer proporcionando una opción de ruta de archivo que comience por @, por ejemplo --body=@path/to/file.json.

NotificationCreate

El siguiente ejemplo muestra el formato del objeto 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" : "{ }"
}

Ejemplo

Con los parámetros requeridos:

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 todos los parámetros:

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

Propiedades adicionales que se pueden configurar para la notificación de IOS

ajustes de la plataforma iOS
Propiedad	Tipo de propiedad	Descripción
`badge`	integer	El número a mostrar como identificador del icono de aplicación.
`interactive_category`	string	El identificador de categoría a utilizar para las notificaciones push interactivas.
`ios_action_key`	string	El título de la clave de acción.
`payload`	Objeto JSON	Carga útil JSON personalizada que se envía como parte del mensaje de notificación.
`sound`	string	El nombre del archivo de sonido del paquete de aplicación. El sonido de este archivo se reproduce como una alerta.
`title_loc_key`	string	La clave de una serie de título en el archivo Localizable.strings de la localización actual. La serie de la clave se puede formatear con especificadores %@ y %n$@ que serán sustituidos con las variables especificadas en la matriz titleLocArgs.
`loc_key`	string	Una clave para una serie alert-message en un archivo Localizable.strings para la localización actual (establecido por la preferencia de idioma del usuario). La serie de la clave se puede formatear con especificadores %@ y %n$@ que serán sustituidos con las variables especificadas en la matriz locArgs.
`launch_image`	string	El nombre de un archivo de imagen incluido en el paquete de la aplicación, con o sin la extensión del nombre de archivo. La imagen se utiliza como imagen de lanzamiento cuando los usuarios pulsan en el botón de acción o mueven el control deslizante de acción.
`title_loc_args`	string	Valores de cadena variables que aparecen en el lugar de los especificadores de formato en title-loc-key.
`loc_args`	string	Valores de serie variables que aparecen en lugar de los especificadores de formato en locKey.
`title`	string	El título de las notificaciones push completas (soportado únicamente en iOS 10 y superior).
`subtitle`	string	El subtítulo de las notificaciones completas (solo soportado en iOS 10 y superior).
`body`	string	El cuerpo para las notificaciones de iOS.
`attachment_url`	string	El enlace al soporte de las notificaciones iOS (vídeo, audio, GIF, imágenes - soportado únicamente en iOS 10 y superior).
`type`	string	Valores permitidos: DEFAULT, MIXED, SILENT.
`apns_collapse_id`	string	Varias notificaciones con el mismo identificador de contracción se muestran al usuario como una única notificación.
`apns_thread_id`	string	Un identificador específico de una app para agrupar notificaciones relacionadas. Este valor corresponde a la propiedad threadIdentifier del objeto UNNotificationContent.
`apns_group_summary_arg`	string	La serie que la notificación añade a la serie de formato de resumen de la categoría.
`apns_group_summary_arg_count`	integer	El número de elementos que la notificación añade a la serie de formato de resumen de la categoría.

Propiedades adicionales que se pueden configurar para la notificación de FCM

Ajustes de la plataforma Android
Propiedad	Tipo de propiedad	Descripción
`icon`	string	Especifica el nombre del icono a visualizar en la notificación. Asegúrese de que el icono ya está empaquetado con la aplicación de cliente.
`delay_while_idle`	Boolean	Cuando se establece en true, este parámetro indica que el mensaje no se debe enviar hasta que el dispositivo pase a estar activo.
`sync`	Boolean	La mensajería del grupo de dispositivos facilita que cada instancia de app de un grupo refleje el estado actualizado de mensajería.
`visibility`	string	privada o pública: visibilidad de esta notificación, lo que influye en cómo y cuándo se muestran las notificaciones en una pantalla de bloqueo segura.
`redact`	string	El contenido que se especifica aparece en una pantalla bloqueada segura en el dispositivo cuando la visibilidad se establece en Private.
`payload`	Objeto JSON	Carga útil JSON personalizada que se envía como parte del mensaje de notificación.
`priority`	string	Un valor de serie que indica la prioridad de esta notificación. Los valores permitidos son 'max', 'high', 'default', 'low' y 'min'. Las notificaciones de prioridad High/Max junto con el campo 'sound' se pueden utilizar para la notificación de Heads up en Android 5.0 o higher.sampleval='low'.
`sound`	string	El archivo de sonido (en el dispositivo) que se intentará reproducir cuando la notificación llegue al dispositivo.
`time_to_live`	integer	Especifica cuánto tiempo (en segundos) debe mantenerse el mensaje en el almacenamiento de GCM si el dispositivo está fuera de línea.
`lights`		Establece el color del LED de notificación al recibir la notificación push.
`ledArgb`	string	El color del led. El hardware realiza la mejor aproximación posible.
`ledOnMs`	integer	El tiempo en milisegundos en que el LED estará encendido mientras parpadea. El hardware realiza la mejor aproximación posible.
`ledOffMs`	string	El tiempo en milisegundos en que el LED estará apagado mientras parpadea. El hardware realiza la mejor aproximación posible.
`android_title`	string	El título de las notificaciones push completas.
`group_id`	string	Establezca esta notificación para que forme parte de un grupo de notificaciones que comparten la misma clave. Las notificaciones agrupadas se pueden mostrar en un clúster o en una pila en dispositivos que dan soporte a dicha representación.
`style`		Opciones que se pueden especificar para notificaciones expandibles de Android. Los tipos de notificaciones expandibles son picture_notification, bigtext_notification, inbox_notification.
`type`	string	Especifica el tipo de notificaciones expandible. Los valores posibles son bigtext_notification, picture_notification, inbox_notification.
`title`	string	Especifica el título de la notificación. El título se muestra cuando se expande la notificación. El título se debe especificar para las tres notificaciones expandibles.
`type`	string	Valores permitidos: DEFAULT, SILENT.
`alert`	string	El valor de alerta de Notificación.

Script de ejemplo para el aprovisionamiento de Event Notifications mediante CLI

El script provision_event_notification.sh automatiza el aprovisionamiento y la configuración de una instancia de Event Notifications.

Script de ejemplo para la integración de notificaciones de plataforma mediante CLI

El script en-platform-notification-src-and-email-dest.sh integra las Notificaciones de Plataforma con Event Notifications y dirige las notificaciones a IBM Inbuilt Email o Custom Domain Sandbox.

Script de ejemplo para la integración de IBM Cloud Logs mediante CLI

El script en-icl-src-and-email-dest.sh integra IBM Cloud Logs con Event Notifications y dirige las notificaciones a IBM Inbuilt Email o Custom Domain Sandbox.

Este script asume que la instancia IBM Cloud Logs y la instancia Event Notifications están en la misma cuenta.

Historial de versiones de CLI

Encuentre un resumen de los cambios para cada versión del plugin Event Notifications. Mantenga la CLI actualizada para que pueda utilizar todos los mandatos disponibles y sus opciones.

Las versiones del complemento CLI de 0.0.5 a 1.9.0 han quedado obsoletas.

Cambios en el IBM Cloud Event Notifications CLI
Versión	Fecha del release	Cambios
1.5.0	10 de mayo de 2024	Soporte para configuración SMTP y plantillas Slack.
1.6.0	1 de agosto de 2024	Destino CF obsoleto y compatible con MMS.
1.7.0	9 de agosto de 2024	Soporte para métricas y eliminado el soporte para IPs permitidas SMTP de la configuración SMTP.
1.8.0	9 de septiembre de 2024	Compatibilidad con el destino Slack DM.
1.9.0	11 de octubre de 2024	Soporte para plantillas Webhook.
1.10.0	4 de noviembre de 2024	Eliminado el soporte para Cloud Functions
1.11.0	7 de enero de 2025	Soporte para temporizador periódico
1.12.0	27 de febrero de 2025	Soporte para la plantilla Pagerduty
1.13.0	6 de marzo de 2025	Soporte para Event Streams destino, suscripción y Plantillas.
1.14.0	28 de abril de 2025	PagerDuty destino parámetro obsoleto `api_key` está marcado como opcional.
1.15.0	27 de junio de 2025	El contenido markdown para la notificación.
1.16.0	1 de agosto de 2025	Code Engine y plantillas predefinidas.
1.17.0	4 de septiembre de 2025	Soporte webhook destino prueba get notificaciones-estado comando
1.18.0	25 de septiembre de 2025	Destino de Appconfiguration, suscripción y soporte de plantillas
1.19.0	30 de octubre de 2025	Soporte para clonar credenciales de usuario smtp
1.20.0	15 de diciembre de 2025	Soporte para métricas de rebote
1.20.1	19 de enero de 2026	Corrección del problema de los metadatos de compatibilidad con puntos finales privados y de la instalación de plugins de ES en private.cloud.ibm.com
1.20.2	18 de febrero de 2026	Actualización del parche de corrección de vulnerabilidades del plugin CLI
1.21.0	7 de abril de 2026	Actualización del plugin CLI para el sandbox de vista, adjuntos de correo electrónico y soporte de opciones de origen para la depuración de la carga útil
1.21.1	25 de mayo de 2026	Se han eliminado los comando init y show y se ha añadido el comando de listado de instancias en. Corrección para establecer automáticamente el punto final EN en función de la región de destino establecida.
1.21.2	29 de junio de 2026	Corrección de un error en las métricas SMTP para que admitan el indicador «SMTP Config ID» y marquen el tipo de destino como opcional.
1.21.3	6 de agosto de 2026	Corrección de una vulnerabilidad del complemento CLI, mejoras de usabilidad y estéticas