次の方法で共有


Microsoft.EventGrid トピック 2020-04-01-preview

Bicep リソース定義

トピック リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/topics リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.EventGrid/topics@2020-04-01-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

InputSchemaMapping オブジェクト

inputSchemaMappingType プロパティを設定して、オブジェクトの種類を指定します。

Jsonの場合は、次の値を使用します。

{
  inputSchemaMappingType: 'Json'
  properties: {
    dataVersion: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    eventTime: {
      sourceField: 'string'
    }
    eventType: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    id: {
      sourceField: 'string'
    }
    subject: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    topic: {
      sourceField: 'string'
    }
  }
}

プロパティ値

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InputSchemaMapping

名前 形容 価値
inputSchemaMappingType JsonInputSchemaMappingの型 'Json' に設定します。 'Json' (必須)

JsonField

名前 形容 価値
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonFieldWithDefault

名前 形容 価値
defaultValue SourceField が指定されていない場合、または発行された JSON イベント ペイロードに指定された名前のプロパティがない場合に、マッピングに使用される既定値。
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonInputSchemaMapping

名前 形容 価値
inputSchemaMappingType カスタム マッピングの種類 'Json' (必須)
プロパティ 入力スキーマ マッピングの JSON プロパティ JsonInputSchemaMappingProperties の

JsonInputSchemaMappingProperties

名前 形容 価値
dataVersion Event Grid イベントの DataVersion プロパティのマッピング情報。 JsonFieldWithDefault の
eventTime Event Grid イベントの EventTime プロパティのマッピング情報。 JsonField の
eventType Event Grid イベントの EventType プロパティのマッピング情報。 JsonFieldWithDefault の
身分証明書 Event Grid イベントの Id プロパティのマッピング情報。 JsonField の
件名 Event Grid イベントの Subject プロパティのマッピング情報。 JsonFieldWithDefault の
話題 Event Grid イベントの Topic プロパティのマッピング情報。 JsonField の

Microsoft.EventGrid/topics

名前 形容 価値
同一性 リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名 string (必須)
プロパティ トピックのプロパティ。 TopicProperties
sku トピックの SKU 価格レベル。 ResourceSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

ResourceSku

名前 形容 価値
名前 リソースの SKU 名。 使用できる値は Basic または Premium です。 'Basic'
'Premium'

TopicProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
inputSchema これにより、トピックに発行された受信イベントに対して Event Grid で想定される形式が決まります。 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping これにより、カスタム イベント スキーマを使用した発行が可能になります。 InputSchemaMapping を指定して、ソース スキーマのさまざまなプロパティを EventGridEvent スキーマのさまざまな必須プロパティにマップできます。 InputSchemaMapping
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" / <構成することで、特定の IP にさらに制限できます>
'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル 形容
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Azure Event Grid カスタム トピックとサブスクリプション を作成する Azure Event Grid カスタム トピックと Webhook サブスクリプションを作成します。 元は John Downs によって作成されたテンプレートです。

ARM テンプレート リソース定義

トピック リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/topics リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

InputSchemaMapping オブジェクト

inputSchemaMappingType プロパティを設定して、オブジェクトの種類を指定します。

Jsonの場合は、次の値を使用します。

{
  "inputSchemaMappingType": "Json",
  "properties": {
    "dataVersion": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "eventTime": {
      "sourceField": "string"
    },
    "eventType": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "id": {
      "sourceField": "string"
    },
    "subject": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "topic": {
      "sourceField": "string"
    }
  }
}

プロパティ値

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InputSchemaMapping

名前 形容 価値
inputSchemaMappingType JsonInputSchemaMappingの型 'Json' に設定します。 'Json' (必須)

JsonField

名前 形容 価値
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonFieldWithDefault

名前 形容 価値
defaultValue SourceField が指定されていない場合、または発行された JSON イベント ペイロードに指定された名前のプロパティがない場合に、マッピングに使用される既定値。
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonInputSchemaMapping

名前 形容 価値
inputSchemaMappingType カスタム マッピングの種類 'Json' (必須)
プロパティ 入力スキーマ マッピングの JSON プロパティ JsonInputSchemaMappingProperties の

JsonInputSchemaMappingProperties

名前 形容 価値
dataVersion Event Grid イベントの DataVersion プロパティのマッピング情報。 JsonFieldWithDefault の
eventTime Event Grid イベントの EventTime プロパティのマッピング情報。 JsonField の
eventType Event Grid イベントの EventType プロパティのマッピング情報。 JsonFieldWithDefault の
身分証明書 Event Grid イベントの Id プロパティのマッピング情報。 JsonField の
件名 Event Grid イベントの Subject プロパティのマッピング情報。 JsonFieldWithDefault の
話題 Event Grid イベントの Topic プロパティのマッピング情報。 JsonField の

Microsoft.EventGrid/topics

名前 形容 価値
apiVersion API のバージョン '2020-04-01-preview'
同一性 リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名 string (必須)
プロパティ トピックのプロパティ。 TopicProperties
sku トピックの SKU 価格レベル。 ResourceSku
タグ リソース タグ タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類 リソースの種類 'Microsoft.EventGrid/topics'

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

ResourceSku

名前 形容 価値
名前 リソースの SKU 名。 使用できる値は Basic または Premium です。 'Basic'
'Premium'

TopicProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
inputSchema これにより、トピックに発行された受信イベントに対して Event Grid で想定される形式が決まります。 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping これにより、カスタム イベント スキーマを使用した発行が可能になります。 InputSchemaMapping を指定して、ソース スキーマのさまざまなプロパティを EventGridEvent スキーマのさまざまな必須プロパティにマップできます。 InputSchemaMapping
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" / <構成することで、特定の IP にさらに制限できます>
'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート 形容
Azure Event Grid カスタム トピックとキュー サブスクリプション を作成する

Azure
にデプロイする
Azure Event Grid カスタム トピックと Service Bus キュー サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Azure Event Grid カスタム トピックとサブスクリプション を作成する

Azure
にデプロイする
Azure Event Grid カスタム トピックと Webhook サブスクリプションを作成します。 元は John Downs によって作成されたテンプレートです。
Azure Event Grid カスタム トピック サブスクリプション を作成する

Azure
にデプロイする
Azure Event Grid カスタム トピックと Service Bus トピック サブスクリプションを作成します。 テンプレートはもともと Markus Meyer によって作成されました。
Event Grid カスタム トピックとイベント ハブ ハンドラーの作成

Azure にデプロイする
イベントを処理する Azure Event Grid カスタム トピックとイベント ハブを作成します。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプションの

Azure
にデプロイする
カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベント ハンドラーとしてのロジック アプリを作成します。 元はジャスティン・ユーによって作成されたテンプレート。

Terraform (AzAPI プロバイダー) リソース定義

トピック リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.EventGrid/topics リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2020-04-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
    }
  })
}

InputSchemaMapping オブジェクト

inputSchemaMappingType プロパティを設定して、オブジェクトの種類を指定します。

Jsonの場合は、次の値を使用します。

{
  inputSchemaMappingType = "Json"
  properties = {
    dataVersion = {
      defaultValue = "string"
      sourceField = "string"
    }
    eventTime = {
      sourceField = "string"
    }
    eventType = {
      defaultValue = "string"
      sourceField = "string"
    }
    id = {
      sourceField = "string"
    }
    subject = {
      defaultValue = "string"
      sourceField = "string"
    }
    topic = {
      sourceField = "string"
    }
  }
}

プロパティ値

ConnectionState

名前 形容 価値
actionsRequired 必要なアクション (ある場合)。
形容 接続状態の説明。
地位 接続の状態。 'Approved'
'Disconnected'
'Pending'
'Rejected'

IdentityInfo

名前 形容 価値
principalId リソース ID のプリンシパル ID。
tenantId リソースのテナント ID。
種類 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キー参照は、次の形式の ARM リソース ID になります。
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
現在、このプロパティは使用されず、将来使用するために予約されています。
IdentityInfoUserAssignedIdentities の

