Microsoft.EventGrid トピック 2021-06-01-preview

[アーティクル]
01/15/2024

Bicep リソース定義

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

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.EventGrid/topics@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    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'
    }
  }

プロパティ値

topics

名前	説明	値
name	リソース名	string (必須) 文字数制限: 3 から 50 有効な文字: 英数字とハイフン。
location	リソースの場所。	string (必須)
tags	リソースのタグ。	タグ名と値のディクショナリ。「テンプレートのタグ」を参照してください
sku	トピックの Sku 価格レベル。	ResourceSku
kind	リソースの種類。	'Azure' 'AzureArc'
extendedLocation	リソースの拡張された場所。	ExtendedLocation
identity	リソースの ID 情報。	IdentityInfo
properties	トピックのプロパティ。	TopicProperties

ExtendedLocation

名前	説明	値
name	拡張場所の完全修飾名。	string
type	拡張された場所の種類。	string

IdentityInfo

名前	説明	値
principalId	リソース ID のプリンシパル ID。	string
tenantId	リソースのテナント ID。	string
type	使用されるマネージド 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

名前	説明	値
{カスタマイズされたプロパティ}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

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

InboundIpRule

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

InputSchemaMapping

名前	説明	値
inputSchemaMappingType	オブジェクトの種類を設定する	Json (必須)

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

名前	説明	値
dataVersion	Event Grid イベントの DataVersion プロパティのマッピング情報。	JsonFieldWithDefault
eventTime	Event Grid イベントの EventTime プロパティのマッピング情報。	JsonField
eventType	Event Grid イベントの EventType プロパティのマッピング情報。	JsonFieldWithDefault
id	Event Grid イベントの Id プロパティのマッピング情報。	JsonField
subject	Event Grid イベントの Subject プロパティのマッピング情報。	JsonFieldWithDefault
topic	Event Grid イベントの Topic プロパティのマッピング情報。	JsonField

JsonFieldWithDefault

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

JsonField

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

ResourceSku

名前	説明	値
name	リソースの Sku 名。使用できる値は、Basic または Premium です。	'Basic' 'Premium'

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

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

Template	説明
カスタムトピックとサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Webhook サブスクリプションを作成します。最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション	カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベントハンドラーとしてのロジックアプリを作成します。テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタムトピックとイベントハブハンドラーを作成する	イベントを処理Azure Event Gridカスタムトピックとイベントハブを作成します。
カスタムトピックとキューサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Service Bus キューサブスクリプションを作成します。テンプレートは、もともと Markus Meyer によって作成されました。
カスタムトピックサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Service Bus トピックサブスクリプションを作成します。テンプレートは、もともと Markus Meyer によって作成されました。

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

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

リソースグループ - リソースグループのデプロイコマンドを参照してください

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

リソース形式

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

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "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"
    }
  }

プロパティ値

topics

名前	説明	値
type	リソースの種類	'Microsoft.EventGrid/topics'
apiVersion	リソース API のバージョン	'2021-06-01-preview'
name	リソース名	string (必須) 文字制限: 3 から 50 有効な文字: 英数字とハイフン。
location	リソースの場所。	string (必須)
tags	リソースのタグ。	タグの名前と値のディクショナリ。「テンプレート内のタグ」を参照してください
sku	トピックの Sku 価格レベル。	ResourceSku
kind	リソースの種類。	'Azure' 'AzureArc'
extendedLocation	リソースの拡張された場所。	ExtendedLocation
identity	リソースの ID 情報。	IdentityInfo
properties	トピックのプロパティ。	TopicProperties

ExtendedLocation

名前	説明	値
name	拡張場所の完全修飾名。	string
type	拡張場所の種類。	string

IdentityInfo

名前	説明	値
principalId	リソース ID のプリンシパル ID。	string
tenantId	リソースのテナント ID。	string
type	使用されるマネージド 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

名前	説明	値
{カスタマイズされたプロパティ}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

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

InboundIpRule

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

InputSchemaMapping

名前	説明	値
inputSchemaMappingType	オブジェクトの種類を設定する	Json (必須)

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

