Share via

ProfileResourceFormat interface

Package:
@azure/arm-customerinsights

The profile resource format.

Extends
ProxyResource

Properties

apiEntitySetName

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
attributes

The attributes for the Type.
description

Localized descriptions for the property.
displayName

Localized display names for the property.
entityType

Type of entity.
fields

The properties of the Profile.
instancesCount

The instance count.
largeImage

Large Image associated with the Property or EntityType.
lastChangedUtc

The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.
localizedAttributes

Any custom localized attributes for the Type.
mediumImage

Medium Image associated with the Property or EntityType.
provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
schemaItemTypeLink

The schema org link. This helps ACI identify and suggest semantic models.
smallImage

Small Image associated with the Property or EntityType.
strongIds

The strong IDs.
tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.
typeName

The name of the entity.

Inherited Properties

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

apiEntitySetName

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

apiEntitySetName?: string

Property Value

string

attributes

The attributes for the Type.

attributes?: {[propertyName: string]: string[]}

Property Value

{[propertyName: string]: string[]}

description

Localized descriptions for the property.

description?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

displayName

Localized display names for the property.

displayName?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

entityType

Type of entity.

entityType?: EntityTypes

Property Value

EntityTypes

fields

The properties of the Profile.

fields?: PropertyDefinition[]

Property Value

PropertyDefinition[]

instancesCount

The instance count.

instancesCount?: number

Property Value

number

largeImage

Large Image associated with the Property or EntityType.

largeImage?: string

Property Value

string

lastChangedUtc

The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.

lastChangedUtc?: Date

Property Value

Date

localizedAttributes

Any custom localized attributes for the Type.

localizedAttributes?: {[propertyName: string]: {[propertyName: string]: string}}

Property Value

{[propertyName: string]: {[propertyName: string]: string}}

mediumImage

Medium Image associated with the Property or EntityType.

mediumImage?: string

Property Value

string

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

The schema org link. This helps ACI identify and suggest semantic models.

schemaItemTypeLink?: string

Property Value

string

smallImage

Small Image associated with the Property or EntityType.

smallImage?: string

Property Value

string

strongIds

The strong IDs.

strongIds?: StrongId[]

Property Value

StrongId[]

tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

tenantId?: string

Property Value

string

timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.

timestampFieldName?: string

Property Value

string

typeName

The name of the entity.

typeName?: string

Property Value

string

Inherited Property Details

id

Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type