Exemplos

• O exemplo a seguir mostra o formato do objeto DestinationConfig para o destino iOS (push_ios) com o certificado P8. Defina o parâmetro booleano pre_prod como true para configurar o destino como destino de pré-produção; caso contrário, defina o valor como 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)
      }
   }
   ```


- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino ` iOS ` (push_ios) com o certificado ` P12 `. Defina o parâmetro booleano `pre_prod` como *true* para configurar o destino como destino de pré-produção; caso contrário, defina o valor como *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)
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino Chrome (push_chrome). Defina o parâmetro booleano `pre_prod` como *true* para configurar o destino como destino de pré-produção; caso contrário, defina o valor como *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)
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino ` Firefox ` (push_firefox). Defina o parâmetro booleano `pre_prod` como *true* para configurar o destino como destino de pré-produção; caso contrário, defina o valor como *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)
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto `DestinationConfig` para o destino Slack (slack) com o tipo incoming_webhook.

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

- O exemplo a seguir mostra o formato do objeto `DestinationConfig` para o destino Slack (slack) com o tipo direct_message.

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

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino Safari (`push_safari`). Defina o parâmetro booleano `pre_prod` como *true* para configurar o destino como destino de pré-produção; caso contrário, defina o valor como *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)
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino MS Teams (msteams).

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

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino ` PagerDuty(pagerduty )`.

   Recomenda-se usar apenas a chave Routing ao criar o destino. A chave da API está obsoleta e não estará disponível para uso no futuro.
   {: attention}

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


- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o Webhook (webhook).

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

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o 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)
      }
   }
   ```


- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino ` ServiceNow(servicenow )`.

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

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino ` Code Engine ` (ibmce).

   código motor tipo de destino: aplicativo

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

   código engine destination type: job

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


- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o 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"
      }
   }
   ```


- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o 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)
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o destino “E-mail personalizado” (smtp_custom). No caso do destino Custom Email Sandbox (smtp_custom_sandbox), os parâmetros de Destination Configuration não são necessários.

   Processo Para fazer a configuração e a verificação do domínio 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"
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `DestinationConfig` ` para o 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"
      }
   }
   ```

- O exemplo a seguir mostra o formato do objeto “ `DestinationConfig` ” para o 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"
      }
   }
   ```

Observação: É possível criar um destino de SMS personalizado sem um “ `DestinationConfig` ”, mas ele não funcionará até que os números personalizados necessários sejam explicitamente solicitados e configurados. Para solicitar números personalizados, consulte “[Números personalizados para SMS](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers) ”.

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

- **Ação:** Listar todos os `Destination`.

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

• Parâmetros a serem fornecidos:

--limit LIMIT (int64)

O limite de página para resultados paginados.

O valor máximo é 100. O valor mínimo é 1.

--offset OFFSET (int64)

O deslocamento para resultados paginados.

O valor mínimo é 0.

--search SEARCH (string)

A sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--instance-id (string)

O identificador exclusivo da IBM Cloud instância Event Notifications.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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]/.

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador único para o Destino. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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]/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador único para o Destino. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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]/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `32` caracteres. O comprimento mínimo é de `32` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador único para o Destino. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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 (string)

Domínio de e-mail. Obrigatório.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador único para o Destino. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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 (string)

Tipo de verificação. Obrigatório.

O comprimento máximo é de 20 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-z]/.

Exemplo

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

Exemplo

• O exemplo a seguir mostra o formato do objeto TopicCreateSourcesItem[] para a fonte Periodic Timer.

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

- O exemplo a seguir mostra o formato do objeto ` `TopicCreateSourcesItem[]` `.

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

- O exemplo a seguir mostra o formato do 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 topic list {: #en-cli-topic-list-command}

- **Ação:** Listar todos os `Topic`.

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

• Parâmetros a serem fornecidos:

--limit LIMIT (int64)

O limite de página para resultados paginados.

O valor máximo é 100. O valor mínimo é 1.

--offset OFFSET (int64)

O deslocamento para resultados paginados.

O valor mínimo é 0.

--search SEARCH (string)

A sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (string)

O identificador exclusivo da IBM Cloud instância Event Notifications. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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]/.

Exemplos

