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

[アーティクル]
12/20/2024

Bicep リソース定義

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

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

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

リソースの形式

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

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

プロパティ値

ExtendedLocation

名前	形容	価値
名前	拡張場所の完全修飾名。	糸
種類	拡張された場所の種類。	糸

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

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

ResourceSku

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

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'

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": "2021-06-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "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"
    }
  }
}

プロパティ値

ExtendedLocation

名前	形容	価値
名前	拡張場所の完全修飾名。	糸
種類	拡張された場所の種類。	糸

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 のバージョン	'2021-06-01-preview'
extendedLocation	リソースの拡張された場所。	ExtendedLocation の
同一性	リソースの ID 情報。	IdentityInfo の
種類	リソースの種類。	'Azure' 'AzureArc'
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	トピックのプロパティ。	TopicProperties
sku	トピックの SKU 価格レベル。	ResourceSku
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.EventGrid/topics'

ResourceSku

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

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'

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@2021-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  kind = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "string"
          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"
    }
  }
}

プロパティ値

ExtendedLocation

名前	形容	価値
名前	拡張場所の完全修飾名。	糸
種類	拡張された場所の種類。	糸

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

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

ResourceSku

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

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'

TrackedResourceTags

名前	形容	価値

UserIdentityProperties

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

次の方法で共有

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

Bicep リソース定義

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/topics

ResourceSku

TopicProperties

TrackedResourceTags

UserIdentityProperties

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

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

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/topics

ResourceSku

TopicProperties

TrackedResourceTags

UserIdentityProperties

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

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

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/topics

ResourceSku

TopicProperties

TrackedResourceTags

UserIdentityProperties

フィードバック

その他のリソース

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

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

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