Microsoft.CustomerInsights hubs/relationshipLinks 2017-01-01
Bicep resource definition
The hubs/relationshipLinks resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/relationshipLinks resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.CustomerInsights/hubs/relationshipLinks@2017-01-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: {}
displayName: {}
interactionType: 'string'
mappings: [
{
interactionFieldName: 'string'
linkType: 'string'
relationshipFieldName: 'string'
}
]
profilePropertyReferences: [
{
interactionPropertyName: 'string'
profilePropertyName: 'string'
}
]
relatedProfilePropertyReferences: [
{
interactionPropertyName: 'string'
profilePropertyName: 'string'
}
]
relationshipName: 'string'
}
}
Property values
hubs/relationshipLinks
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) Character limit: 1-512 Valid characters: Alphanumerics and underscores. Start with letter. |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: hubs |
| properties | The definition of relationship link. | RelationshipLinkDefinition |
RelationshipLinkDefinition
| Name | Description | Value |
|---|---|---|
| description | Localized descriptions for the Relationship Link. | object |
| displayName | Localized display name for the Relationship Link. | object |
| interactionType | The InteractionType associated with the Relationship Link. | string (required) |
| mappings | The mappings between Interaction and Relationship fields. | RelationshipLinkFieldMapping[] |
| profilePropertyReferences | The property references for the Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relatedProfilePropertyReferences | The property references for the Related Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relationshipName | The Relationship associated with the Link. | string (required) |
RelationshipLinkFieldMapping
| Name | Description | Value |
|---|---|---|
| interactionFieldName | The field name on the Interaction Type. | string (required) |
| linkType | Link type. | 'CopyIfNull' 'UpdateAlways' |
| relationshipFieldName | The field name on the Relationship metadata. | string (required) |
ParticipantPropertyReference
| Name | Description | Value |
|---|---|---|
| interactionPropertyName | The interaction property that maps to the profile property. | string (required) |
| profilePropertyName | The profile property that maps to the interaction property. | string (required) |
ARM template resource definition
The hubs/relationshipLinks resource type can be deployed to:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/relationshipLinks resource, add the following JSON to your template.
{
"type": "Microsoft.CustomerInsights/hubs/relationshipLinks",
"apiVersion": "2017-01-01",
"name": "string",
"properties": {
"description": {},
"displayName": {},
"interactionType": "string",
"mappings": [
{
"interactionFieldName": "string",
"linkType": "string",
"relationshipFieldName": "string"
}
],
"profilePropertyReferences": [
{
"interactionPropertyName": "string",
"profilePropertyName": "string"
}
],
"relatedProfilePropertyReferences": [
{
"interactionPropertyName": "string",
"profilePropertyName": "string"
}
],
"relationshipName": "string"
}
}
Property values
hubs/relationshipLinks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.CustomerInsights/hubs/relationshipLinks' |
| apiVersion | The resource api version | '2017-01-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-512 Valid characters: Alphanumerics and underscores. Start with letter. |
| properties | The definition of relationship link. | RelationshipLinkDefinition |
RelationshipLinkDefinition
| Name | Description | Value |
|---|---|---|
| description | Localized descriptions for the Relationship Link. | object |
| displayName | Localized display name for the Relationship Link. | object |
| interactionType | The InteractionType associated with the Relationship Link. | string (required) |
| mappings | The mappings between Interaction and Relationship fields. | RelationshipLinkFieldMapping[] |
| profilePropertyReferences | The property references for the Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relatedProfilePropertyReferences | The property references for the Related Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relationshipName | The Relationship associated with the Link. | string (required) |
RelationshipLinkFieldMapping
| Name | Description | Value |
|---|---|---|
| interactionFieldName | The field name on the Interaction Type. | string (required) |
| linkType | Link type. | 'CopyIfNull' 'UpdateAlways' |
| relationshipFieldName | The field name on the Relationship metadata. | string (required) |
ParticipantPropertyReference
| Name | Description | Value |
|---|---|---|
| interactionPropertyName | The interaction property that maps to the profile property. | string (required) |
| profilePropertyName | The profile property that maps to the interaction property. | string (required) |
Terraform (AzAPI provider) resource definition
The hubs/relationshipLinks resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.CustomerInsights/hubs/relationshipLinks resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.CustomerInsights/hubs/relationshipLinks@2017-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = {}
displayName = {}
interactionType = "string"
mappings = [
{
interactionFieldName = "string"
linkType = "string"
relationshipFieldName = "string"
}
]
profilePropertyReferences = [
{
interactionPropertyName = "string"
profilePropertyName = "string"
}
]
relatedProfilePropertyReferences = [
{
interactionPropertyName = "string"
profilePropertyName = "string"
}
]
relationshipName = "string"
}
})
}
Property values
hubs/relationshipLinks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.CustomerInsights/hubs/relationshipLinks@2017-01-01" |
| name | The resource name | string (required) Character limit: 1-512 Valid characters: Alphanumerics and underscores. Start with letter. |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hubs |
| properties | The definition of relationship link. | RelationshipLinkDefinition |
RelationshipLinkDefinition
| Name | Description | Value |
|---|---|---|
| description | Localized descriptions for the Relationship Link. | object |
| displayName | Localized display name for the Relationship Link. | object |
| interactionType | The InteractionType associated with the Relationship Link. | string (required) |
| mappings | The mappings between Interaction and Relationship fields. | RelationshipLinkFieldMapping[] |
| profilePropertyReferences | The property references for the Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relatedProfilePropertyReferences | The property references for the Related Profile of the Relationship. | ParticipantPropertyReference[] (required) |
| relationshipName | The Relationship associated with the Link. | string (required) |
RelationshipLinkFieldMapping
| Name | Description | Value |
|---|---|---|
| interactionFieldName | The field name on the Interaction Type. | string (required) |
| linkType | Link type. | "CopyIfNull" "UpdateAlways" |
| relationshipFieldName | The field name on the Relationship metadata. | string (required) |
ParticipantPropertyReference
| Name | Description | Value |
|---|---|---|
| interactionPropertyName | The interaction property that maps to the profile property. | string (required) |
| profilePropertyName | The profile property that maps to the interaction property. | string (required) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for