• O exemplo a seguir mostra o formato do objeto SubscriptionCreateAttributes para o webhook.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para SMS.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para um e-mail do tipo ` 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"
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para o destino do Slack com o tipo `incoming_webhook`.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para o tipo de destino do Slack como `direct_message`.

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

• O exemplo a seguir mostra o formato do objeto SubscriptionCreateAttributes para ServiceNow.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para e-mails personalizados.

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- O exemplo a seguir mostra o formato do objeto `SubscriptionCreateAttributes` para o 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"
   }
   ```
   - O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para o Pagerduty/ Event Streams.

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para ` App Configuration `. Ao criar ou atualizar uma assinatura para um destino **App Configuration** destino, o objeto `attributes` tem uma regra específica:
      - Você deve **incluir **`feature_flag_enabled` **ou **`template_id_notification`
      - **Não** é possível incluir as duas propriedades ao mesmo tempo

      Isso garante que seja criada uma assinatura para o caso de uso correto — seja **para avaliação de sinalizadores de recurso**, seja **para criação de modelos de notificação**, mas não para ambos ao mesmo tempo.

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

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

- **Ação:** Listar todos os `Subscription`.

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

• Parâmetros a serem fornecidos:

--limit LIMIT (int64)

O limite de página para resultados paginados.

O valor máximo é 100. O valor mínimo é 1.

--offset OFFSET (int64)

O deslocamento para resultados paginados.

O valor mínimo é 0.

--search SEARCH (string)

A sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--instance-id INSTANCE-ID (string)

O identificador exclusivo da IBM Cloud instância Event Notifications. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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]/.

Exemplos

• O exemplo a seguir mostra o formato do objeto SubscriptionUpdateAttributes para o Webhook.

   {
      "signing_enabled": true
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionUpdateAttributes` ` para uma mensagem SMS do ` IBM `.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionUpdateAttributes` ` para um e-mail do tipo ` 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
   }
   ```

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionUpdateAttributes` ` para e-mails personalizados.

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

- O exemplo a seguir mostra o formato do objeto `SubscriptionUpdateAttributes` para o 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"
   }
   ```

- O exemplo a seguir mostra o formato do objeto `SubscriptionUpdateAttributes` do Slack para o tipo `incoming_webhook`.

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

- O exemplo a seguir mostra o formato do objeto `SubscriptionUpdateAttributes` do Slack para o tipo `direct_message`.

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

- O exemplo a seguir mostra o formato do objeto ` `SubscriptionUpdateAttributes` ` para o ServiceNow.

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

   - O exemplo a seguir mostra o formato do objeto ` `SubscriptionUpdateAttributes` ` para o Pagerduty/ Event Streams.

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

   - O exemplo a seguir mostra o formato do objeto ` `SubscriptionCreateAttributes` ` para ` App Configuration `. Ao criar ou atualizar uma assinatura para um destino **App Configuration** destino, o objeto `attributes` tem uma regra específica:
      - Você deve **incluir **`feature_flag_enabled` **ou **`template_id_notification`
      - **Não** é possível incluir as duas propriedades ao mesmo tempo
               Isso garante que seja criada uma assinatura para o caso de uso correto — seja **para avaliação de sinalizadores de recurso**, seja **para criação de modelos de notificação**, mas não para ambos ao mesmo tempo.

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

## Integrações {: #en-cli-integration}

Operar na integração IBM Cloud integração Event Notifications.

### integração de notificações de eventos do ibmcloud Criar {: #en-cli-integration-create-command}

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

Opções de comando

--instance-id (string)

Identificador exclusivo da IBM Cloud instância Event Notifications.

 O comprimento máximo é de `36` caracteres. O comprimento mínimo é de `36` caracteres. O valor deve corresponder à expressão 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 (string)

Tipo da integração collect_failed_events.

O comprimento máximo é de 50 caracteres. O comprimento mínimo é de 1 caracteres. O valor permitido é collect_failed_events.

--metadata (IntegrationCreateAttributes)

Esquema de integração para atualização

Metadados necessários para a integração.

Exemplos

• O exemplo a seguir mostra o formato do 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"
   }
   ```

### substituir a integração de notificações de eventos do ibmcloud {: #en-cli-integration-update-command}

Substitua `Integration`.

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

Opções de comando

--instance-id (string)

Identificador exclusivo da IBM Cloud instância Event Notifications.

 O comprimento máximo é de `36` caracteres. O comprimento mínimo é de `36` caracteres. O valor deve corresponder à expressão 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 (string)

Tipo de integração KMS/hs-crypto (obsoleto).

O comprimento máximo é de 50 caracteres. O comprimento mínimo é de 1 caracteres. Os valores permitidos são KMS e collect_failed_events. Observação: o tipo hs-crypto está obsoleto. Não haverá suporte para novos recursos de integração com o tipo hs-crypto.

--metadata (IntegrationReplaceAttributes)

Esquema de integração para atualização

Metadados necessários para a integração.

--id (string)

Identificador exclusivo para integração. Obrigatório.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9-:_]*/.

Exemplos

• O exemplo a seguir mostra o formato do objeto IntegrationReplaceAttributes para o kms.

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

