Поделиться через


Microsoft.EventGrid partnerNamespaces/channel 2024-12-15-preview

Определение ресурсов Bicep

Тип ресурса partnerNamespaces/channel можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/partnerNamespaces/channel, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2024-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'
  }
}

Объекты PartnerDestinationInfo

Задайте свойство endpointType, чтобы указать тип объекта.

Для веб-перехватчикаиспользуйте:

{
  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'
  }
}

Значения свойств

AzureADPartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Тип проверки подлинности клиента AzureAD (обязательно)
свойства Свойства AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Имя Описание Ценность
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна

ChannelProperties

Имя Описание Ценность
channelType Тип канала событий, который представляет поток событий направления. "PartnerDestination"
PartnerTopic
dateTimeIfNotActivatedUtc Время окончания срока действия канала. Если этот таймер истекает, пока соответствующий раздел партнера никогда не активируется,
Канал и соответствующий раздел партнера удаляются.
струна
messageForActivation Контекст или полезное сообщение, которое можно использовать во время процесса утверждения подписчиком. струна
partnerDestinationInfo Это свойство должно быть заполнено, если channelType is PartnerDestination и представляет сведения о целевом ресурсе партнера, соответствующем каналу. PartnerDestinationInfo
partnerTopicInfo Это свойство должно быть заполнено, если channelType is PartnerTopic и представляет сведения о ресурсе раздела партнера, соответствующем каналу. PartnerTopicInfo
provisioningState Состояние подготовки канала. "Отменено"
Создание
Удаление
"Не удалось"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Успешно"
"Обновление"
readinessState Состояние готовности соответствующего партнерского раздела. "Активировано"
'NeverActivated'

EventTypeInfo

Имя Описание Ценность
inlineEventTypes Коллекция встроенных типов событий для ресурса. Встроенные ключи типа событий представляют собой строку типа, представляющую имя события.
Пример допустимого встроенного события — Contoso.OrderCreated.
Встроенные значения типов событий имеют тип InlineEventProperties и будут содержать дополнительные сведения для каждого встроенного типа события.
EventTypeInfoInlineEventTypes
добрый Тип используемого типа события. "Inline"

EventTypeInfoInlineEventTypes

Имя Описание Ценность

InlineEventProperties

Имя Описание Ценность
dataSchemaUrl DataSchemaUrl для встроенного события. струна
описание Описание встроенного события. струна
displayName Отображаемое имя для встроенного события. струна
документацияUrl ДокументацияUrl для встроенного события. струна

Microsoft.EventGrid/partnerNamespaces/channel

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: partnerNamespaces
свойства Свойства канала. ChannelProperties

PartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Установите значение AzureAD для типа AzureADPartnerClientAuthentication. AzureAD (обязательно)

PartnerDestinationInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Назначение партнера, связанное с каналом, будет
создан в этой подписке Azure.
струна
endpointServiceContext Дополнительный контекст конечной точки назначения партнера. струна
endpointType Установите значение WebHook для типа WebhookPartnerDestinationInfo. WebHook (обязательный)
имя Имя назначения партнера, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Назначение партнера, связанное с каналом, будет
созданная в этой группе ресурсов.
струна
resourceMoveChangeHistory Журнал изменений перемещения ресурса. ResourceMoveChangeHistory[]

PartnerTopicInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Тема партнера, связанная с каналом, будет
создан в этой подписке Azure.
струна
eventTypeInfo Сведения о типе события для раздела партнера. Эти сведения предоставляются издателем и могут использоваться издателем.
подписчик для просмотра различных типов опубликованных событий.
EventTypeInfo
имя Имя партнерского раздела, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Тема партнера, связанная с каналом, будет
созданная в этой группе ресурсов.
струна
источник Исходные сведения предоставляются издателем для определения области или контекста, из которого события
возникают. Эти сведения можно использовать подписчиком во время процесса утверждения
создан раздел партнера.
струна

ResourceMoveChangeHistory

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure ресурса. струна
changedTimeUtc Метка времени UTC о том, когда ресурс был изменен. струна
resourceGroupName Группа ресурсов Azure ресурса. струна

WebhookPartnerDestinationInfo

Имя Описание Ценность
endpointType Тип конечной точки для назначения партнера WebHook (обязательный)
свойства Свойства веб-перехватчика назначения партнера. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Имя Описание Ценность
clientAuthentication Проверка подлинности клиента партнера partnerClientAuthentication
endpointBaseUrl Базовый URL-адрес, представляющий конечную точку назначения партнера. струна
endpointUrl URL-адрес, представляющий конечную точку назначения партнера. струна

Определение ресурса шаблона ARM

Тип ресурса partnerNamespaces/channel можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/partnerNamespaces/channel, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2024-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"
  }
}

