次の方法で共有

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' = {
  parent: resourceSymbolicName
  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: 'string'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

PartnerClientAuthentication オブジェクト

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

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

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

PartnerDestinationInfo オブジェクト

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

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

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

プロパティ値

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

名前 形容 価値

InlineEventProperties

名前 形容 価値
dataSchemaUrl インライン イベントの dataSchemaUrl。 糸
形容 インライン イベントの説明。 糸
displayName インライン イベントの displayName。 糸
documentationUrl インライン イベントの documentationUrl。 糸

Microsoft.EventGrid/partnerNamespaces/channels

名前 形容 価値
名前 リソース名 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

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

PartnerClientAuthentication

名前 形容 価値
clientAuthenticationType AzureADPartnerClientAuthenticationの種類 'AzureAD' に設定します。 'AzureAD' (必須)

PartnerDestinationInfo

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

PartnerTopicInfo

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

ResourceMoveChangeHistory

名前 形容 価値
azureSubscriptionId リソースの Azure サブスクリプション ID。 糸
changedTimeUtc リソースが変更された時刻の UTC タイムスタンプ。 糸
resourceGroupName リソースの Azure リソース グループ。 糸

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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

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": "string"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

PartnerClientAuthentication オブジェクト

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

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

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

PartnerDestinationInfo オブジェクト

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

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

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

プロパティ値

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

名前 形容 価値

InlineEventProperties

名前 形容 価値
dataSchemaUrl インライン イベントの dataSchemaUrl。 糸
形容 インライン イベントの説明。 糸
displayName インライン イベントの displayName。 糸
documentationUrl インライン イベントの documentationUrl。 糸

Microsoft.EventGrid/partnerNamespaces/channels

名前 形容 価値
apiVersion API のバージョン '2023-12-15-preview'
名前 リソース名 string (必須)
プロパティ チャネルのプロパティ。 ChannelProperties の
種類 リソースの種類 'Microsoft.EventGrid/partnerNamespaces/channels'

PartnerClientAuthentication

名前 形容 価値
clientAuthenticationType AzureADPartnerClientAuthenticationの種類 'AzureAD' に設定します。 'AzureAD' (必須)

PartnerDestinationInfo

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

PartnerTopicInfo

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

ResourceMoveChangeHistory

名前 形容 価値
azureSubscriptionId リソースの Azure サブスクリプション ID。 糸
changedTimeUtc リソースが変更された時刻の UTC タイムスタンプ。 糸
resourceGroupName リソースの Azure リソース グループ。 糸

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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

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"
  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 = "string"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

PartnerClientAuthentication オブジェクト

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

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

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

PartnerDestinationInfo オブジェクト

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

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

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

プロパティ値

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

名前 形容 価値

InlineEventProperties

名前 形容 価値
dataSchemaUrl インライン イベントの dataSchemaUrl。 糸
形容 インライン イベントの説明。 糸
displayName インライン イベントの displayName。 糸
documentationUrl インライン イベントの documentationUrl。 糸

Microsoft.EventGrid/partnerNamespaces/channels

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

PartnerClientAuthentication

名前 形容 価値
clientAuthenticationType AzureADPartnerClientAuthenticationの種類 'AzureAD' に設定します。 'AzureAD' (必須)

PartnerDestinationInfo

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

PartnerTopicInfo

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

ResourceMoveChangeHistory

名前 形容 価値
azureSubscriptionId リソースの Azure サブスクリプション ID。 糸
changedTimeUtc リソースが変更された時刻の UTC タイムスタンプ。 糸
resourceGroupName リソースの Azure リソース グループ。 糸

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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