Центры и взаимодействия Microsoft.CustomerInsights

Статья
12/28/2022

Определение ресурса Bicep

Тип ресурса hubs/interactions можно развернуть в следующих объектах:

Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

resource symbolicname 'Microsoft.CustomerInsights/hubs/interactions@2017-04-26' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiEntitySetName: 'string'
    attributes: {}
    defaultDataSource: {}
    description: {}
    displayName: {}
    entityType: 'string'
    fields: [
      {
        arrayValueSeparator: 'string'
        enumValidValues: [
          {
            localizedValueNames: {}
            value: int
          }
        ]
        fieldName: 'string'
        fieldType: 'string'
        isArray: bool
        isAvailableInGraph: bool
        isEnum: bool
        isFlagEnum: bool
        isImage: bool
        isLocalizedString: bool
        isName: bool
        isRequired: bool
        maxLength: int
        propertyId: 'string'
        schemaItemPropLink: 'string'
      }
    ]
    idPropertyNames: [
      'string'
    ]
    instancesCount: int
    isActivity: bool
    largeImage: 'string'
    localizedAttributes: {}
    mediumImage: 'string'
    participantProfiles: [
      {
        description: {}
        displayName: {}
        participantName: 'string'
        participantPropertyReferences: [
          {
            sourcePropertyName: 'string'
            targetPropertyName: 'string'
          }
        ]
        profileTypeName: 'string'
        role: 'string'
      }
    ]
    primaryParticipantProfilePropertyName: 'string'
    schemaItemTypeLink: 'string'
    smallImage: 'string'
    timestampFieldName: 'string'
    typeName: 'string'
  }
}

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

hubs/interactions

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	string (обязательно) Ограничение символов: 1–128 Допустимые символы: Буквенно-цифровые символы и символы подчеркивания. Начинается с буквы.
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: hubs
properties	Определение типа взаимодействия	InteractionTypeDefinition

InteractionTypeDefinition

Имя	Описание	Значение
apiEntitySetName	Имя набора сущностей API. Он становится именем набора сущностей odata для типа сущности, на которую ссылается этот объект.	строка
attributes	Атрибуты для type.	object
defaultDataSource	Источник данных по умолчанию используется специально в случаях, когда источник данных не указан в экземпляре .	DataSource
description	Локализованные описания свойства.	object
displayName	Локализованные отображаемые имена для свойства.	object
entityType	Тип сущности.	"Взаимодействие" "Нет" "Профиль" "Связь"
fields	Свойства профиля.	PropertyDefinition[]
idPropertyNames	Имена свойств id. Свойства, которые однозначно идентифицируют экземпляр взаимодействия.	string[]
instancesCount	Число экземпляров.	INT
isActivity	Взаимодействие можно пометить как действие только во время создания. Это позволяет редактировать взаимодействие и позволяет объединять свойства из нескольких источников данных на основе приоритета, который определяется на уровне ссылок.	bool
largeImage	Большое изображение, связанное с Свойством или EntityType.	строка
localizedAttributes	Все настраиваемые локализованные атрибуты для типа.	object
mediumImage	Среднее изображение, связанное с Свойством или EntityType.	строка
participantProfiles	Профили, которые участвовали в взаимодействии.	Участник[]
primaryParticipantProfilePropertyName	Имя свойства основного участника для взаимодействия , используется для логического представления агента взаимодействия. Укажите имя участника здесь из Имени участника.	строка
schemaItemTypeLink	Ссылка на организацию схемы. Это помогает ACI определять и предлагать семантические модели.	строка
smallImage	Небольшое изображение, связанное с Свойством или EntityType.	строка
timestampFieldName	Имя свойства timestamp. Представляет время, когда произошло взаимодействие или обновление профиля.	строка
typeName	Имя сущности.	строка

DataSource

Этот объект не содержит свойств, которые необходимо задать во время развертывания. Все свойства доступны только для чтения.

PropertyDefinition

Имя	Описание	Значение
arrayValueSeparator	Разделитель значений массива для свойств с набором isArray.	строка
enumValidValues	Описывает допустимые значения для свойства перечисления.	ProfileEnumValidValuesFormat[]
fieldName	Имя свойства.	string (обязательно)
fieldType	Тип свойства.	string (обязательно)
isArray	Указывает, является ли свойство массивом объекта fieldType, указанного выше в API данных.	bool
isAvailableInGraph	Доступно ли свойство в графе или нет.	bool
isEnum	Указывает, является ли свойство перечислением.	bool
isFlagEnum	Указывает, является ли свойство перечислением флага.	bool
isImage	Указывает, является ли свойство Image.	bool
isLocalizedString	Указывает, является ли свойство локализованной строкой.	bool
isName	Является ли свойство именем или частью имени.	bool
isRequired	Указывает, является ли значение свойства обязательным для экземпляров, поле IsRequired только для взаимодействия. Экземпляр профиля не будет проверять обязательное поле.	bool
maxLength	Максимальная длина строки. Используется, только если типом является строка.	INT
propertyId	Идентификатор, связанный со свойством .	строка
schemaItemPropLink	URL-адрес, закодированный schema.org ссылку на элемент для свойства .	строка

