-
Notifications
You must be signed in to change notification settings - Fork 182
/
RelationshipResourceFormat.yml
231 lines (224 loc) · 7.13 KB
/
RelationshipResourceFormat.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
### YamlMime:TSType
name: RelationshipResourceFormat
uid: '@azure/arm-customerinsights.RelationshipResourceFormat'
package: '@azure/arm-customerinsights'
summary: The relationship resource format.
fullName: RelationshipResourceFormat
remarks: ''
isDeprecated: false
type: interface
properties:
- name: cardinality
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.cardinality'
package: '@azure/arm-customerinsights'
summary: The Relationship Cardinality.
fullName: cardinality
remarks: ''
isDeprecated: false
syntax:
content: 'cardinality?: CardinalityTypes'
return:
description: ''
type: <xref uid="@azure/arm-customerinsights.CardinalityTypes" />
- name: description
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.description'
package: '@azure/arm-customerinsights'
summary: Localized descriptions for the Relationship.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: displayName
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.displayName'
package: '@azure/arm-customerinsights'
summary: Localized display name for the Relationship.
fullName: displayName
remarks: ''
isDeprecated: false
syntax:
content: 'displayName?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
- name: expiryDateTimeUtc
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.expiryDateTimeUtc'
package: '@azure/arm-customerinsights'
summary: The expiry date time in UTC.
fullName: expiryDateTimeUtc
remarks: ''
isDeprecated: false
syntax:
content: 'expiryDateTimeUtc?: Date'
return:
description: ''
type: Date
- name: fields
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.fields'
package: '@azure/arm-customerinsights'
summary: The properties of the Relationship.
fullName: fields
remarks: ''
isDeprecated: false
syntax:
content: 'fields?: PropertyDefinition[]'
return:
description: ''
type: <xref uid="@azure/arm-customerinsights.PropertyDefinition" />[]
- name: lookupMappings
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.lookupMappings'
package: '@azure/arm-customerinsights'
summary: >-
Optional property to be used to map fields in profile to their strong ids
in related profile.
fullName: lookupMappings
remarks: ''
isDeprecated: false
syntax:
content: 'lookupMappings?: RelationshipTypeMapping[]'
return:
description: ''
type: <xref uid="@azure/arm-customerinsights.RelationshipTypeMapping" />[]
- name: profileType
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.profileType'
package: '@azure/arm-customerinsights'
summary: Profile type.
fullName: profileType
remarks: ''
isDeprecated: false
syntax:
content: 'profileType?: string'
return:
description: ''
type: string
- name: provisioningState
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.provisioningState'
package: '@azure/arm-customerinsights'
summary: >-
Provisioning state.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: relatedProfileType
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.relatedProfileType'
package: '@azure/arm-customerinsights'
summary: Related profile being referenced.
fullName: relatedProfileType
remarks: ''
isDeprecated: false
syntax:
content: 'relatedProfileType?: string'
return:
description: ''
type: string
- name: relationshipGuidId
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.relationshipGuidId'
package: '@azure/arm-customerinsights'
summary: >-
The relationship guid id.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: relationshipGuidId
remarks: ''
isDeprecated: false
syntax:
content: 'relationshipGuidId?: string'
return:
description: ''
type: string
- name: relationshipName
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.relationshipName'
package: '@azure/arm-customerinsights'
summary: >-
The Relationship name.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: relationshipName
remarks: ''
isDeprecated: false
syntax:
content: 'relationshipName?: string'
return:
description: ''
type: string
- name: tenantId
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.tenantId'
package: '@azure/arm-customerinsights'
summary: >-
The hub name.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: tenantId
remarks: ''
isDeprecated: false
syntax:
content: 'tenantId?: string'
return:
description: ''
type: string
inheritedProperties:
- name: id
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.id'
package: '@azure/arm-customerinsights'
summary: >-
Resource ID.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.id](xref:@azure/arm-customerinsights.ProxyResource.id)
- name: name
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.name'
package: '@azure/arm-customerinsights'
summary: >-
Resource name.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.name](xref:@azure/arm-customerinsights.ProxyResource.name)
- name: type
uid: '@azure/arm-customerinsights.RelationshipResourceFormat.type'
package: '@azure/arm-customerinsights'
summary: >-
Resource type.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[ProxyResource.type](xref:@azure/arm-customerinsights.ProxyResource.type)
extends: <xref uid="@azure/arm-customerinsights.ProxyResource" />