### lista de integração de notificações de eventos do ibmcloud {: #en-cli-integration-list-command}

Listar todos os `Integrations`.

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

Opções de comando

--instance-id (string)

Identificador exclusivo da IBM Cloud instância Event Notifications.

 O comprimento máximo é de `36` caracteres. O comprimento mínimo é de `36` caracteres. O valor deve corresponder à expressão 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)

Limite de página para resultados paginados.

O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor mínimo é 0.

--search (string)

Sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

Opções de comando

--instance-id (string)

Identificador exclusivo da IBM Cloud instância Event Notifications.

 O comprimento máximo é de `36` caracteres. O comprimento mínimo é de `36` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para integração. Obrigatório.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9-:_]*/.

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

O modelo de mensagem. Obrigatório.

O comprimento máximo é de 255 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (string)

O tipo de modelo. Obrigatório.

O comprimento máximo é de 24 caracteres. O comprimento mínimo é de 22 caracteres. O valor deve corresponder à expressão regular /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Carga útil que descreve uma configuração de modelo. Obrigatório.

Em vez disso, essa opção JSON pode ser fornecida definindo campos individuais com outras opções. Ela é mutuamente exclusiva em relação a essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --params=@path/to/file.json.

--description (string)

A descrição do modelo.

O comprimento máximo é de 255 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--params-body (string)

Corpo do modelo. Essa opção fornece um valor para um subcampo da opção JSON 'params'. Ela é mutuamente exclusiva dessa opção.

O comprimento máximo é de 20000 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

--params-subject (string)

O assunto do modelo. Essa opção fornece um valor para um subcampo da opção JSON 'params'. Ela é mutuamente exclusiva dessa opção.

O comprimento máximo é de 1000 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

Exemplos

• O exemplo a seguir mostra o formato do objeto TemplateConfig para e-mail. O tipo suportado é 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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para o Slack. O tipo suportado é slack.notification.

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para o Webhook. O tipo suportado é webhook.notification

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para o Pagerduty. O tipo suportado é pagerduty.notification

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para Event Streams. O tipo suportado é event_streams.notification

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para o trabalho Code Engine. O tipo suportado é ibmcejob.notification

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para Code Engine Application/Function (Aplicativo/Função). O tipo suportado é ibmceapp.notification

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

• O exemplo a seguir mostra o formato do objeto TemplateConfig para App Configuration. O tipo suportado é app_configuration.notification

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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)

Limite de página para resultados paginados.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor padrão é 0. O valor mínimo é 0.

--search (string)

Sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--all-pages (bool)

Envie várias solicitações para exibir todas as páginas da coleção de modelos.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `32` caracteres. O comprimento mínimo é de `32` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo do modelo. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo do modelo. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--name (string)

Nome de modelo.

O comprimento máximo é de 255 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (string)

Descrição do modelo.

O comprimento máximo é de 255 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--type (string)

O tipo de modelo.

O comprimento máximo é de 24 caracteres. O comprimento mínimo é de 22 caracteres. O valor deve corresponder à expressão regular /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

Carga útil que descreve uma configuração de modelo. Em vez disso, essa opção JSON pode ser fornecida definindo campos individuais com outras opções. Ela é mutuamente exclusiva em relação a essas opções.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --params=@path/to/file.json.

Exemplos

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo do modelo. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `32` caracteres. O comprimento mínimo é de `32` caracteres. O valor deve corresponder à expressão 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 (string)

Tipo de fonte. Obrigatório.

O comprimento máximo é de 50 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

--type (string)

Tipo de destino. Obrigatório.

O comprimento máximo é de 50 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

--limit (int64)

Limite de página para resultados paginados.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor padrão é 0. O valor mínimo é 0.

--search (string)

Sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--all-pages (bool)

Envie várias solicitações para exibir todas as páginas da coleção para modelos predefinidos.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

O nome da configuração SMTP. Obrigatório.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--domain (string)

Nome de Domínio. Obrigatório.

O comprimento máximo é de 512 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

--description (string)

Descrição da configuração do SMTP.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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)

Limite de página para resultados paginados.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor padrão é 0. O valor mínimo é 0.

--search (string)

Sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--all-pages (bool)

Envie várias solicitações para exibir todas as páginas da coleção de configurações de SMTP.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--description (string)

Descrição da configuração do SMTP.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--username-to-clone (string)

fornece o nome do usuário a ser clonado.

O comprimento máximo é de 20 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /^[a-z0-9]{18}\\d{2}$/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--limit (int64)

Limite de página para resultados paginados.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor padrão é 0. O valor mínimo é 0.

--search (string)