ProfileEnumValidValuesFormat

Имя	Описание	Значение
localizedValueNames	Локализованные имена элемента перечисления.	объект
значение	Целочисленное значение члена перечисления.	INT

Участник

Имя	Описание	Значение
description	Локализованные описания.	object
displayName	Локализованное отображаемое имя.	объект
participantName	Имя участника.	string (обязательно)
participantPropertyReferences	Ссылки на свойства.	ParticipantPropertyReference[] (обязательно)
profileTypeName	Имя типа профиля.	string (обязательно)
роль	Роль, которую участник играет в взаимодействии.	строка

ParticipantPropertyReference

Имя	Описание	Значение
sourcePropertyName	Исходное свойство, сопоставляемое с целевым свойством.	string (обязательно)
targetPropertyName	Целевое свойство, сопоставляемое со свойством источника.	string (обязательно)

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

Тип ресурса hubs/interactions можно развернуть в следующих объектах:

Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

{
  "type": "Microsoft.CustomerInsights/hubs/interactions",
  "apiVersion": "2017-04-26",
  "name": "string",
  "properties": {
    "apiEntitySetName": "string",
    "attributes": {},
    "defaultDataSource": {},
    "description": {},
    "displayName": {},
    "entityType": "string",
    "fields": [
      {
        "arrayValueSeparator": "string",
        "enumValidValues": [
          {
            "localizedValueNames": {},
            "value": "int"
          }
        ],
        "fieldName": "string",
        "fieldType": "string",
        "isArray": "bool",
        "isAvailableInGraph": "bool",
        "isEnum": "bool",
        "isFlagEnum": "bool",
        "isImage": "bool",
        "isLocalizedString": "bool",
        "isName": "bool",
        "isRequired": "bool",
        "maxLength": "int",
        "propertyId": "string",
        "schemaItemPropLink": "string"
      }
    ],
    "idPropertyNames": [ "string" ],
    "instancesCount": "int",
    "isActivity": "bool",
    "largeImage": "string",
    "localizedAttributes": {},
    "mediumImage": "string",
    "participantProfiles": [
      {
        "description": {},
        "displayName": {},
        "participantName": "string",
        "participantPropertyReferences": [
          {
            "sourcePropertyName": "string",
            "targetPropertyName": "string"
          }
        ],
        "profileTypeName": "string",
        "role": "string"
      }
    ],
    "primaryParticipantProfilePropertyName": "string",
    "schemaItemTypeLink": "string",
    "smallImage": "string",
    "timestampFieldName": "string",
    "typeName": "string"
  }
}

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

hubs/interactions

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.CustomerInsights/hubs/interactions
версия_API	Версия API ресурсов	'2017-04-26'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно) Ограничение символов: 1–128 Допустимые символы: Буквенно-цифровые символы и символы подчеркивания. Начинается с буквы.
properties	Определение типа взаимодействия	InteractionTypeDefinition

InteractionTypeDefinition

Имя	Описание	Значение
apiEntitySetName	Имя набора сущностей API. Он становится именем набора сущностей odata для типа сущности, на которую ссылается этот объект.	строка
attributes	Атрибуты для type.	object
defaultDataSource	Источник данных по умолчанию используется специально в случаях, когда источник данных не указан в экземпляре .	DataSource
description	Локализованные описания свойства.	object
displayName	Локализованные отображаемые имена для свойства.	object
entityType	Тип сущности.	"Взаимодействие" "Нет" "Профиль" "Связь"
fields	Свойства профиля.	PropertyDefinition[]
idPropertyNames	Имена свойств id. Свойства, которые однозначно идентифицируют экземпляр взаимодействия.	string[]
instancesCount	Число экземпляров.	INT
isActivity	Взаимодействие можно пометить как действие только во время создания. Это позволяет редактировать взаимодействие и позволяет объединять свойства из нескольких источников данных на основе приоритета, который определяется на уровне ссылок.	bool
largeImage	Большое изображение, связанное с Свойством или EntityType.	строка
localizedAttributes	Все настраиваемые локализованные атрибуты для типа.	object
mediumImage	Среднее изображение, связанное с Свойством или EntityType.	строка
participantProfiles	Профили, которые участвовали в взаимодействии.	Участник[]
primaryParticipantProfilePropertyName	Имя свойства основного участника для взаимодействия , используется для логического представления агента взаимодействия. Укажите имя участника здесь из Имени участника.	строка
schemaItemTypeLink	Ссылка на организацию схемы. Это помогает ACI определять и предлагать семантические модели.	строка
smallImage	Небольшое изображение, связанное с Свойством или EntityType.	строка
timestampFieldName	Имя свойства timestamp. Представляет время, когда произошло взаимодействие или обновление профиля.	строка
typeName	Имя сущности.	строка

