RelationshipResourceFormat interface

Package:

@azure/arm-customerinsights

The relationship resource format.

Extends

ProxyResource

Properties

cardinality	The Relationship Cardinality.
description	Localized descriptions for the Relationship.
displayName	Localized display name for the Relationship.
expiryDateTimeUtc	The expiry date time in UTC.
fields	The properties of the Relationship.
lookupMappings	Optional property to be used to map fields in profile to their strong ids in related profile.
profileType	Profile type.
provisioningState	Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
relatedProfileType	Related profile being referenced.
relationshipGuidId	The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.
relationshipName	The Relationship name. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId	The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

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

cardinality

The Relationship Cardinality.

cardinality?: CardinalityTypes

Property Value

CardinalityTypes

description

Localized descriptions for the Relationship.

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

Property Value

{[propertyName: string]: string}

displayName

Localized display name for the Relationship.

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

Property Value

{[propertyName: string]: string}

expiryDateTimeUtc

The expiry date time in UTC.

expiryDateTimeUtc?: Date

Property Value

Date

fields

The properties of the Relationship.

fields?: PropertyDefinition[]

Property Value

PropertyDefinition[]

lookupMappings

Optional property to be used to map fields in profile to their strong ids in related profile.

lookupMappings?: RelationshipTypeMapping[]

Property Value

RelationshipTypeMapping[]

profileType

Profile type.

profileType?: 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

relatedProfileType

Related profile being referenced.

relatedProfileType?: string

Property Value

string

relationshipGuidId

The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.

relationshipGuidId?: string

Property Value

string

relationshipName

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

relationshipName?: string

Property Value

string

tenantId

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

tenantId?: 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