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


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 , чтобы указать тип объекта .

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

  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.
строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

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

ChannelProperties

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

PartnerDestinationInfo

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

ResourceMoveChangeHistory

Имя Описание Значение
azureSubscriptionId Идентификатор подписки Azure для ресурса. строка
changedTimeUtc Метка времени изменения ресурса в формате UTC. строка
имя_группы_ресурсов Группа ресурсов Azure для ресурса. строка

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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

PartnerClientAuthentication

Имя Описание Значение
clientAuthenticationType Установка типа объекта AzureAD (обязательно)

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Имя Описание Значение
{настраиваемое свойство} InlineEventProperties

InlineEventProperties

Имя Описание Значение
dataSchemaUrl DataSchemaUrl для встроенного события. строка
description Описание встроенного события. строка
displayName DisplayName для встроенного события. строка
documentationUrl DocumentationUrl для встроенного события. строка

Определение ресурса шаблона 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 , чтобы указать тип объекта.

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

  "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

Имя Описание Значение
тип Тип ресурса Microsoft.EventGrid/partnerNamespaces/channels
версия_API Версия API ресурсов '2023-12-15-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства канала. ChannelProperties

ChannelProperties

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

PartnerDestinationInfo

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

ResourceMoveChangeHistory

Имя Описание Значение
azureSubscriptionId Идентификатор подписки Azure ресурса. строка
changedTimeUtc Метка времени изменения ресурса в формате UTC. строка
имя_группы_ресурсов Группа ресурсов Azure ресурса. строка

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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

PartnerClientAuthentication

Имя Описание Значение
clientAuthenticationType Установка типа объекта AzureAD (обязательно)

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Имя Описание Значение
{настроенное свойство} InlineEventProperties

InlineEventProperties

Имя Описание Значение
dataSchemaUrl DataSchemaUrl для встроенного события. строка
description Описание встроенного события. строка
displayName DisplayName для встроенного события. строка
documentationUrl DocumentationUrl для встроенного события. строка

Определение ресурса 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 , чтобы указать тип объекта .

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

  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

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

ChannelProperties

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

PartnerDestinationInfo

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

ResourceMoveChangeHistory

Имя Описание Значение
azureSubscriptionId Идентификатор подписки Azure ресурса. строка
changedTimeUtc Метка времени изменения ресурса в формате UTC. строка
имя_группы_ресурсов Группа ресурсов Azure ресурса. строка

WebhookPartnerDestinationInfo

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

WebhookPartnerDestinationProperties

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

PartnerClientAuthentication

Имя Описание Значение
clientAuthenticationType Установка типа объекта AzureAD (обязательно)

AzureADPartnerClientAuthentication

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

AzureADPartnerClientAuthenticationProperties

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

PartnerTopicInfo

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

EventTypeInfo

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

EventTypeInfoInlineEventTypes

Имя Описание Значение
{настраиваемое свойство} InlineEventProperties

InlineEventProperties

Имя Описание Значение
dataSchemaUrl DataSchemaUrl для встроенного события. строка
description Описание встроенного события. строка
displayName DisplayName для встроенного события. строка
documentationUrl DocumentationUrl для встроенного события. строка