Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RelationshipResourceFormat

Package version

interface

An interface representing RelationshipResourceFormat. The relationship resource format.

extends

ProxyResource

Hierarchy

Index

Properties

Properties

Optional cardinality

cardinality: CardinalityTypes
member

{CardinalityTypes} [cardinality] The Relationship Cardinality. Possible values include: 'OneToOne', 'OneToMany', 'ManyToMany'

Optional description

description: undefined | object
member

{{ [propertyName: string]: string }} [description] Localized descriptions for the Relationship.

Optional displayName

displayName: undefined | object
member

{{ [propertyName: string]: string }} [displayName] Localized display name for the Relationship.

Optional expiryDateTimeUtc

expiryDateTimeUtc: Date
member

{Date} [expiryDateTimeUtc] The expiry date time in UTC.

Optional fields

fields: PropertyDefinition[]
member

{PropertyDefinition[]} [fields] The properties of the Relationship.

Optional id

id: undefined | string
member

{string} [id] Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lookupMappings

lookupMappings: RelationshipTypeMapping[]
member

{RelationshipTypeMapping[]} [lookupMappings] Optional property to be used to map fields in profile to their strong ids in related profile.

Optional name

name: undefined | string
member

{string} [name] Resource name. NOTE: This property will not be serialized. It can only be populated by the server.

profileType

profileType: string
member

{string} profileType Profile type.

Optional provisioningState

provisioningState: ProvisioningStates
member

{ProvisioningStates} [provisioningState] Provisioning state. Possible values include: 'Provisioning', 'Succeeded', 'Expiring', 'Deleting', 'HumanIntervention', 'Failed' NOTE: This property will not be serialized. It can only be populated by the server.

relatedProfileType

relatedProfileType: string
member

{string} relatedProfileType Related profile being referenced.

Optional relationshipGuidId

relationshipGuidId: undefined | string
member

{string} [relationshipGuidId] The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional relationshipName

relationshipName: undefined | string
member

{string} [relationshipName] The Relationship name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tenantId

tenantId: undefined | string
member

{string} [tenantId] The hub name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional type

type: undefined | string
member

{string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Generated using TypeDoc