DataSource

PropertyDefinition

Имя	Описание	Значение
arrayValueSeparator	Разделитель значений массива для свойств с набором isArray.	строка
enumValidValues	Описывает допустимые значения для свойства перечисления.	ProfileEnumValidValuesFormat[]
fieldName	Имя свойства.	string (обязательно)
fieldType	Тип свойства.	string (обязательно)
isArray	Указывает, является ли свойство массивом объекта fieldType, указанного выше в API данных.	bool
isAvailableInGraph	Доступно ли свойство в графе или нет.	bool
isEnum	Указывает, является ли свойство перечислением.	bool
isFlagEnum	Указывает, является ли свойство перечислением флага.	bool
isImage	Указывает, является ли свойство Image.	bool
isLocalizedString	Указывает, является ли свойство локализованной строкой.	bool
isName	Является ли свойство именем или частью имени.	bool
isRequired	Указывает, является ли значение свойства обязательным для экземпляров, поле IsRequired только для взаимодействия. Экземпляр профиля не будет проверять обязательное поле.	bool
maxLength	Максимальная длина строки. Используется, только если типом является строка.	INT
propertyId	Идентификатор, связанный со свойством .	строка
schemaItemPropLink	URL-адрес, закодированный schema.org ссылку на элемент для свойства .	строка

ProfileEnumValidValuesFormat

Имя	Описание	Значение
localizedValueNames	Локализованные имена элемента перечисления.	object
значение	Целочисленное значение члена перечисления.	INT

Участник

Имя	Описание	Значение
description	Локализованные описания.	object
displayName	Локализованное отображаемое имя.	object
participantName	Имя участника.	string (обязательно)
participantPropertyReferences	Ссылки на свойства.	ParticipantPropertyReference[] (обязательно)
profileTypeName	Имя типа профиля.	string (обязательно)
роль	Роль, которую участник играет в взаимодействии.	строка

ParticipantPropertyReference

Имя	Описание	Значение
sourcePropertyName	Исходное свойство, сопоставляемое с целевым свойством.	string (обязательно)
targetPropertyName	Целевое свойство, сопоставляемое со свойством источника.	string (обязательно)

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

Тип ресурса hubs/interactions можно развернуть в следующих объектах:

Группы ресурсов

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

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

Чтобы создать ресурс Microsoft.CustomerInsights/hubs/interactions, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomerInsights/hubs/interactions@2017-04-26"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiEntitySetName = "string"
      attributes = {}
      defaultDataSource = {}
      description = {}
      displayName = {}
      entityType = "string"
      fields = [
        {
          arrayValueSeparator = "string"
          enumValidValues = [
            {
              localizedValueNames = {}
              value = int
            }
          ]
          fieldName = "string"
          fieldType = "string"
          isArray = bool
          isAvailableInGraph = bool
          isEnum = bool
          isFlagEnum = bool
          isImage = bool
          isLocalizedString = bool
          isName = bool
          isRequired = bool
          maxLength = int
          propertyId = "string"
          schemaItemPropLink = "string"
        }
      ]
      idPropertyNames = [
        "string"
      ]
      instancesCount = int
      isActivity = bool
      largeImage = "string"
      localizedAttributes = {}
      mediumImage = "string"
      participantProfiles = [
        {
          description = {}
          displayName = {}
          participantName = "string"
          participantPropertyReferences = [
            {
              sourcePropertyName = "string"
              targetPropertyName = "string"
            }
          ]
          profileTypeName = "string"
          role = "string"
        }
      ]
      primaryParticipantProfilePropertyName = "string"
      schemaItemTypeLink = "string"
      smallImage = "string"
      timestampFieldName = "string"
      typeName = "string"
    }
  })
}

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

hubs/interactions

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.CustomerInsights/hubs/interactions@2017-04-26"
name	имя ресурса.	строка (обязательно) Ограничение символов: 1–128 Допустимые символы: Буквенно-цифровые символы и символы подчеркивания. Начинается с буквы.
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: hubs
properties	Определение типа взаимодействия	InteractionTypeDefinition

InteractionTypeDefinition

