azure-native.customerinsights.RelationshipLink
Explore with Pulumi AI
The relationship link resource format.
Uses Azure REST API version 2017-04-26. In version 2.x of the Azure Native provider, it used API version 2017-04-26.
Create RelationshipLink Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RelationshipLink(name: string, args: RelationshipLinkArgs, opts?: CustomResourceOptions);
@overload
def RelationshipLink(resource_name: str,
args: RelationshipLinkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RelationshipLink(resource_name: str,
opts: Optional[ResourceOptions] = None,
hub_name: Optional[str] = None,
interaction_type: Optional[str] = None,
profile_property_references: Optional[Sequence[ParticipantProfilePropertyReferenceArgs]] = None,
related_profile_property_references: Optional[Sequence[ParticipantProfilePropertyReferenceArgs]] = None,
relationship_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
description: Optional[Mapping[str, str]] = None,
display_name: Optional[Mapping[str, str]] = None,
mappings: Optional[Sequence[RelationshipLinkFieldMappingArgs]] = None,
relationship_link_name: Optional[str] = None)
func NewRelationshipLink(ctx *Context, name string, args RelationshipLinkArgs, opts ...ResourceOption) (*RelationshipLink, error)
public RelationshipLink(string name, RelationshipLinkArgs args, CustomResourceOptions? opts = null)
public RelationshipLink(String name, RelationshipLinkArgs args)
public RelationshipLink(String name, RelationshipLinkArgs args, CustomResourceOptions options)
type: azure-native:customerinsights:RelationshipLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RelationshipLinkArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. RelationshipLinkArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RelationshipLinkArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. RelationshipLinkArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. RelationshipLinkArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var relationshipLinkResource = new AzureNative.CustomerInsights.RelationshipLink("relationshipLinkResource", new()
{
HubName = "string",
InteractionType = "string",
ProfilePropertyReferences = new[]
{
new AzureNative.CustomerInsights.Inputs.ParticipantProfilePropertyReferenceArgs
{
InteractionPropertyName = "string",
ProfilePropertyName = "string",
},
},
RelatedProfilePropertyReferences = new[]
{
new AzureNative.CustomerInsights.Inputs.ParticipantProfilePropertyReferenceArgs
{
InteractionPropertyName = "string",
ProfilePropertyName = "string",
},
},
RelationshipName = "string",
ResourceGroupName = "string",
Description =
{
{ "string", "string" },
},
DisplayName =
{
{ "string", "string" },
},
Mappings = new[]
{
new AzureNative.CustomerInsights.Inputs.RelationshipLinkFieldMappingArgs
{
InteractionFieldName = "string",
RelationshipFieldName = "string",
LinkType = AzureNative.CustomerInsights.LinkTypes.UpdateAlways,
},
},
RelationshipLinkName = "string",
});
example, err := customerinsights.NewRelationshipLink(ctx, "relationshipLinkResource", &customerinsights.RelationshipLinkArgs{
HubName: pulumi.String("string"),
InteractionType: pulumi.String("string"),
ProfilePropertyReferences: customerinsights.ParticipantProfilePropertyReferenceArray{
&customerinsights.ParticipantProfilePropertyReferenceArgs{
InteractionPropertyName: pulumi.String("string"),
ProfilePropertyName: pulumi.String("string"),
},
},
RelatedProfilePropertyReferences: customerinsights.ParticipantProfilePropertyReferenceArray{
&customerinsights.ParticipantProfilePropertyReferenceArgs{
InteractionPropertyName: pulumi.String("string"),
ProfilePropertyName: pulumi.String("string"),
},
},
RelationshipName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Description: pulumi.StringMap{
"string": pulumi.String("string"),
},
DisplayName: pulumi.StringMap{
"string": pulumi.String("string"),
},
Mappings: customerinsights.RelationshipLinkFieldMappingArray{
&customerinsights.RelationshipLinkFieldMappingArgs{
InteractionFieldName: pulumi.String("string"),
RelationshipFieldName: pulumi.String("string"),
LinkType: customerinsights.LinkTypesUpdateAlways,
},
},
RelationshipLinkName: pulumi.String("string"),
})
var relationshipLinkResource = new RelationshipLink("relationshipLinkResource", RelationshipLinkArgs.builder()
.hubName("string")
.interactionType("string")
.profilePropertyReferences(ParticipantProfilePropertyReferenceArgs.builder()
.interactionPropertyName("string")
.profilePropertyName("string")
.build())
.relatedProfilePropertyReferences(ParticipantProfilePropertyReferenceArgs.builder()
.interactionPropertyName("string")
.profilePropertyName("string")
.build())
.relationshipName("string")
.resourceGroupName("string")
.description(Map.of("string", "string"))
.displayName(Map.of("string", "string"))
.mappings(RelationshipLinkFieldMappingArgs.builder()
.interactionFieldName("string")
.relationshipFieldName("string")
.linkType("UpdateAlways")
.build())
.relationshipLinkName("string")
.build());
relationship_link_resource = azure_native.customerinsights.RelationshipLink("relationshipLinkResource",
hub_name="string",
interaction_type="string",
profile_property_references=[{
"interaction_property_name": "string",
"profile_property_name": "string",
}],
related_profile_property_references=[{
"interaction_property_name": "string",
"profile_property_name": "string",
}],
relationship_name="string",
resource_group_name="string",
description={
"string": "string",
},
display_name={
"string": "string",
},
mappings=[{
"interaction_field_name": "string",
"relationship_field_name": "string",
"link_type": azure_native.customerinsights.LinkTypes.UPDATE_ALWAYS,
}],
relationship_link_name="string")
const relationshipLinkResource = new azure_native.customerinsights.RelationshipLink("relationshipLinkResource", {
hubName: "string",
interactionType: "string",
profilePropertyReferences: [{
interactionPropertyName: "string",
profilePropertyName: "string",
}],
relatedProfilePropertyReferences: [{
interactionPropertyName: "string",
profilePropertyName: "string",
}],
relationshipName: "string",
resourceGroupName: "string",
description: {
string: "string",
},
displayName: {
string: "string",
},
mappings: [{
interactionFieldName: "string",
relationshipFieldName: "string",
linkType: azure_native.customerinsights.LinkTypes.UpdateAlways,
}],
relationshipLinkName: "string",
});
type: azure-native:customerinsights:RelationshipLink
properties:
description:
string: string
displayName:
string: string
hubName: string
interactionType: string
mappings:
- interactionFieldName: string
linkType: UpdateAlways
relationshipFieldName: string
profilePropertyReferences:
- interactionPropertyName: string
profilePropertyName: string
relatedProfilePropertyReferences:
- interactionPropertyName: string
profilePropertyName: string
relationshipLinkName: string
relationshipName: string
resourceGroupName: string
RelationshipLink Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RelationshipLink resource accepts the following input properties:
- Hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- Interaction
Type This property is required. string - The InteractionType associated with the Relationship Link.
- Profile
Property References This property is required. List<Pulumi.Azure Native. Customer Insights. Inputs. Participant Profile Property Reference> - The property references for the Profile of the Relationship.
This property is required. List<Pulumi.Azure Native. Customer Insights. Inputs. Participant Profile Property Reference> - The property references for the Related Profile of the Relationship.
- Relationship
Name This property is required. string - The Relationship associated with the Link.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Description Dictionary<string, string>
- Localized descriptions for the Relationship Link.
- Display
Name Dictionary<string, string> - Localized display name for the Relationship Link.
- Mappings
List<Pulumi.
Azure Native. Customer Insights. Inputs. Relationship Link Field Mapping> - The mappings between Interaction and Relationship fields.
- Relationship
Link Name Changes to this property will trigger replacement.
- The name of the relationship link.
- Hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- Interaction
Type This property is required. string - The InteractionType associated with the Relationship Link.
- Profile
Property References This property is required. []ParticipantProfile Property Reference Args - The property references for the Profile of the Relationship.
This property is required. []ParticipantProfile Property Reference Args - The property references for the Related Profile of the Relationship.
- Relationship
Name This property is required. string - The Relationship associated with the Link.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Description map[string]string
- Localized descriptions for the Relationship Link.
- Display
Name map[string]string - Localized display name for the Relationship Link.
- Mappings
[]Relationship
Link Field Mapping Args - The mappings between Interaction and Relationship fields.
- Relationship
Link Name Changes to this property will trigger replacement.
- The name of the relationship link.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- interaction
Type This property is required. String - The InteractionType associated with the Relationship Link.
- profile
Property References This property is required. List<ParticipantProfile Property Reference> - The property references for the Profile of the Relationship.
This property is required. List<ParticipantProfile Property Reference> - The property references for the Related Profile of the Relationship.
- relationship
Name This property is required. String - The Relationship associated with the Link.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- description Map<String,String>
- Localized descriptions for the Relationship Link.
- display
Name Map<String,String> - Localized display name for the Relationship Link.
- mappings
List<Relationship
Link Field Mapping> - The mappings between Interaction and Relationship fields.
- relationship
Link Name Changes to this property will trigger replacement.
- The name of the relationship link.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- interaction
Type This property is required. string - The InteractionType associated with the Relationship Link.
- profile
Property References This property is required. ParticipantProfile Property Reference[] - The property references for the Profile of the Relationship.
This property is required. ParticipantProfile Property Reference[] - The property references for the Related Profile of the Relationship.
- relationship
Name This property is required. string - The Relationship associated with the Link.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- description {[key: string]: string}
- Localized descriptions for the Relationship Link.
- display
Name {[key: string]: string} - Localized display name for the Relationship Link.
- mappings
Relationship
Link Field Mapping[] - The mappings between Interaction and Relationship fields.
- relationship
Link Name Changes to this property will trigger replacement.
- The name of the relationship link.
- hub_
name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- interaction_
type This property is required. str - The InteractionType associated with the Relationship Link.
- profile_
property_ references This property is required. Sequence[ParticipantProfile Property Reference Args] - The property references for the Profile of the Relationship.
This property is required. Sequence[ParticipantProfile Property Reference Args] - The property references for the Related Profile of the Relationship.
- relationship_
name This property is required. str - The Relationship associated with the Link.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- description Mapping[str, str]
- Localized descriptions for the Relationship Link.
- display_
name Mapping[str, str] - Localized display name for the Relationship Link.
- mappings
Sequence[Relationship
Link Field Mapping Args] - The mappings between Interaction and Relationship fields.
- relationship_
link_ name Changes to this property will trigger replacement.
- The name of the relationship link.
- hub
Name This property is required. Changes to this property will trigger replacement.
- The name of the hub.
- interaction
Type This property is required. String - The InteractionType associated with the Relationship Link.
- profile
Property References This property is required. List<Property Map> - The property references for the Profile of the Relationship.
This property is required. List<Property Map>- The property references for the Related Profile of the Relationship.
- relationship
Name This property is required. String - The Relationship associated with the Link.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- description Map<String>
- Localized descriptions for the Relationship Link.
- display
Name Map<String> - Localized display name for the Relationship Link.
- mappings List<Property Map>
- The mappings between Interaction and Relationship fields.
- relationship
Link Name Changes to this property will trigger replacement.
- The name of the relationship link.
Outputs
All input properties are implicitly available as output properties. Additionally, the RelationshipLink resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Link
Name string - The name of the Relationship Link.
- Name string
- Resource name.
- Provisioning
State string - Provisioning state.
- Relationship
Guid stringId - The relationship guid id.
- Tenant
Id string - The hub name.
- Type string
- Resource type.
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Link
Name string - The name of the Relationship Link.
- Name string
- Resource name.
- Provisioning
State string - Provisioning state.
- Relationship
Guid stringId - The relationship guid id.
- Tenant
Id string - The hub name.
- Type string
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- link
Name String - The name of the Relationship Link.
- name String
- Resource name.
- provisioning
State String - Provisioning state.
- relationship
Guid StringId - The relationship guid id.
- tenant
Id String - The hub name.
- type String
- Resource type.
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- link
Name string - The name of the Relationship Link.
- name string
- Resource name.
- provisioning
State string - Provisioning state.
- relationship
Guid stringId - The relationship guid id.
- tenant
Id string - The hub name.
- type string
- Resource type.
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- link_
name str - The name of the Relationship Link.
- name str
- Resource name.
- provisioning_
state str - Provisioning state.
- relationship_
guid_ strid - The relationship guid id.
- tenant_
id str - The hub name.
- type str
- Resource type.
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- link
Name String - The name of the Relationship Link.
- name String
- Resource name.
- provisioning
State String - Provisioning state.
- relationship
Guid StringId - The relationship guid id.
- tenant
Id String - The hub name.
- type String
- Resource type.
Supporting Types
LinkTypes, LinkTypesArgs
- Update
Always - UpdateAlways
- Copy
If Null - CopyIfNull
- Link
Types Update Always - UpdateAlways
- Link
Types Copy If Null - CopyIfNull
- Update
Always - UpdateAlways
- Copy
If Null - CopyIfNull
- Update
Always - UpdateAlways
- Copy
If Null - CopyIfNull
- UPDATE_ALWAYS
- UpdateAlways
- COPY_IF_NULL
- CopyIfNull
- "Update
Always" - UpdateAlways
- "Copy
If Null" - CopyIfNull
ParticipantProfilePropertyReference, ParticipantProfilePropertyReferenceArgs
- Interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- Profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- Interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- Profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. String - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. String - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- interaction_
property_ name This property is required. str - The source interaction property that maps to the target profile property.
- profile_
property_ name This property is required. str - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. String - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. String - The target profile property that maps to the source interaction property.
ParticipantProfilePropertyReferenceResponse, ParticipantProfilePropertyReferenceResponseArgs
- Interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- Profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- Interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- Profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. String - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. String - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. string - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. string - The target profile property that maps to the source interaction property.
- interaction_
property_ name This property is required. str - The source interaction property that maps to the target profile property.
- profile_
property_ name This property is required. str - The target profile property that maps to the source interaction property.
- interaction
Property Name This property is required. String - The source interaction property that maps to the target profile property.
- profile
Property Name This property is required. String - The target profile property that maps to the source interaction property.
RelationshipLinkFieldMapping, RelationshipLinkFieldMappingArgs
- Interaction
Field Name This property is required. string - The field name on the Interaction Type.
- Relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- Link
Type Pulumi.Azure Native. Customer Insights. Link Types - Link type.
- Interaction
Field Name This property is required. string - The field name on the Interaction Type.
- Relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- Link
Type LinkTypes - Link type.
- interaction
Field Name This property is required. String - The field name on the Interaction Type.
- relationship
Field Name This property is required. String - The field name on the Relationship metadata.
- link
Type LinkTypes - Link type.
- interaction
Field Name This property is required. string - The field name on the Interaction Type.
- relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- link
Type LinkTypes - Link type.
- interaction_
field_ name This property is required. str - The field name on the Interaction Type.
- relationship_
field_ name This property is required. str - The field name on the Relationship metadata.
- link_
type LinkTypes - Link type.
- interaction
Field Name This property is required. String - The field name on the Interaction Type.
- relationship
Field Name This property is required. String - The field name on the Relationship metadata.
- link
Type "UpdateAlways" | "Copy If Null" - Link type.
RelationshipLinkFieldMappingResponse, RelationshipLinkFieldMappingResponseArgs
- Interaction
Field Name This property is required. string - The field name on the Interaction Type.
- Relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- Link
Type string - Link type.
- Interaction
Field Name This property is required. string - The field name on the Interaction Type.
- Relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- Link
Type string - Link type.
- interaction
Field Name This property is required. String - The field name on the Interaction Type.
- relationship
Field Name This property is required. String - The field name on the Relationship metadata.
- link
Type String - Link type.
- interaction
Field Name This property is required. string - The field name on the Interaction Type.
- relationship
Field Name This property is required. string - The field name on the Relationship metadata.
- link
Type string - Link type.
- interaction_
field_ name This property is required. str - The field name on the Interaction Type.
- relationship_
field_ name This property is required. str - The field name on the Relationship metadata.
- link_
type str - Link type.
- interaction
Field Name This property is required. String - The field name on the Interaction Type.
- relationship
Field Name This property is required. String - The field name on the Relationship metadata.
- link
Type String - Link type.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:customerinsights:RelationshipLink sdkTestHub/Somelink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationshipLinks/{relationshipLinkName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0