Объекты PartnerDestinationInfo

Задайте свойство endpointType, чтобы указать тип объекта.

Для веб-перехватчикаиспользуйте:

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

Значения свойств

AzureADPartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Тип проверки подлинности клиента AzureAD (обязательно)
свойства Свойства AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Имя Описание Ценность
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна

ChannelProperties

Имя Описание Ценность
channelType Тип канала событий, который представляет поток событий направления. "PartnerDestination"
PartnerTopic
dateTimeIfNotActivatedUtc Время окончания срока действия канала. Если этот таймер истекает, пока соответствующий раздел партнера никогда не активируется,
Канал и соответствующий раздел партнера удаляются.
струна
messageForActivation Контекст или полезное сообщение, которое можно использовать во время процесса утверждения подписчиком. струна
partnerDestinationInfo Это свойство должно быть заполнено, если channelType is PartnerDestination и представляет сведения о целевом ресурсе партнера, соответствующем каналу. PartnerDestinationInfo
partnerTopicInfo Это свойство должно быть заполнено, если channelType is PartnerTopic и представляет сведения о ресурсе раздела партнера, соответствующем каналу. PartnerTopicInfo
provisioningState Состояние подготовки канала. "Отменено"
Создание
Удаление
"Не удалось"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Успешно"
"Обновление"
readinessState Состояние готовности соответствующего партнерского раздела. "Активировано"
'NeverActivated'

EventTypeInfo

Имя Описание Ценность
inlineEventTypes Коллекция встроенных типов событий для ресурса. Встроенные ключи типа событий представляют собой строку типа, представляющую имя события.
Пример допустимого встроенного события — Contoso.OrderCreated.
Встроенные значения типов событий имеют тип InlineEventProperties и будут содержать дополнительные сведения для каждого встроенного типа события.
EventTypeInfoInlineEventTypes
добрый Тип используемого типа события. "Inline"

EventTypeInfoInlineEventTypes

Имя Описание Ценность

InlineEventProperties

Имя Описание Ценность
dataSchemaUrl DataSchemaUrl для встроенного события. струна
описание Описание встроенного события. струна
displayName Отображаемое имя для встроенного события. струна
документацияUrl ДокументацияUrl для встроенного события. струна

Microsoft.EventGrid/partnerNamespaces/channel

Имя Описание Ценность
apiVersion Версия API '2024-12-15-preview'
имя Имя ресурса строка (обязательно)
свойства Свойства канала. ChannelProperties
тип Тип ресурса "Microsoft.EventGrid/partnerNamespaces/channel"

PartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Установите значение AzureAD для типа AzureADPartnerClientAuthentication. AzureAD (обязательно)

PartnerDestinationInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Назначение партнера, связанное с каналом, будет
создан в этой подписке Azure.
струна
endpointServiceContext Дополнительный контекст конечной точки назначения партнера. струна
endpointType Установите значение WebHook для типа WebhookPartnerDestinationInfo. WebHook (обязательный)
имя Имя назначения партнера, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Назначение партнера, связанное с каналом, будет
созданная в этой группе ресурсов.
струна
resourceMoveChangeHistory Журнал изменений перемещения ресурса. ResourceMoveChangeHistory[]

PartnerTopicInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Тема партнера, связанная с каналом, будет
создан в этой подписке Azure.
струна
eventTypeInfo Сведения о типе события для раздела партнера. Эти сведения предоставляются издателем и могут использоваться издателем.
подписчик для просмотра различных типов опубликованных событий.
EventTypeInfo
имя Имя партнерского раздела, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Тема партнера, связанная с каналом, будет
созданная в этой группе ресурсов.
струна
источник Исходные сведения предоставляются издателем для определения области или контекста, из которого события
возникают. Эти сведения можно использовать подписчиком во время процесса утверждения
создан раздел партнера.
струна

ResourceMoveChangeHistory

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure ресурса. струна
changedTimeUtc Метка времени UTC о том, когда ресурс был изменен. струна
resourceGroupName Группа ресурсов Azure ресурса. струна

WebhookPartnerDestinationInfo

Имя Описание Ценность
endpointType Тип конечной точки для назначения партнера WebHook (обязательный)
свойства Свойства веб-перехватчика назначения партнера. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Имя Описание Ценность
clientAuthentication Проверка подлинности клиента партнера partnerClientAuthentication
endpointBaseUrl Базовый URL-адрес, представляющий конечную точку назначения партнера. струна
endpointUrl URL-адрес, представляющий конечную точку назначения партнера. струна

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса partnerNamespaces/channel можно развернуть с помощью операций, предназначенных для следующих целей:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/partnerNamespaces/channel, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2024-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"
    }
  })
}

Объекты PartnerDestinationInfo

Задайте свойство endpointType, чтобы указать тип объекта.