Имя	Описание	Значение
apiEntitySetName	Имя набора сущностей API. Он становится именем набора сущностей odata для типа сущности, на которую ссылается этот объект.	строка
attributes	Атрибуты для типа.	object
defaultDataSource	Источник данных по умолчанию используется специально в случаях, когда источник данных не указан в экземпляре .	DataSource
description	Локализованные описания свойства.	object
displayName	Локализованные отображаемые имена для свойства.	object
entityType	Тип сущности.	"Взаимодействие" "None" "Профиль" "Связь"
fields	Свойства профиля.	PropertyDefinition[]
idPropertyNames	Имена свойств id. Свойства, которые однозначно идентифицируют экземпляр взаимодействия.	string[]
instancesCount	Число экземпляров.	INT
isActivity	Взаимодействие можно пометить как действие только во время создания. Это позволяет изменять взаимодействие и позволяет объединять свойства из нескольких источников данных на основе приоритета, определяемого на уровне ссылки.	bool
largeImage	Большое изображение, связанное с Свойством или EntityType.	строка
localizedAttributes	Любые настраиваемые локализованные атрибуты для типа.	объект
mediumImage	Среднее изображение, связанное с свойством или EntityType.	строка
participantProfiles	Профили, которые участвовали во взаимодействии.	Участник[]
primaryParticipantProfilePropertyName	Имя свойства основного участника для взаимодействия , которое используется для логического представления агента взаимодействия. Укажите имя участника здесь из Имени участника.	строка
schemaItemTypeLink	Ссылка на организацию схемы. Это помогает ACI определять и предлагать семантические модели.	строка
smallImage	Небольшое изображение, связанное с Свойством или EntityType.	строка
timestampFieldName	Имя свойства timestamp. Представляет время, когда произошло обновление профиля или взаимодействия.	строка
typeName	Имя сущности.	строка

DataSource

PropertyDefinition

Имя	Описание	Значение
arrayValueSeparator	Разделитель значений массива для свойств с набором isArray.	строка
enumValidValues	Описывает допустимые значения для свойства перечисления.	ProfileEnumValidValuesFormat[]
fieldName	Имя свойства.	строка (обязательно)
fieldType	Тип свойства.	строка (обязательно)
isArray	Указывает, является ли свойство массивом fieldType, приведенного выше в API данных.	bool
isAvailableInGraph	Доступно ли свойство в графе.	bool
isEnum	Указывает, является ли свойство перечислением.	bool
isFlagEnum	Указывает, является ли свойство перечислением флага.	bool
isImage	Указывает, является ли свойство Image.	bool
isLocalizedString	Указывает, является ли свойство локализованной строкой.	bool
isName	Является ли свойство именем или его частью.	bool
isRequired	Указывает, является ли значение свойства обязательным для экземпляров, поле IsRequired только для взаимодействия. Экземпляр профиля не будет проверять обязательное поле.	bool
maxLength	Максимальная длина строки. Используется, только если типом является string.	INT
propertyId	Идентификатор, связанный со свойством .	строка
schemaItemPropLink	URL-адрес, закодированный schema.org ссылку на элемент для свойства .	строка

ProfileEnumValidValuesFormat

Имя	Описание	Значение
localizedValueNames	Локализованные имена элемента перечисления.	object
значение	Целочисленное значение элемента перечисления.	INT

Участник

Имя	Описание	Значение
description	Локализованные описания.	object
displayName	Локализованное отображаемое имя.	object
participantName	Имя участника.	строка (обязательно)
participantPropertyReferences	Ссылка на свойство .	ParticipantPropertyReference[] (обязательно)
profileTypeName	Имя типа профиля.	строка (обязательно)
роль	Роль, которую участник играет во взаимодействии.	строка

ParticipantPropertyReference

Имя	Описание	Значение
sourcePropertyName	Исходное свойство, сопоставляемое с целевым свойством.	строка (обязательно)
targetPropertyName	Целевое свойство, которое сопоставляется со свойством источника.	строка (обязательно)

Центры и взаимодействия Microsoft.CustomerInsights

Определение ресурса Bicep

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

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

hubs/interactions

InteractionTypeDefinition

DataSource

PropertyDefinition

ProfileEnumValidValuesFormat

Участник

ParticipantPropertyReference

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

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

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

hubs/interactions

InteractionTypeDefinition

DataSource

PropertyDefinition

ProfileEnumValidValuesFormat

Участник

ParticipantPropertyReference

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

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

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

hubs/interactions

InteractionTypeDefinition

DataSource

PropertyDefinition

ProfileEnumValidValuesFormat

Участник

ParticipantPropertyReference

Дополнительные ресурсы

Дополнительные ресурсы