Microsoft.EventGrid ドメイン 2020-04-01-preview

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

Bicep リソース定義

ドメインリソースの種類は、次を対象とする操作でデプロイできます。

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

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

リソースの形式

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

resource symbolicname 'Microsoft.EventGrid/domains@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'

DomainProperties

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

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/domains

名前	形容	価値
同一性	リソースの ID 情報。	IdentityInfo の
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	ドメインのプロパティ。	DomainProperties
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'

TrackedResourceTags

名前	形容	価値

UserIdentityProperties

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

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

ドメインリソースの種類は、次を対象とする操作でデプロイできます。

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

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

リソースの形式

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

{
  "type": "Microsoft.EventGrid/domains",
  "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'

DomainProperties

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

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/domains

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

PrivateEndpoint

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

PrivateEndpointConnection

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

PrivateEndpointConnectionProperties

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

ResourceSku

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

TrackedResourceTags

名前	形容	価値

UserIdentityProperties

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

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

ドメインリソースの種類は、次を対象とする操作でデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@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'

DomainProperties

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

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/domains

名前	形容	価値
同一性	リソースの ID 情報。	IdentityInfo の
場所	リソースの場所。	string (必須)
名前	リソース名	string (必須)
プロパティ	ドメインのプロパティ。	DomainProperties
sku	ドメインの SKU 価格レベル。	ResourceSku
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.EventGrid/domains@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'

TrackedResourceTags

名前	形容	価値

UserIdentityProperties

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

次の方法で共有

Microsoft.EventGrid ドメイン 2020-04-01-preview

Bicep リソース定義

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ConnectionState

DomainProperties

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/domains

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

ResourceSku

TrackedResourceTags

UserIdentityProperties

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

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ConnectionState

DomainProperties

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/domains

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

ResourceSku

TrackedResourceTags

UserIdentityProperties

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

リソースの形式

InputSchemaMapping オブジェクト

プロパティ値

ConnectionState

DomainProperties

IdentityInfo

IdentityInfoUserAssignedIdentities

InboundIpRule

InputSchemaMapping

JsonField

JsonFieldWithDefault

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

Microsoft.EventGrid/domains

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

ResourceSku

TrackedResourceTags

UserIdentityProperties

フィードバック

その他のリソース

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