Microsoft.EventGrid partnerNamespaces/channels 2023-12-15-preview

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    channelType: 'string'
    expirationTimeIfNotActivatedUtc: 'string'
    messageForActivation: 'string'
    partnerDestinationInfo: {
      azureSubscriptionId: 'string'
      endpointServiceContext: 'string'
      name: 'string'
      resourceGroupName: 'string'
      resourceMoveChangeHistory: [
        {
          azureSubscriptionId: 'string'
          changedTimeUtc: 'string'
          resourceGroupName: 'string'
        }
      ]
      endpointType: 'string'
      // For remaining properties, see PartnerDestinationInfo objects
    }
    partnerTopicInfo: {
      azureSubscriptionId: 'string'
      eventTypeInfo: {
        inlineEventTypes: {
          {customized property}: {
            dataSchemaUrl: 'string'
            description: 'string'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'Inline'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

PartnerDestinationInfo オブジェクト

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

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

  endpointType: 'WebHook'
  properties: {
    clientAuthentication: {
      clientAuthenticationType: 'string'
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl: 'string'
    endpointUrl: 'string'
  }

PartnerClientAuthentication オブジェクト

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

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

  clientAuthenticationType: 'AzureAD'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
  }

プロパティ値

partnerNamespaces/channels

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: partnerNamespaces
properties チャネルのプロパティ。 ChannelProperties

ChannelProperties

名前 説明 値
channelType イベントの方向フローを表すイベント チャネルの型。 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc チャネルの有効期限。 対応するパートナー トピックがアクティブ化されていない間にこのタイマーが期限切れになった場合、
チャネルと対応するパートナー トピックが削除されます。		 string
messageForActivation サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 string
partnerDestinationInfo このプロパティは、channelType が PartnerDestination の場合に設定する必要があり、チャネルに対応するパートナーの宛先リソースに関する情報を表します。 PartnerDestinationInfo
partnerTopicInfo このプロパティは、channelType が PartnerTopic で、チャネルに対応するパートナー トピック リソースに関する情報を表す場合に設定する必要があります。 PartnerTopicInfo
provisioningState チャネルのプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
'Succeeded'
'更新中'
readinessState 対応するパートナー トピックの準備状態。 'Activated'
'NeverActivated'

PartnerDestinationInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナーの宛先は、
この Azure サブスクリプションで作成されます。		 string
endpointServiceContext パートナーの宛先エンドポイントの追加のコンテキスト。 string
name チャネルに関連付けられているパートナーの宛先の名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナーの宛先は、
このリソース グループの下に作成されます。		 string
resourceMoveChangeHistory リソース移動の変更履歴。 ResourceMoveChangeHistory[]
endpointType オブジェクトの種類を設定する WebHook (必須)

ResourceMoveChangeHistory

名前 説明 値
azureSubscriptionId リソースの Azure サブスクリプション ID。 string
changedTimeUtc リソースが変更されたときの UTC タイムスタンプ。 string
resourceGroupName リソースの Azure リソース グループ。 string

WebhookPartnerDestinationInfo

名前 説明 値
endpointType パートナーの宛先のエンドポイントの種類 'WebHook' (必須)
properties パートナーの宛先の WebHook プロパティ。 WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名前 説明 値
clientAuthentication パートナー クライアント認証 PartnerClientAuthentication
endpointBaseUrl パートナーの宛先のエンドポイントを表すベース URL。 string
endpointUrl パートナーの宛先のエンドポイントを表す URL。 string

PartnerClientAuthentication

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

AzureADPartnerClientAuthentication

名前 説明 値
clientAuthenticationType クライアント認証の種類 'AzureAD' (必須)
properties AzureAD ClientAuthentication プロパティ AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。 string

PartnerTopicInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナー トピックは、
この Azure サブスクリプションで作成されます。		 string
eventTypeInfo パートナー トピックのイベントの種類情報。 この情報は発行元によって提供され、
パブリッシュされたさまざまな種類のイベントを表示するサブスクライバー。		 EventTypeInfo
name チャネルに関連付けられているパートナー トピックの名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナー トピックは、
このリソース グループの下に作成されます。		 string
source ソース情報は、パブリッシャーによって提供され、イベントの基になるスコープまたはコンテキストを決定します。
が発生しています。 この情報は、 の承認プロセス中にサブスクライバーが使用できます。
パートナー トピックを作成しました。
 string

EventTypeInfo

名前 説明 値
inlineEventTypes リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。
有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。
インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。		 EventTypeInfoInlineEventTypes
kind 使用されるイベントの種類。 'Inline'

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名前 説明 値
dataSchemaUrl インライン イベントの dataSchemaUrl。 string
description インライン イベントの説明。 string
displayName インライン イベントの displayName。 string
documentationUrl インライン イベントの documentationUrl。 string

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

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

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

リソース形式

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

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "channelType": "string",
    "expirationTimeIfNotActivatedUtc": "string",
    "messageForActivation": "string",
    "partnerDestinationInfo": {
      "azureSubscriptionId": "string",
      "endpointServiceContext": "string",
      "name": "string",
      "resourceGroupName": "string",
      "resourceMoveChangeHistory": [
        {
          "azureSubscriptionId": "string",
          "changedTimeUtc": "string",
          "resourceGroupName": "string"
        }
      ],
      "endpointType": "string"
      // For remaining properties, see PartnerDestinationInfo objects
    },
    "partnerTopicInfo": {
      "azureSubscriptionId": "string",
      "eventTypeInfo": {
        "inlineEventTypes": {
          "{customized property}": {
            "dataSchemaUrl": "string",
            "description": "string",
            "displayName": "string",
            "documentationUrl": "string"
          }
        },
        "kind": "Inline"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

PartnerDestinationInfo オブジェクト

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

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

  "endpointType": "WebHook",
  "properties": {
    "clientAuthentication": {
      "clientAuthenticationType": "string"
      // For remaining properties, see PartnerClientAuthentication objects
    },
    "endpointBaseUrl": "string",
    "endpointUrl": "string"
  }

PartnerClientAuthentication オブジェクト

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

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

  "clientAuthenticationType": "AzureAD",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }

プロパティ値

partnerNamespaces/channels

名前 説明 値
type リソースの種類 'Microsoft.EventGrid/partnerNamespaces/channels'
apiVersion リソース API のバージョン '2023-12-15-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties チャネルのプロパティ。 ChannelProperties

ChannelProperties

名前 説明 値
channelType イベントの方向フローを表すイベント チャネルの種類。 'PartnerDestination'
'PartnerTopic'
expirationTimeIfNotActivatedUtc チャネルの有効期限。 対応するパートナー トピックがアクティブ化されていない間にこのタイマーが期限切れになった場合、
チャネルと対応するパートナー トピックが削除されます。		 string
messageForActivation サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 string
partnerDestinationInfo channelType が PartnerDestination で、チャネルに対応するパートナーの宛先リソースに関する情報を表す場合は、このプロパティを設定する必要があります。 PartnerDestinationInfo
partnerTopicInfo channelType が PartnerTopic で、チャネルに対応するパートナー トピック リソースに関する情報を表す場合は、このプロパティを設定する必要があります。 PartnerTopicInfo
provisioningState チャネルのプロビジョニング状態。 'Canceled'
'Creating'
'削除中'
'Failed'
'IdleDueToMirroredPartnerDestinationDeletion'
'IdleDueToMirroredPartnerTopicDeletion'
'Succeeded'
'更新中'
readinessState 対応するパートナー トピックの準備状態。 'Activated'
'NeverActivated'

PartnerDestinationInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナーの宛先は、
この Azure サブスクリプションの下に作成されます。		 string
endpointServiceContext パートナーの宛先エンドポイントの追加のコンテキスト。 string
name チャネルに関連付けられているパートナーの宛先の名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナーの宛先は、
このリソース グループの下に作成されます。		 string
resourceMoveChangeHistory リソース移動の変更履歴。 ResourceMoveChangeHistory[]
endpointType オブジェクトの種類を設定する WebHook (必須)

ResourceMoveChangeHistory

名前 説明 値
azureSubscriptionId リソースの Azure サブスクリプション ID。 string
changedTimeUtc リソースが変更されたときの UTC タイムスタンプ。 string
resourceGroupName リソースの Azure リソース グループ。 string

WebhookPartnerDestinationInfo

名前 説明 値
endpointType パートナーの宛先のエンドポイントの種類 'WebHook' (必須)
properties パートナーの宛先の WebHook プロパティ。 WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名前 説明 値
clientAuthentication パートナー クライアント認証 PartnerClientAuthentication
endpointBaseUrl パートナーの宛先のエンドポイントを表すベース URL。 string
endpointUrl パートナーの宛先のエンドポイントを表す URL。 string

PartnerClientAuthentication

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

AzureADPartnerClientAuthentication

名前 説明 値
clientAuthenticationType クライアント認証の種類 'AzureAD' (必須)
properties AzureAD ClientAuthentication プロパティ AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。 string

PartnerTopicInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナー トピックは、
この Azure サブスクリプションで作成されます。		 string
eventTypeInfo パートナー トピックのイベントの種類情報。 この情報は発行元によって提供され、
パブリッシュされたさまざまな種類のイベントを表示するサブスクライバー。		 EventTypeInfo
name チャネルに関連付けられているパートナー トピックの名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナー トピックは、
このリソース グループの下に作成されます。		 string
source ソース情報は、パブリッシャーによって提供され、イベントの基になるスコープまたはコンテキストを決定します。
が発生しています。 この情報は、 の承認プロセス中にサブスクライバーが使用できます。
パートナー トピックを作成しました。
 string

EventTypeInfo

名前 説明 値
inlineEventTypes リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。
有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。
インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。		 EventTypeInfoInlineEventTypes
kind 使用されるイベントの種類。 'Inline'

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名前 説明 値
dataSchemaUrl インライン イベントの dataSchemaUrl。 string
description インライン イベントの説明。 string
displayName インライン イベントの displayName。 string
documentationUrl インライン イベントの documentationUrl。 string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      channelType = "string"
      expirationTimeIfNotActivatedUtc = "string"
      messageForActivation = "string"
      partnerDestinationInfo = {
        azureSubscriptionId = "string"
        endpointServiceContext = "string"
        name = "string"
        resourceGroupName = "string"
        resourceMoveChangeHistory = [
          {
            azureSubscriptionId = "string"
            changedTimeUtc = "string"
            resourceGroupName = "string"
          }
        ]
        endpointType = "string"
        // For remaining properties, see PartnerDestinationInfo objects
      }
      partnerTopicInfo = {
        azureSubscriptionId = "string"
        eventTypeInfo = {
          inlineEventTypes = {
            {customized property} = {
              dataSchemaUrl = "string"
              description = "string"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "Inline"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

PartnerDestinationInfo オブジェクト

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

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

  endpointType = "WebHook"
  properties = {
    clientAuthentication = {
      clientAuthenticationType = "string"
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl = "string"
    endpointUrl = "string"
  }

PartnerClientAuthentication オブジェクト

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

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

  clientAuthenticationType = "AzureAD"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
  }

プロパティ値

partnerNamespaces/channels

名前 説明 値
type リソースの種類 "Microsoft.EventGrid/partnerNamespaces/channels@2023-12-15-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: partnerNamespaces
properties チャネルのプロパティ。 ChannelProperties

ChannelProperties

名前 説明 値
channelType イベントの方向フローを表すイベント チャネルの型。 "PartnerDestination"
"PartnerTopic"
expirationTimeIfNotActivatedUtc チャネルの有効期限。 対応するパートナー トピックがアクティブ化されていない間にこのタイマーが期限切れになった場合、
チャネルと対応するパートナー トピックが削除されます。		 string
messageForActivation サブスクライバーによる承認プロセス中に使用できるコンテキストまたは役立つメッセージ。 string
partnerDestinationInfo このプロパティは、channelType が PartnerDestination の場合に設定する必要があり、チャネルに対応するパートナーの宛先リソースに関する情報を表します。 PartnerDestinationInfo
partnerTopicInfo このプロパティは、channelType が PartnerTopic で、チャネルに対応するパートナー トピック リソースに関する情報を表す場合に設定する必要があります。 PartnerTopicInfo
provisioningState チャネルのプロビジョニング状態。 "キャンセル済み"
"作成中"
"削除中"
"Failed"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Succeeded"
"更新中"
readinessState 対応するパートナー トピックの準備状態。 "アクティブ化済み"
"NeverActivated"

PartnerDestinationInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナーの宛先は、
この Azure サブスクリプションの下に作成されます。		 string
endpointServiceContext パートナーの宛先エンドポイントの追加コンテキスト。 string
name チャネルに関連付けられているパートナーの宛先の名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナーの宛先は、
このリソース グループの下に作成されます。		 string
resourceMoveChangeHistory リソース移動の変更履歴。 ResourceMoveChangeHistory[]
endpointType オブジェクトの種類を設定する WebHook (必須)

ResourceMoveChangeHistory

名前 説明 値
azureSubscriptionId リソースの Azure サブスクリプション ID。 string
changedTimeUtc リソースが変更されたときの UTC タイムスタンプ。 string
resourceGroupName リソースの Azure リソース グループ。 string

WebhookPartnerDestinationInfo

名前 説明 値
endpointType パートナーの宛先のエンドポイントの種類 "WebHook" (必須)
properties パートナーの宛先の WebHook プロパティ。 WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名前 説明 値
clientAuthentication パートナー クライアント認証 PartnerClientAuthentication
endpointBaseUrl パートナーの宛先のエンドポイントを表すベース URL。 string
endpointUrl パートナーの宛先のエンドポイントを表す URL。 string

PartnerClientAuthentication

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

AzureADPartnerClientAuthentication

名前 説明 値
clientAuthenticationType クライアント認証の種類 "AzureAD" (必須)
properties AzureAD ClientAuthentication プロパティ AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名前 説明 値
azureActiveDirectoryApplicationIdOrUri 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory アプリケーション ID または URI。 string
azureActiveDirectoryTenantId 配信要求にベアラー トークンとして含まれるアクセス トークンを取得するための Azure Active Directory テナント ID。 string

PartnerTopicInfo

名前 説明 値
azureSubscriptionId サブスクライバーの Azure サブスクリプション ID。 チャネルに関連付けられているパートナー トピックは、
この Azure サブスクリプションの下に作成されます。		 string
eventTypeInfo パートナー トピックのイベントの種類情報。 この情報は発行元によって提供され、
パブリッシュされたさまざまな種類のイベントを表示するサブスクライバー。		 EventTypeInfo
name チャネルに関連付けられているパートナー トピックの名前。 string
resourceGroupName サブスクライバーの Azure リソース グループ。 チャネルに関連付けられているパートナー トピックは、
このリソース グループの下に作成されます。		 string
source ソース情報は、パブリッシャーによって提供され、イベントの基になるスコープまたはコンテキストを決定します
が発生しています。 この情報は、 の承認プロセス中にサブスクライバーが使用できます。
パートナー トピックを作成しました。
 string

EventTypeInfo

名前 説明 値
inlineEventTypes リソースのインライン イベントの種類のコレクション。 インライン イベント型キーは、イベントの名前を表す string 型です。
有効なインライン イベント名の例として、"Contoso.OrderCreated" があります。
インライン イベントの種類の値は InlineEventProperties 型であり、すべてのインライン イベントの種類に関する追加情報が含まれます。		 EventTypeInfoInlineEventTypes
kind 使用されるイベントの種類。 "インライン"

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名前 説明 値
dataSchemaUrl インライン イベントの dataSchemaUrl。 string
description インライン イベントの説明。 string
displayName インライン イベントの displayName。 string
documentationUrl インライン イベントの documentationUrl。 string