Sequência de pesquisa para filtragem de resultados.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--all-pages (bool)

Envie várias solicitações para exibir todas as páginas da coleção dos usuários do SMTP.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--name (string)

Nome SMTP.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (string)

Descrição do SMTP.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--user-id (string)

UserID. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 5 caracteres. O valor deve corresponder à expressão regular /.*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--user-id (string)

UserID. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 5 caracteres. O valor deve corresponder à expressão regular /.*/.

--description (string)

Descrição do usuário SMTP.

O comprimento máximo é de 250 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--user-id (string)

UserID. Obrigatório.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 5 caracteres. O valor deve corresponder à expressão regular /.*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

Identificador exclusivo para SMTP. Obrigatório.

O comprimento máximo é de 32 caracteres. O comprimento mínimo é de 32 caracteres. O valor deve corresponder à expressão 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}/.

--type (string)

SMTP Tipo de verificação. Obrigatório.

O comprimento máximo é de 20 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /.*/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 (string)

GTE (maior que igual), registro de data e hora de início em UTC. Obrigatório.

O comprimento máximo é de 28 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão 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 (string)

LTE (menor que igual), registro de data e hora final em UTC. Obrigatório.

O comprimento máximo é de 28 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão 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/.

--smtp-config-id (string)

ID de configuração do SMTP. Obrigatório ao consultar métricas para destinos da interface SMTP.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--destination-type (string)

Tipo de destino para o qual as métricas são solicitadas. Valor compatível: smtp_custom. Obrigatório ao consultar métricas para destinos de e-mail personalizados.

Os valores permitidos são: smtp_custom.

--destination-id (string)

Identificador único para o Destino.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--subscription-id (string)

Identificador único para a Assinatura.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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-id (string)

Identificador único para a Origem.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9-:_]*/.

--email-to (string)

ID do e-mail do destinatário.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (string)

Notificação Id.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--subject (string)

assunto do e-mail.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `32` caracteres. O comprimento mínimo é de `32` caracteres. O valor deve corresponder à expressão 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 (string)

GTE (maior que igual), registro de data e hora de início em UTC. Obrigatório.

O comprimento máximo é de 28 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão 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 (string)

LTE (menor que igual), registro de data e hora final em UTC. Obrigatório.

O comprimento máximo é de 28 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão 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/.

--smtp-config-id (string)

ID de configuração do SMTP. Obrigatório ao consultar métricas para destinos da interface SMTP.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--destination-type (string)

Tipo de destino para o qual as métricas são solicitadas. Valor compatível: smtp_custom. Obrigatório ao consultar métricas para destinos de e-mail personalizados.

Os valores permitidos são: smtp_custom.

--destination-id (string)

Identificador único para o Destino.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--subscription-id (string)

Identificador único para a Assinatura.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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-id (string)

Identificador único para a Origem.

O comprimento máximo é de 100 caracteres. O comprimento mínimo é de 1 caractere. O valor deve corresponder à expressão regular /[a-zA-Z0-9-:_]*/.

--email-to (string)

ID do e-mail do destinatário.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (string)

Notificação Id.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

--subject (string)

assunto do e-mail.

O comprimento máximo é de 256 caracteres. O comprimento mínimo é de 0 caracteres. O valor deve corresponder à expressão regular /[a-zA-Z0-9]/.

--limit (int64)

Limite de página para resultados paginados.

O valor padrão é 10. O valor máximo é 100. O valor mínimo é 1.

--offset (int64)

deslocamento para resultados paginados.

O valor padrão é 0. O valor mínimo é 0.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `32` caracteres. O comprimento mínimo é de `32` caracteres. O valor deve corresponder à expressão 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 (string)

O ID da notificação retornado ao testar um destino de webhook. Este ID é específico para notificações de teste enviadas a destinos de webhook. Obrigatório.

O comprimento máximo é de 36 caracteres. O comprimento mínimo é de 36 caracteres. O valor deve corresponder à expressão 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}/.

Exemplo

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

Opções de comando

--instance-id (string)

Identificador único para a instância de notificações de eventos da IBM Cloud. Obrigatório.

 O comprimento máximo é de `256` caracteres. O comprimento mínimo é de `10` caracteres. O valor deve corresponder à expressão 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 descreve uma solicitação de criação de notificação.

Forneça uma opção de cadeia de caracteres JSON ou especifique um arquivo JSON para leitura, fornecendo uma opção de caminho de arquivo que comece com @, por exemplo, --body=@path/to/file.json.

Exemplo

Com os parâmetros obrigatórios:

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

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

Propriedades adicionais que podem ser configuradas para a notificação do IOS

Propriedades adicionais que podem ser configuradas para a notificação do FCM