例

• 以下の例は、 P8 証明書を使用し、 iOS 宛先（push_ios）向けの DestinationConfig オブジェクトの形式を示しています。 pre_prod のブーリアンパラメータをtrueに設定すると、デスティネーションをプレプロダクション用に構成できます。それ以外の場合は、値を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)
      }
   }
   ```


- 以下の例は、 P12 証明書を使用した iOS 宛先（push_ios）向けの `DestinationConfig` オブジェクトの形式を示しています。 `pre_prod` のブーリアンパラメータ*をtrue*に設定すると、デスティネーションをプレプロダクション用に構成できます。それ以外の場合は、値*を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)
      }
   }
   ```

- 以下の例は、Chrome 宛先（push_chrome）用の ` `DestinationConfig` ` オブジェクトの形式を示しています。 `pre_prod` のブーリアンパラメータ*をtrue*に設定すると、デスティネーションをプレプロダクション用に構成できます。それ以外の場合は、値*を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)
      }
   }
   ```

- 以下の例は、 Firefox の宛先（push_firefox）に対する `DestinationConfig` オブジェクトの形式を示しています。 `pre_prod` のブーリアンパラメータ*をtrue*に設定すると、デスティネーションをプレプロダクション用に構成できます。それ以外の場合は、値*を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)
      }
   }
   ```

- 次の例は、Slackの宛先（slack）で、タイプがincoming_webhookの `DestinationConfig` オブジェクトのフォーマットを示しています。

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

- 次の例は、Slack宛先（slack）の `DestinationConfig` オブジェクトのフォーマットで、タイプがdirect_messageの場合を示しています。

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