Для веб-перехватчикаиспользуйте:

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

Значения свойств

AzureADPartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Тип проверки подлинности клиента AzureAD (обязательно)
свойства Свойства AzureAD ClientAuthentication AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

Имя Описание Ценность
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. струна

ChannelProperties

Имя Описание Ценность
channelType Тип канала событий, который представляет поток событий направления. "PartnerDestination"
PartnerTopic
dateTimeIfNotActivatedUtc Время окончания срока действия канала. Если этот таймер истекает, пока соответствующий раздел партнера никогда не активируется,
Канал и соответствующий раздел партнера удаляются.
струна
messageForActivation Контекст или полезное сообщение, которое можно использовать во время процесса утверждения подписчиком. струна
partnerDestinationInfo Это свойство должно быть заполнено, если channelType is PartnerDestination и представляет сведения о целевом ресурсе партнера, соответствующем каналу. PartnerDestinationInfo
partnerTopicInfo Это свойство должно быть заполнено, если channelType is PartnerTopic и представляет сведения о ресурсе раздела партнера, соответствующем каналу. PartnerTopicInfo
provisioningState Состояние подготовки канала. "Отменено"
Создание
Удаление
"Не удалось"
"IdleDueToMirroredPartnerDestinationDeletion"
"IdleDueToMirroredPartnerTopicDeletion"
"Успешно"
"Обновление"
readinessState Состояние готовности соответствующего партнерского раздела. "Активировано"
'NeverActivated'

EventTypeInfo

Имя Описание Ценность
inlineEventTypes Коллекция встроенных типов событий для ресурса. Встроенные ключи типа событий представляют собой строку типа, представляющую имя события.
Пример допустимого встроенного события — Contoso.OrderCreated.
Встроенные значения типов событий имеют тип InlineEventProperties и будут содержать дополнительные сведения для каждого встроенного типа события.
EventTypeInfoInlineEventTypes
добрый Тип используемого типа события. "Inline"

EventTypeInfoInlineEventTypes

Имя Описание Ценность

InlineEventProperties

Имя Описание Ценность
dataSchemaUrl DataSchemaUrl для встроенного события. струна
описание Описание встроенного события. струна
displayName Отображаемое имя для встроенного события. струна
документацияUrl ДокументацияUrl для встроенного события. струна

Microsoft.EventGrid/partnerNamespaces/channel

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: partnerNamespaces
свойства Свойства канала. ChannelProperties
тип Тип ресурса "Microsoft.EventGrid/partnerNamespaces/channels@2024-12-15-preview"

PartnerClientAuthentication

Имя Описание Ценность
clientAuthenticationType Установите значение AzureAD для типа AzureADPartnerClientAuthentication. AzureAD (обязательно)

PartnerDestinationInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Назначение партнера, связанное с каналом, будет
создан в этой подписке Azure.
струна
endpointServiceContext Дополнительный контекст конечной точки назначения партнера. струна
endpointType Установите значение WebHook для типа WebhookPartnerDestinationInfo. WebHook (обязательный)
имя Имя назначения партнера, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Назначение партнера, связанное с каналом, будет
созданная в этой группе ресурсов.
струна
resourceMoveChangeHistory Журнал изменений перемещения ресурса. ResourceMoveChangeHistory[]

PartnerTopicInfo

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure подписчика. Тема партнера, связанная с каналом, будет
создан в этой подписке Azure.
струна
eventTypeInfo Сведения о типе события для раздела партнера. Эти сведения предоставляются издателем и могут использоваться издателем.
подписчик для просмотра различных типов опубликованных событий.
EventTypeInfo
имя Имя партнерского раздела, связанного с каналом. струна
resourceGroupName Группа ресурсов Azure подписчика. Тема партнера, связанная с каналом, будет
созданная в этой группе ресурсов.
струна
источник Исходные сведения предоставляются издателем для определения области или контекста, из которого события
возникают. Эти сведения можно использовать подписчиком во время процесса утверждения
создан раздел партнера.
струна

ResourceMoveChangeHistory

Имя Описание Ценность
azureSubscriptionId Идентификатор подписки Azure ресурса. струна
changedTimeUtc Метка времени UTC о том, когда ресурс был изменен. струна
resourceGroupName Группа ресурсов Azure ресурса. струна

WebhookPartnerDestinationInfo

Имя Описание Ценность
endpointType Тип конечной точки для назначения партнера WebHook (обязательный)
свойства Свойства веб-перехватчика назначения партнера. WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

Имя Описание Ценность
clientAuthentication Проверка подлинности клиента партнера partnerClientAuthentication
endpointBaseUrl Базовый URL-адрес, представляющий конечную точку назначения партнера. струна
endpointUrl URL-адрес, представляющий конечную точку назначения партнера. струна