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

• 最新
• 2023-12-15-preview
• 2023-06-01-preview
• 2022-06-15
• 2021-12-01
• 2021-10-15-preview
• 2021-06-01-preview
• 2020-10-15-preview
• 2020-06-01
• 2020-04-01-preview
• 2020-01-01-preview
• 2019-06-01
• 2019-02-01-preview
• 2018-09-15-preview

Bicep リソース定義

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

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

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

リソース形式

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

resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    inboundIpRules: [
      {
        action: 'Allow'
        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'
    }
  }

プロパティ値

domains

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

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

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'

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

PrivateEndpointConnection

名前	説明	値
properties	PrivateEndpointConnection のプロパティ。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

名前	説明	値
id	プライベート エンドポイントの ARM 識別子。	string

ConnectionState

名前	説明	値
actionsRequired	必要なアクション (存在する場合)。	string
description	接続状態の説明。	string
status	接続の状態。	'承認済み' 'Disconnected' '保留中' 'Rejected'

ResourceSku

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

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

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

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

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

リソース形式

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

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "inboundIpRules": [
      {
        "action": "Allow",
        "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"
    }
  }

プロパティ値

domains

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

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

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'

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

PrivateEndpointConnection

名前	説明	値
properties	PrivateEndpointConnection のプロパティ。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

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

PrivateEndpoint

名前	説明	値
id	プライベート エンドポイントの ARM 識別子。	string

ConnectionState

名前	説明	値
actionsRequired	必要なアクション (ある場合)。	string
description	接続状態の説明。	string
status	接続の状態。	'承認済み' 'Disconnected' '保留中' 'Rejected'

ResourceSku

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

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

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

• リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-04-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "Allow"
          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"
    }
  })
}

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

プロパティ値

domains

名前	説明	値
type	リソースの種類	"Microsoft.EventGrid/domains@2020-04-01-preview"
name	リソース名	string (必須) 文字数制限: 3 から 50 有効な文字: 英数字とハイフン。
location	リソースの場所。	string (必須)
parent_id	リソース グループにデプロイするには、そのリソース グループの ID を使用します。	string (必須)
tags	リソースのタグ。	タグ名と値のディクショナリ。
sku	ドメインの Sku 価格レベル。	ResourceSku
identity	リソースの ID 情報。	IdentityInfo
properties	ドメインのプロパティ。	DomainProperties

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

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 にさらに制限できます。	"無効" "有効"

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

PrivateEndpointConnection

名前	説明	値
properties	PrivateEndpointConnection のプロパティ。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名前	説明	値
groupIds	プライベート リンク サービス リソースの GroupIds。	string[]
privateEndpoint	この接続のプライベート エンドポイント リソース。	PrivateEndpoint
privateLinkServiceConnectionState	接続の状態の詳細。	ConnectionState
provisioningState	プライベート エンドポイント接続のプロビジョニング状態。	"キャンセル済み" "作成中" "削除中" "Failed" "Succeeded" "更新中"

PrivateEndpoint

名前	説明	値
id	プライベート エンドポイントの ARM 識別子。	string

ConnectionState

名前	説明	値
actionsRequired	必要なアクション (ある場合)。	string
description	接続状態の説明。	string
status	接続の状態。	"承認済み" "切断済み" "保留中" "Rejected"

ResourceSku

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