- 以下の例は、Safari 宛先（push_safari）用の ` `DestinationConfig` ` オブジェクトの形式を示しています。 `pre_prod` のブーリアンパラメータ*をtrue*に設定すると、デスティネーションをプレプロダクション用に構成できます。それ以外の場合は、値*を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)
      }
   }
   ```

- 以下の例は、MS Teams（msteams）を宛先とする `DestinationConfig` オブジェクトの形式を示しています。

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

- 以下の例は、 PagerDuty(pagerduty ) を宛先とする `DestinationConfig` オブジェクトの形式を示しています。

   デスティネーションを作成する際は、Routingキーのみを使用することを推奨する。 APIキーは非推奨であり、今後使用することはできません。
   {: attention}

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


- 以下の例は、Webhook（webhook）用の `DestinationConfig` オブジェクトの形式を示しています。

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

- 以下の例は、Android（push_android）宛先用の `DestinationConfig` オブジェクトの形式を示しています。

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


- 以下の例は、 ServiceNow(servicenow ) 宛先に対する `DestinationConfig` オブジェクトの形式を示しています。

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

- 以下の例は、 Code Engine （ibmce）宛ての `DestinationConfig` オブジェクトの形式を示しています。

   コードエンジン宛先タイプ：アプリケーション

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

   コードエンジン宛先タイプ：ジョブ

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


- 以下の例は、 IBM Cloud Object Storage （ibmcos）宛ての `DestinationConfig` オブジェクトの形式を示しています。

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


- 以下の例は、Huawei（push_huawei）宛先における `DestinationConfig` オブジェクトの形式を示しています。

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

- 以下の例は、カスタムメール（smtp_custom）宛先における `DestinationConfig` オブジェクトの形式を示しています。 カスタムメールサンドボックス(smtp_custom_sandbox)の宛先の場合、宛先設定パラメータは必要ありません。

   プロセス カスタムドメインの設定と確認を行うには： <https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify>

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

- 以下の例は、 Event Streams （event_streams）宛先における `DestinationConfig` オブジェクトの形式を示しています。

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

- 以下の例は、 App Configuration （app_configuration）宛先における `DestinationConfig` オブジェクトの形式を示しています。

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

注： `DestinationConfig` を使用せずにカスタム SMS 送信先を作成することは可能ですが、必要な個人用番号を明示的にリクエストして設定するまでは機能しません。 パーソナライズされた番号を申請するには、「 [カスタムSMSのパーソナライズされた番号](/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom#en-destinations-sms-custom-numbers) 」をご覧ください。

### ibm クラウド・イベント通知の宛先リスト {: #en-cli-destination-list-command}

- **アクション：** すべての `Destination` を一覧表示する。

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

• 指定するパラメーター:

--limit LIMIT (int64)

ページ番号付き結果のページ制限。

最大値は 100 です。 最小値は 1です。

--offset OFFSET (int64)

ページ番号付き結果のオフセット。

最小値は 0 です。

--search SEARCH (文字列)

結果をフィルタリングするための検索ストリング。

最大長は100文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--instance-id (文字列)

IBM Cloudのユニークな識別子 Event Notificationsのインスタンス。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/と一致する必要があります。

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

宛先の固有の識別子。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

宛先の固有の識別子。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`32`文字です。 最小長は`32`文字です。 値は正規表現`/[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 (文字列)

宛先の固有の識別子。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/^[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 (文字列)

Eメールのドメイン 必須。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

宛先の固有の識別子。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

検証の種類。 必須。

最大長は20文字です。 最小文字数は 1 文字です。 値は正規表現/[a-z]/と一致する必要があります。

例

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

例

• 次の例は、周期的タイマーソースの TopicCreateSourcesItem[] オブジェクトのフォーマットを示しています。

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

- 次の例は、 `TopicCreateSourcesItem[]` オブジェクトの形式を示しています。

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

- 次の例は、 `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"
            }
         ]
      }
   ]
   ```

### ibm クラウド・イベント通知トピック・リスト {: #en-cli-topic-list-command}

- **アクション：** すべての `Topic` を一覧表示する。

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

• 指定するパラメーター:

--limit LIMIT (int64)

ページ番号付き結果のページ制限。

最大値は 100 です。 最小値は 1です。

--offset OFFSET (int64)

ページ番号付き結果のオフセット。

最小値は 0 です。

--search SEARCH (文字列)

結果をフィルタリングするための検索ストリング。

最大長は100文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--instance-id INSTANCE-ID (文字列)

IBM Cloudのユニークな識別子 Event Notificationsのインスタンス。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/と一致する必要があります。

例

• 以下の例は、Webhook用の SubscriptionCreateAttributes オブジェクトの形式を示しています。

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

- 以下の例は、SMS用の `SubscriptionCreateAttributes` オブジェクトの形式を示しています。

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

- 以下の例は、 IBM のメールにおける `SubscriptionCreateAttributes` オブジェクトの形式を示しています。

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

- 以下の例は、Slack 送信先タイプにおいて、 `SubscriptionCreateAttributes` オブジェクトの形式が「incoming_webhook」である場合を示しています。

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

- 以下の例は、Slack 送信先タイプが direct_message の場合の、 `SubscriptionCreateAttributes` オブジェクトの形式を示しています。

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

• 以下の例は、 ServiceNow における SubscriptionCreateAttributes オブジェクトの形式を示しています。

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

- 以下の例は、カスタムメール用の `SubscriptionCreateAttributes` オブジェクトの形式を示しています。

```json
   {
      "invited" :["entest@gmail.com"],
      "add_notification_payload": true,
      "reply_to_mail": "en@ibm.com",
      "reply_to_name": "EYS ORG",
   }
   ```
- 次の例は、Custom Email Sandboxの `SubscriptionCreateAttributes` オブジェクトのフォーマットを示しています。

```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"
   }
   ```
   - 以下の例は、Pagerduty/ Event Streams における ` `SubscriptionCreateAttributes` ` オブジェクトの形式を示しています。

   ```json
   {
      "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
   }
   ```
   - 以下の例は、 App Configuration における ` `SubscriptionCreateAttributes` ` オブジェクトの形式を示しています。 デスティネーションのサブスクリプションを作成または更新するとき **App Configuration** デスティネーションのサブスクリプションを作成または更新するとき、 `attributes` オブジェクトには特定のルールがあります：
      - **次のいずれかを**含める必要があります `feature_flag_enabled`**または**`template_id_notification`
      - 両方のプロパティを同時に含めることは**できません**

      これにより、サブスクリプションが正しいユースケース（ **機能フラグの評価か** **通知テンプレートの作成の**いずれか）に対して作成されることが保証されます。ただし、両方が同時に作成されることはありません。

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

### ibm クラウド・イベント通知サブスクリプション・リスト {: #en-cli-subscription-list-command}

- **アクション：** すべての `Subscription` を一覧表示する。

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

• 指定するパラメーター:

--limit LIMIT (int64)

ページ番号付き結果のページ制限。

最大値は 100 です。 最小値は 1です。

--offset OFFSET (int64)

ページ番号付き結果のオフセット。

最小値は 0 です。

--search SEARCH (文字列)

結果をフィルタリングするための検索ストリング。

最大長は100文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--instance-id INSTANCE-ID (文字列)

IBM Cloudのユニークな識別子 Event Notificationsのインスタンス。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/と一致する必要があります。

例

• 以下の例は、Webhook用の SubscriptionUpdateAttributes オブジェクトの形式を示しています。

   {
      "signing_enabled": true
   }
   ```

- 以下の例は、 IBM のSMSにおける `SubscriptionUpdateAttributes` オブジェクトの形式を示しています。

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

- 以下の例は、 IBM のメールにおける `SubscriptionUpdateAttributes` オブジェクトの形式を示しています。

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

- 以下の例は、カスタムメール用の `SubscriptionUpdateAttributes` オブジェクトの形式を示しています。

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

- 次の例は、Custom Email Sandboxの `SubscriptionUpdateAttributes` オブジェクトのフォーマットを示しています。

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

- 次の例は、Slack用の `SubscriptionUpdateAttributes` オブジェクトのタイプが `incoming_webhook` の場合のフォーマットを示しています。

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

- 次の例は、Slack用の `SubscriptionUpdateAttributes` オブジェクトのタイプが `direct_message` の場合のフォーマットを示しています。

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

- 以下の例は、Service Now用の `SubscriptionUpdateAttributes` オブジェクトのフォーマットを示しています。

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

   - 以下の例は、Pagerduty/ Event Streams における ` `SubscriptionUpdateAttributes` ` オブジェクトの形式を示しています。

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

   - 以下の例は、 App Configuration における ` `SubscriptionCreateAttributes` ` オブジェクトの形式を示しています。 デスティネーションのサブスクリプションを作成または更新するとき **App Configuration** デスティネーションのサブスクリプションを作成または更新するとき、 `attributes` オブジェクトには特定のルールがあります：
      - **次のいずれかを**含める必要があります `feature_flag_enabled`**または**`template_id_notification`
      - 両方のプロパティを同時に含めることは**できません**
               これにより、サブスクリプションが正しいユースケース（ **機能フラグの評価か** **通知テンプレートの作成の**いずれか）に対して作成されることが保証されます。ただし、両方が同時に作成されることはありません。

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

## 統合 {: #en-cli-integration}

IBM Cloud Event Notifications 統合で操作します。

### ibmcloud イベント通知の統合 作成 {: #en-cli-integration-create-command}

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

コマンド・オプション

--instance-id (文字列)

IBM CloudのインスタンスEvent Notificationsの固有の識別子。

 最大長は`36`文字です。 最小長は`36`文字です。 値は正規表現`/[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 (文字列)

統合の種類 collect_failed_events。

最大長は50文字です。 最小長は1文字です。 許容される値は collect_failed_events である。

--metadata (IntegrationCreateAttributes)

更新のための統合スキーマ

統合に必要なメタデータ。

例

• 次の例は、 IntegrationCreateAttributes オブジェクトの形式を示しています。

   {
      "endpoint": "https://s3.us-west.cloud-object-storage.appdomain.cloud",
      "crn": "crn:v1:bluemix:public:cloud-object-storage:global:xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx::",
      "bucket_name": "cloud-object-storage"
   }
   ```

### ibmcloud イベント通知の統合を置き換える {: #en-cli-integration-update-command}

`Integration` を置き換えます。

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

コマンド・オプション

--instance-id (文字列)

IBM CloudのインスタンスEvent Notificationsの固有の識別子。

 最大長は`36`文字です。 最小長は`36`文字です。 値は正規表現`/[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 (文字列)

統合のタイプ KMS/hs-crypto(非推奨)。

最大長は50文字です。 最小長は1文字です。 許可される値はKMSとcollect_failed_eventsである。 注：hs-crypto型は現在非推奨。 hs-cryptoタイプの新しい統合リソースはサポートされない。

--metadata (IntegrationReplaceAttributes)

更新のための統合スキーマ

統合に必要なメタデータ。

--id (文字列)

統合用のユニークな識別子。 必須。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9-:_]*/と一致する必要があります。

例

• 以下の例は、kms 用の IntegrationReplaceAttributes オブジェクトの形式を示しています。

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

### ibmcloud イベント通知 統合リスト {: #en-cli-integration-list-command}

すべての`Integrations`をリストします。

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

コマンド・オプション

--instance-id (文字列)

IBM CloudのインスタンスEvent Notificationsの固有の識別子。

 最大長は`36`文字です。 最小長は`36`文字です。 値は正規表現`/[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)

ページ番号付き結果のページ限界。

最大値は 100 です。 最小値は 1です。

--offset (int64)

ページ番号付き結果のオフセット。

最小値は 0 です。

--search (文字列)

フィルタリング結果の検索文字列。

最大長は100文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

コマンド・オプション

--instance-id (文字列)

IBM CloudのインスタンスEvent Notificationsの固有の識別子。

 最大長は`36`文字です。 最小長は`36`文字です。 値は正規表現`/[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 (文字列)

統合用のユニークな識別子。 必須。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9-:_]*/と一致する必要があります。

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

メッセージテンプレート。 必須。

最大長は255文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--type (文字列)

テンプレートの種類。 必須。

最大長は24文字です。 最小長は22文字です。 値は正規表現/^(smtp_custom.notification|smtp_custom.invitation)$/と一致する必要があります。

--params (TemplateConfig)

テンプレートの構成を記述するペイロード。 必須。

このJSONオプションは、個々のフィールドを他のオプションで設定することで提供することもできます。 それらのオプションとは相互に排他的です。

JSON文字列オプションを提供するか、または @ で始まるファイルパスオプションを指定して、読み込むJSONファイルを指定します。例えば、 --params=@path/to/file.json。

--description (文字列)

テンプレートの説明。

最大長は255文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--params-body (文字列)

テンプレート本文。 このオプションは、JSONオプション「params」のサブフィールドに値を提供します。 そのオプションとは両立しません。

最大長は20000文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

--params-subject (文字列)

テンプレートの件名。 このオプションは、JSONオプション「params」のサブフィールドに値を提供します。 そのオプションとは両立しません。

最大長は1000文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

例

• 以下の例は、Eメール用の TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは、 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

• 以下の例は、Slack用の TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは slack.notification です。

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

• 以下の例は、Webhook用の TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは、 webhook.notification

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

• 以下の例は、Pagerduty用の TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは、 pagerduty.notification

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

• 以下の例は、 Event Streams における TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは、 event_streams.notification

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

• 次の例は、 Code Engine ジョブの TemplateConfig オブジェクトのフォーマットを示している。 サポートされているタイプは、 ibmcejob.notification

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

• 次の例は、 Code Engine アプリケーション/ファンクションの TemplateConfig オブジェクトのフォーマットを示しています。 サポートされているタイプは、 ibmceapp.notification

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

• 以下の例は、 App Configuration における TemplateConfig オブジェクトの形式を示しています。 サポートされているタイプは、 app_configuration.notification

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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)

ページ番号付き結果のページ限界。

デフォルト値は 10です。 最大値は 100 です。 最小値は 1 です。

--offset (int64)

ページ番号付き結果のオフセット。

デフォルト値は 0です。 最小値は 0です。

--search (文字列)

フィルタリング結果の検索文字列。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--all-pages (ブール値)

テンプレートのコレクションの全ページを表示するには、複数のリクエストを実行します。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`32`文字です。 最小長は`32`文字です。 値は正規表現`/[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 (文字列)

テンプレート用のユニークな識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

テンプレート用のユニークな識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

テンプレート名。

最大長は255文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--description (文字列)

テンプレートの説明。

最大長は255文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--type (文字列)

テンプレートの種類。

最大長は24文字です。 最小長は22文字です。 値は正規表現/^(smtp_custom.notification|smtp_custom.invitation)$/と一致する必要があります。

--params (TemplateConfig)

テンプレートの構成を記述するペイロード。 このJSONオプションは、個々のフィールドを他のオプションで設定することで提供することもできます。 それらのオプションとは相互に排他的です。

JSON文字列オプションを提供するか、または @ で始まるファイルパスオプションを指定して、読み込むJSONファイルを指定します。例えば、 --params=@path/to/file.json。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

テンプレート用のユニークな識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`32`文字です。 最小長は`32`文字です。 値は正規表現`/[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 (文字列)

ソースの種類 必須。

最大長は50文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

--type (文字列)

宛先タイプ。 必須。

最大長は50文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

--limit (int64)

ページ番号付き結果のページ限界。

デフォルト値は 10です。 最大値は 100 です。 最小値は 1 です。

--offset (int64)

ページ番号付き結果のオフセット。

デフォルト値は 0です。 最小値は 0です。

--search (文字列)

フィルタリング結果の検索文字列。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--all-pages (ブール値)

「pre-defined-templates」のコレクションの全ページを表示するために、複数のリクエストを実行します。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP設定の名称。 必須。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--domain (文字列)

ドメイン名。 必須。

最大長は512文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

--description (文字列)

SMTPの設定に関する説明。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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)

ページ番号付き結果のページ限界。

デフォルト値は 10です。 最大値は 100 です。 最小値は 1 です。

--offset (int64)

ページ番号付き結果のオフセット。

デフォルト値は 0です。 最小値は 0です。

--search (文字列)

フィルタリング結果の検索文字列。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--all-pages (ブール値)

smtp-configurations のコレクションの全ページを表示するために、複数のリクエストを実行します。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

SMTPの設定に関する説明。

最大長は250文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--username-to-clone (文字列)

クローンするユーザーの名前を指定します。

最大長は20文字です。 最小文字数は 1 文字です。 値は正規表現/^[a-z0-9]{18}\\d{2}$/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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)

ページ番号付き結果のページ限界。

デフォルト値は 10です。 最大値は 100 です。 最小値は 1 です。

--offset (int64)

ページ番号付き結果のオフセット。

デフォルト値は 0です。 最小値は 0です。

--search (文字列)

フィルタリング結果の検索文字列。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--all-pages (ブール値)

smtp-users のコレクションの全ページを表示するために、複数のリクエストを実行します。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

SMTP名。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

--description (文字列)

SMTPの説明。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

UserID. 必須。

最大長は256文字です。 最小長は5文字です。 値は正規表現/.*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

UserID. 必須。

最大長は256文字です。 最小長は5文字です。 値は正規表現/.*/と一致する必要があります。

--description (文字列)

SMTPユーザーの説明。

最大長は250文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

UserID. 必須。

最大長は256文字です。 最小長は5文字です。 値は正規表現/.*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

SMTP用の一意の識別子。 必須。

最大長は32文字です。 最小長は32文字です。 値は正規表現/[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 (文字列)

SMTP認証の種類。 必須。

最大長は20文字です。 最小文字数は 1 文字です。 値は正規表現/.*/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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 (文字列)

GTE（より大きい）、UTCでの開始タイムスタンプ。 必須。

最大長は28文字です。 最小文字数は 1 文字です。 値は正規表現/[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 (文字列)

LTE（less than equal）、UTCでのタイムスタンプの終了。 必須。

最大長は28文字です。 最小文字数は 1 文字です。 値は正規表現/[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 (文字列)

SMTPの設定ID。 SMTP インターフェースの宛先に関するメトリクスを照会する際に必須です。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

メトリクスの取得が要求される宛先タイプ。 サポートされている値：smtp_custom。 カスタムメール送信先に関するメトリクスを照会する際に必須です。

使用できる値は、smtp_customです。

--destination-id (文字列)

宛先の固有の識別子。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

サブスクリプションの固有の識別子。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

ソースの固有の識別子。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9-:_]*/と一致する必要があります。

--email-to (文字列)

受信者のメールアドレス。

最大長は256文字です。 最小長は0文字です。 値は正規表現/[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/と一致する必要があります。

--notification-id (文字列)

通知ID。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

メールの件名。

最大長は256文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`32`文字です。 最小長は`32`文字です。 値は正規表現`/[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 (文字列)

GTE（より大きい）、UTCでの開始タイムスタンプ。 必須。

最大長は28文字です。 最小文字数は 1 文字です。 値は正規表現/[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 (文字列)

LTE（less than equal）、UTCでのタイムスタンプの終了。 必須。

最大長は28文字です。 最小文字数は 1 文字です。 値は正規表現/[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 (文字列)

SMTPの設定ID。 SMTP インターフェースの宛先に関するメトリクスを照会する際に必須です。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

メトリクスの取得が要求される宛先タイプ。 サポートされている値：smtp_custom。 カスタムメール送信先に関するメトリクスを照会する際に必須です。

使用できる値は、smtp_customです。

--destination-id (文字列)

宛先の固有の識別子。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

サブスクリプションの固有の識別子。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

ソースの固有の識別子。

最大長は100文字です。 最小文字数は 1 文字です。 値は正規表現/[a-zA-Z0-9-:_]*/と一致する必要があります。

--email-to (文字列)

受信者のメールアドレス。

最大長は256文字です。 最小長は0文字です。 値は正規表現/[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/と一致する必要があります。

--notification-id (文字列)

通知ID。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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 (文字列)

メールの件名。

最大長は256文字です。 最小長は0文字です。 値は正規表現/[a-zA-Z0-9]/と一致する必要があります。

--limit (int64)

ページ番号付き結果のページ限界。

デフォルト値は 10です。 最大値は 100 です。 最小値は 1 です。

--offset (int64)

ページ番号付き結果のオフセット。

デフォルト値は 0です。 最小値は 0です。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`32`文字です。 最小長は`32`文字です。 値は正規表現`/[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 (文字列)

Webhookの送信先をテストした際に返される通知ID。 このIDは、Webhookの送信先へ送信されるテスト通知に固有のものです。 必須。

最大長は36文字です。 最小長は36文字です。 値は正規表現/[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}/と一致する必要があります。

例

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

コマンド・オプション

--instance-id (文字列)

IBMクラウド・イベント通知インスタンスの固有の識別子。 必須。

 最大長は`256`文字です。 最小長は`10`文字です。 値は正規表現`/[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)

通知作成リクエストを説明するペイロード。

JSON文字列オプションを提供するか、または @ で始まるファイルパスオプションを指定して、読み込むJSONファイルを指定します。例えば、 --body=@path/to/file.json。

例

必要なパラメータを指定して：

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

すべてのパラメータを含む場合：

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

IOS 通知用に構成できるその他のプロパティー

FCM 通知用に構成できる追加のプロパティー