LinkResourceFormat interface

The link resource format.

Extends

Properties

description

Localized descriptions for the Link.

displayName

Localized display name for the Link.

linkName

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

mappings

The set of properties mappings between the source and target Types.

operationType

Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.

participantPropertyReferences

The properties that represent the participating profile.

provisioningState

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

referenceOnly

Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.

sourceEntityType

Type of source entity.

sourceEntityTypeName

Name of the source Entity Type.

targetEntityType

Type of target entity.

targetEntityTypeName

Name of the target Entity Type.

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

description

Localized descriptions for the Link.

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

Property Value

{[propertyName: string]: string}

displayName

Localized display name for the Link.

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

Property Value

{[propertyName: string]: string}

linkName

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

linkName?: string

Property Value

string

mappings

The set of properties mappings between the source and target Types.

mappings?: TypePropertiesMapping[]

Property Value

operationType

Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.

operationType?: InstanceOperationType

Property Value

participantPropertyReferences

The properties that represent the participating profile.

participantPropertyReferences?: ParticipantPropertyReference[]

Property Value

provisioningState

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

provisioningState?: string

Property Value

string

referenceOnly

Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.

referenceOnly?: boolean

Property Value

boolean

sourceEntityType

Type of source entity.

sourceEntityType?: EntityType

Property Value

sourceEntityTypeName

Name of the source Entity Type.

sourceEntityTypeName?: string

Property Value

string

targetEntityType

Type of target entity.

targetEntityType?: EntityType

Property Value

targetEntityTypeName

Name of the target Entity Type.

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