IdentityInfoUserAssignedIdentities

名前 形容 価値

InboundIpRule

名前 形容 価値
アクション IpMask の一致または一致に基づいて実行するアクション。 'Allow'
ipMask CIDR 表記の IP アドレス (例: 10.0.0.0/8)。

InputSchemaMapping

名前 形容 価値
inputSchemaMappingType JsonInputSchemaMappingの型 'Json' に設定します。 'Json' (必須)

JsonField

名前 形容 価値
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonFieldWithDefault

名前 形容 価値
defaultValue SourceField が指定されていない場合、または発行された JSON イベント ペイロードに指定された名前のプロパティがない場合に、マッピングに使用される既定値。
sourceField マッピングのソースとして使用される入力イベント スキーマ内のフィールドの名前。

JsonInputSchemaMapping

名前 形容 価値
inputSchemaMappingType カスタム マッピングの種類 'Json' (必須)
プロパティ 入力スキーマ マッピングの JSON プロパティ JsonInputSchemaMappingProperties の

JsonInputSchemaMappingProperties

名前 形容 価値
dataVersion Event Grid イベントの DataVersion プロパティのマッピング情報。 JsonFieldWithDefault の
eventTime Event Grid イベントの EventTime プロパティのマッピング情報。 JsonField の
eventType Event Grid イベントの EventType プロパティのマッピング情報。 JsonFieldWithDefault の
身分証明書 Event Grid イベントの Id プロパティのマッピング情報。 JsonField の
件名 Event Grid イベントの Subject プロパティのマッピング情報。 JsonFieldWithDefault の
話題 Event Grid イベントの Topic プロパティのマッピング情報。 JsonField の

Microsoft.EventGrid/topics

名前 形容 価値
同一性 リソースの ID 情報。 IdentityInfo の
場所 リソースの場所。 string (必須)
名前 リソース名 string (必須)
プロパティ トピックのプロパティ。 TopicProperties
sku トピックの SKU 価格レベル。 ResourceSku
タグ リソース タグ タグ名と値のディクショナリ。
種類 リソースの種類 "Microsoft.EventGrid/topics@2020-04-01-preview"

PrivateEndpoint

名前 形容 価値
身分証明書 プライベート エンドポイントの ARM 識別子。

PrivateEndpointConnection

名前 形容 価値
プロパティ PrivateEndpointConnection のプロパティ。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前 形容 価値
groupIds プライベート リンク サービス リソースの GroupId。 string[]
privateEndpoint この接続のプライベート エンドポイント リソース。 PrivateEndpoint を する
privateLinkServiceConnectionState 接続の状態に関する詳細。 ConnectionState
provisioningState プライベート エンドポイント接続のプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'Succeeded'
'更新中'

ResourceSku

名前 形容 価値
名前 リソースの SKU 名。 使用できる値は Basic または Premium です。 'Basic'
'Premium'

TopicProperties

名前 形容 価値
inboundIpRules これは、すべての IP ではなく、特定の IP からのトラフィックを制限するために使用できます。 注: これらは、PublicNetworkAccess が有効になっている場合にのみ考慮されます。 InboundIpRule[]
inputSchema これにより、トピックに発行された受信イベントに対して Event Grid で想定される形式が決まります。 'CloudEventSchemaV1_0'
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping これにより、カスタム イベント スキーマを使用した発行が可能になります。 InputSchemaMapping を指定して、ソース スキーマのさまざまなプロパティを EventGridEvent スキーマのさまざまな必須プロパティにマップできます。 InputSchemaMapping
privateEndpointConnections PrivateEndpointConnection[]
publicNetworkAccess これにより、パブリック ネットワーク経由でトラフィックが許可されるかどうかが決まります。 既定では有効になっています。
seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules" / <構成することで、特定の IP にさらに制限できます>
'Disabled'
'Enabled'

TrackedResourceTags

名前 形容 価値

UserIdentityProperties

名前 形容 価値
clientId ユーザー割り当て ID のクライアント ID。
principalId ユーザー割り当て ID のプリンシパル ID。