名前	説明	値
dataVersion	Event Grid イベントの DataVersion プロパティのマッピング情報。	JsonFieldWithDefault
eventTime	Event Grid イベントの EventTime プロパティのマッピング情報。	JsonField
eventType	Event Grid イベントの EventType プロパティのマッピング情報。	JsonFieldWithDefault
id	Event Grid イベントの Id プロパティのマッピング情報。	JsonField
subject	Event Grid イベントの Subject プロパティのマッピング情報。	JsonFieldWithDefault
topic	Event Grid イベントの Topic プロパティのマッピング情報。	JsonField

JsonFieldWithDefault

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

JsonField

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

ResourceSku

名前	説明	値
name	リソースの Sku 名。使用できる値は、Basic または Premium です。	'Basic' 'Premium'

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

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

Template	説明
カスタムトピックとサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Webhook サブスクリプションを作成します。最初に John Downs によって作成されたテンプレート。
CloudEvents を使用したカスタム Azure Event Grid トピック/サブスクリプション	カスタム Azure Event Grid トピック、CloudEvents スキーマを持つ Webhook サブスクリプション、およびイベントハンドラーとしてのロジックアプリを作成します。テンプレートは、もともと Justin Yoo によって作成されました。
Event Grid カスタムトピックとイベントハブハンドラーを作成する	イベントを処理Azure Event Gridカスタムトピックとイベントハブを作成します。
カスタムトピックとキューサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Service Bus キューサブスクリプションを作成します。テンプレートは、もともと Markus Meyer によって作成されました。
カスタムトピックサブスクリプションAzure Event Grid作成する	Azure Event Gridカスタムトピックと Service Bus トピックサブスクリプションを作成します。テンプレートは、もともと Markus Meyer によって作成されました。

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

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

リソースグループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2021-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
      type = "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"
    }
  }

プロパティ値

topics

名前	説明	値
type	リソースの種類	"Microsoft.EventGrid/topics@2021-06-01-preview"
name	リソース名	string (必須) 文字制限: 3 から 50 有効な文字: 英数字とハイフン。
location	リソースの場所。	string (必須)
parent_id	リソースグループにデプロイするには、そのリソースグループの ID を使用します。	string (必須)
tags	リソースのタグ。	タグの名前と値のディクショナリ。
sku	トピックの Sku 価格レベル。	ResourceSku
kind	リソースの種類。	"Azure" "AzureArc"
extendedLocation	リソースの拡張された場所。	ExtendedLocation
identity	リソースの ID 情報。	IdentityInfo
properties	トピックのプロパティ。	TopicProperties

ExtendedLocation

名前	説明	値
name	拡張場所の完全修飾名。	string
type	拡張場所の種類。	string

IdentityInfo

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

IdentityInfoUserAssignedIdentities

名前	説明	値
{カスタマイズされたプロパティ}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

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

InboundIpRule

名前	説明	値
action	IpMask の一致または一致に基づいて実行するアクション。	"許可"
ipMask	CIDR 表記の IP アドレス (例: 10.0.0.0/8)。	string

InputSchemaMapping

名前	説明	値
inputSchemaMappingType	オブジェクトの種類を設定する	Json (必須)

JsonInputSchemaMapping

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

JsonInputSchemaMappingProperties

名前	説明	値
dataVersion	Event Grid イベントの DataVersion プロパティのマッピング情報。	JsonFieldWithDefault
eventTime	Event Grid イベントの EventTime プロパティのマッピング情報。	JsonField
eventType	Event Grid イベントの EventType プロパティのマッピング情報。	JsonFieldWithDefault
id	Event Grid イベントの Id プロパティのマッピング情報。	JsonField
subject	Event Grid イベントの Subject プロパティのマッピング情報。	JsonFieldWithDefault
topic	Event Grid イベントの Topic プロパティのマッピング情報。	JsonField

JsonFieldWithDefault

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

JsonField

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

ResourceSku

名前	説明	値
name	リソースの Sku 名。使用できる値は、Basic または Premium です。	"Basic" "Premium"

次の方法で共有

Microsoft.EventGrid トピック 2021-06-01-preview

Bicep リソース定義

リソース形式

InputSchemaMapping オブジェクト

プロパティ値

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

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

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

リソース形式

InputSchemaMapping オブジェクト

プロパティ値

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

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

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

リソース形式

InputSchemaMapping オブジェクト

プロパティ値

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

フィードバック

その他のリソース

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

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

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