Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. Relationship
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.customerinsights.Relationship

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

The relationship 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.

Example Usage

Relationships_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var relationship = new AzureNative.CustomerInsights.Relationship("relationship", new()
    {
        Cardinality = AzureNative.CustomerInsights.CardinalityTypes.OneToOne,
        Description = 
        {
            { "en-us", "Relationship Description" },
        },
        DisplayName = 
        {
            { "en-us", "Relationship DisplayName" },
        },
        Fields = new[] {},
        HubName = "sdkTestHub",
        ProfileType = "testProfile2326994",
        RelatedProfileType = "testProfile2326994",
        RelationshipName = "SomeRelationship",
        ResourceGroupName = "TestHubRG",
    });

});
Copy
package main

import (
	customerinsights "github.com/pulumi/pulumi-azure-native-sdk/customerinsights/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := customerinsights.NewRelationship(ctx, "relationship", &customerinsights.RelationshipArgs{
			Cardinality: customerinsights.CardinalityTypesOneToOne,
			Description: pulumi.StringMap{
				"en-us": pulumi.String("Relationship Description"),
			},
			DisplayName: pulumi.StringMap{
				"en-us": pulumi.String("Relationship DisplayName"),
			},
			Fields:             customerinsights.PropertyDefinitionArray{},
			HubName:            pulumi.String("sdkTestHub"),
			ProfileType:        pulumi.String("testProfile2326994"),
			RelatedProfileType: pulumi.String("testProfile2326994"),
			RelationshipName:   pulumi.String("SomeRelationship"),
			ResourceGroupName:  pulumi.String("TestHubRG"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.customerinsights.Relationship;
import com.pulumi.azurenative.customerinsights.RelationshipArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var relationship = new Relationship("relationship", RelationshipArgs.builder()
            .cardinality("OneToOne")
            .description(Map.of("en-us", "Relationship Description"))
            .displayName(Map.of("en-us", "Relationship DisplayName"))
            .fields()
            .hubName("sdkTestHub")
            .profileType("testProfile2326994")
            .relatedProfileType("testProfile2326994")
            .relationshipName("SomeRelationship")
            .resourceGroupName("TestHubRG")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const relationship = new azure_native.customerinsights.Relationship("relationship", {
    cardinality: azure_native.customerinsights.CardinalityTypes.OneToOne,
    description: {
        "en-us": "Relationship Description",
    },
    displayName: {
        "en-us": "Relationship DisplayName",
    },
    fields: [],
    hubName: "sdkTestHub",
    profileType: "testProfile2326994",
    relatedProfileType: "testProfile2326994",
    relationshipName: "SomeRelationship",
    resourceGroupName: "TestHubRG",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

relationship = azure_native.customerinsights.Relationship("relationship",
    cardinality=azure_native.customerinsights.CardinalityTypes.ONE_TO_ONE,
    description={
        "en-us": "Relationship Description",
    },
    display_name={
        "en-us": "Relationship DisplayName",
    },
    fields=[],
    hub_name="sdkTestHub",
    profile_type="testProfile2326994",
    related_profile_type="testProfile2326994",
    relationship_name="SomeRelationship",
    resource_group_name="TestHubRG")
Copy
resources:
  relationship:
    type: azure-native:customerinsights:Relationship
    properties:
      cardinality: OneToOne
      description:
        en-us: Relationship Description
      displayName:
        en-us: Relationship DisplayName
      fields: []
      hubName: sdkTestHub
      profileType: testProfile2326994
      relatedProfileType: testProfile2326994
      relationshipName: SomeRelationship
      resourceGroupName: TestHubRG
Copy

Create Relationship Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Relationship(name: string, args: RelationshipArgs, opts?: CustomResourceOptions);
@overload
def Relationship(resource_name: str,
                 args: RelationshipArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def Relationship(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 hub_name: Optional[str] = None,
                 profile_type: Optional[str] = None,
                 related_profile_type: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 cardinality: Optional[CardinalityTypes] = None,
                 description: Optional[Mapping[str, str]] = None,
                 display_name: Optional[Mapping[str, str]] = None,
                 expiry_date_time_utc: Optional[str] = None,
                 fields: Optional[Sequence[PropertyDefinitionArgs]] = None,
                 lookup_mappings: Optional[Sequence[RelationshipTypeMappingArgs]] = None,
                 relationship_name: Optional[str] = None)
func NewRelationship(ctx *Context, name string, args RelationshipArgs, opts ...ResourceOption) (*Relationship, error)
public Relationship(string name, RelationshipArgs args, CustomResourceOptions? opts = null)
public Relationship(String name, RelationshipArgs args)
public Relationship(String name, RelationshipArgs args, CustomResourceOptions options)

type: azure-native:customerinsights:Relationship
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. RelationshipArgs
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. RelationshipArgs
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. RelationshipArgs
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. RelationshipArgs
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. RelationshipArgs
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 relationshipResource = new AzureNative.CustomerInsights.Relationship("relationshipResource", new()
{
    HubName = "string",
    ProfileType = "string",
    RelatedProfileType = "string",
    ResourceGroupName = "string",
    Cardinality = AzureNative.CustomerInsights.CardinalityTypes.OneToOne,
    Description = 
    {
        { "string", "string" },
    },
    DisplayName = 
    {
        { "string", "string" },
    },
    ExpiryDateTimeUtc = "string",
    Fields = new[]
    {
        new AzureNative.CustomerInsights.Inputs.PropertyDefinitionArgs
        {
            FieldName = "string",
            FieldType = "string",
            IsEnum = false,
            EnumValidValues = new[]
            {
                new AzureNative.CustomerInsights.Inputs.ProfileEnumValidValuesFormatArgs
                {
                    LocalizedValueNames = 
                    {
                        { "string", "string" },
                    },
                    Value = 0,
                },
            },
            IsArray = false,
            IsAvailableInGraph = false,
            ArrayValueSeparator = "string",
            IsFlagEnum = false,
            IsImage = false,
            IsLocalizedString = false,
            IsName = false,
            IsRequired = false,
            MaxLength = 0,
            PropertyId = "string",
            SchemaItemPropLink = "string",
        },
    },
    LookupMappings = new[]
    {
        new AzureNative.CustomerInsights.Inputs.RelationshipTypeMappingArgs
        {
            FieldMappings = new[]
            {
                new AzureNative.CustomerInsights.Inputs.RelationshipTypeFieldMappingArgs
                {
                    ProfileFieldName = "string",
                    RelatedProfileKeyProperty = "string",
                },
            },
        },
    },
    RelationshipName = "string",
});
Copy
example, err := customerinsights.NewRelationship(ctx, "relationshipResource", &customerinsights.RelationshipArgs{
	HubName:            pulumi.String("string"),
	ProfileType:        pulumi.String("string"),
	RelatedProfileType: pulumi.String("string"),
	ResourceGroupName:  pulumi.String("string"),
	Cardinality:        customerinsights.CardinalityTypesOneToOne,
	Description: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ExpiryDateTimeUtc: pulumi.String("string"),
	Fields: customerinsights.PropertyDefinitionArray{
		&customerinsights.PropertyDefinitionArgs{
			FieldName: pulumi.String("string"),
			FieldType: pulumi.String("string"),
			IsEnum:    pulumi.Bool(false),
			EnumValidValues: customerinsights.ProfileEnumValidValuesFormatArray{
				&customerinsights.ProfileEnumValidValuesFormatArgs{
					LocalizedValueNames: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
					Value: pulumi.Int(0),
				},
			},
			IsArray:             pulumi.Bool(false),
			IsAvailableInGraph:  pulumi.Bool(false),
			ArrayValueSeparator: pulumi.String("string"),
			IsFlagEnum:          pulumi.Bool(false),
			IsImage:             pulumi.Bool(false),
			IsLocalizedString:   pulumi.Bool(false),
			IsName:              pulumi.Bool(false),
			IsRequired:          pulumi.Bool(false),
			MaxLength:           pulumi.Int(0),
			PropertyId:          pulumi.String("string"),
			SchemaItemPropLink:  pulumi.String("string"),
		},
	},
	LookupMappings: customerinsights.RelationshipTypeMappingArray{
		&customerinsights.RelationshipTypeMappingArgs{
			FieldMappings: customerinsights.RelationshipTypeFieldMappingArray{
				&customerinsights.RelationshipTypeFieldMappingArgs{
					ProfileFieldName:          pulumi.String("string"),
					RelatedProfileKeyProperty: pulumi.String("string"),
				},
			},
		},
	},
	RelationshipName: pulumi.String("string"),
})
Copy
var relationshipResource = new Relationship("relationshipResource", RelationshipArgs.builder()
    .hubName("string")
    .profileType("string")
    .relatedProfileType("string")
    .resourceGroupName("string")
    .cardinality("OneToOne")
    .description(Map.of("string", "string"))
    .displayName(Map.of("string", "string"))
    .expiryDateTimeUtc("string")
    .fields(PropertyDefinitionArgs.builder()
        .fieldName("string")
        .fieldType("string")
        .isEnum(false)
        .enumValidValues(ProfileEnumValidValuesFormatArgs.builder()
            .localizedValueNames(Map.of("string", "string"))
            .value(0)
            .build())
        .isArray(false)
        .isAvailableInGraph(false)
        .arrayValueSeparator("string")
        .isFlagEnum(false)
        .isImage(false)
        .isLocalizedString(false)
        .isName(false)
        .isRequired(false)
        .maxLength(0)
        .propertyId("string")
        .schemaItemPropLink("string")
        .build())
    .lookupMappings(RelationshipTypeMappingArgs.builder()
        .fieldMappings(RelationshipTypeFieldMappingArgs.builder()
            .profileFieldName("string")
            .relatedProfileKeyProperty("string")
            .build())
        .build())
    .relationshipName("string")
    .build());
Copy
relationship_resource = azure_native.customerinsights.Relationship("relationshipResource",
    hub_name="string",
    profile_type="string",
    related_profile_type="string",
    resource_group_name="string",
    cardinality=azure_native.customerinsights.CardinalityTypes.ONE_TO_ONE,
    description={
        "string": "string",
    },
    display_name={
        "string": "string",
    },
    expiry_date_time_utc="string",
    fields=[{
        "field_name": "string",
        "field_type": "string",
        "is_enum": False,
        "enum_valid_values": [{
            "localized_value_names": {
                "string": "string",
            },
            "value": 0,
        }],
        "is_array": False,
        "is_available_in_graph": False,
        "array_value_separator": "string",
        "is_flag_enum": False,
        "is_image": False,
        "is_localized_string": False,
        "is_name": False,
        "is_required": False,
        "max_length": 0,
        "property_id": "string",
        "schema_item_prop_link": "string",
    }],
    lookup_mappings=[{
        "field_mappings": [{
            "profile_field_name": "string",
            "related_profile_key_property": "string",
        }],
    }],
    relationship_name="string")
Copy
const relationshipResource = new azure_native.customerinsights.Relationship("relationshipResource", {
    hubName: "string",
    profileType: "string",
    relatedProfileType: "string",
    resourceGroupName: "string",
    cardinality: azure_native.customerinsights.CardinalityTypes.OneToOne,
    description: {
        string: "string",
    },
    displayName: {
        string: "string",
    },
    expiryDateTimeUtc: "string",
    fields: [{
        fieldName: "string",
        fieldType: "string",
        isEnum: false,
        enumValidValues: [{
            localizedValueNames: {
                string: "string",
            },
            value: 0,
        }],
        isArray: false,
        isAvailableInGraph: false,
        arrayValueSeparator: "string",
        isFlagEnum: false,
        isImage: false,
        isLocalizedString: false,
        isName: false,
        isRequired: false,
        maxLength: 0,
        propertyId: "string",
        schemaItemPropLink: "string",
    }],
    lookupMappings: [{
        fieldMappings: [{
            profileFieldName: "string",
            relatedProfileKeyProperty: "string",
        }],
    }],
    relationshipName: "string",
});
Copy
type: azure-native:customerinsights:Relationship
properties:
    cardinality: OneToOne
    description:
        string: string
    displayName:
        string: string
    expiryDateTimeUtc: string
    fields:
        - arrayValueSeparator: string
          enumValidValues:
            - localizedValueNames:
                string: string
              value: 0
          fieldName: string
          fieldType: string
          isArray: false
          isAvailableInGraph: false
          isEnum: false
          isFlagEnum: false
          isImage: false
          isLocalizedString: false
          isName: false
          isRequired: false
          maxLength: 0
          propertyId: string
          schemaItemPropLink: string
    hubName: string
    lookupMappings:
        - fieldMappings:
            - profileFieldName: string
              relatedProfileKeyProperty: string
    profileType: string
    relatedProfileType: string
    relationshipName: string
    resourceGroupName: string
Copy

Relationship 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 Relationship resource accepts the following input properties:

HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ProfileType This property is required. string
Profile type.
RelatedProfileType This property is required. string
Related profile being referenced.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Cardinality Pulumi.AzureNative.CustomerInsights.CardinalityTypes
The Relationship Cardinality.
Description Dictionary<string, string>
Localized descriptions for the Relationship.
DisplayName Dictionary<string, string>
Localized display name for the Relationship.
ExpiryDateTimeUtc string
The expiry date time in UTC.
Fields List<Pulumi.AzureNative.CustomerInsights.Inputs.PropertyDefinition>
The properties of the Relationship.
LookupMappings List<Pulumi.AzureNative.CustomerInsights.Inputs.RelationshipTypeMapping>
Optional property to be used to map fields in profile to their strong ids in related profile.
RelationshipName Changes to this property will trigger replacement. string
The name of the Relationship.
HubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
ProfileType This property is required. string
Profile type.
RelatedProfileType This property is required. string
Related profile being referenced.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Cardinality CardinalityTypes
The Relationship Cardinality.
Description map[string]string
Localized descriptions for the Relationship.
DisplayName map[string]string
Localized display name for the Relationship.
ExpiryDateTimeUtc string
The expiry date time in UTC.
Fields []PropertyDefinitionArgs
The properties of the Relationship.
LookupMappings []RelationshipTypeMappingArgs
Optional property to be used to map fields in profile to their strong ids in related profile.
RelationshipName Changes to this property will trigger replacement. string
The name of the Relationship.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
profileType This property is required. String
Profile type.
relatedProfileType This property is required. String
Related profile being referenced.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
cardinality CardinalityTypes
The Relationship Cardinality.
description Map<String,String>
Localized descriptions for the Relationship.
displayName Map<String,String>
Localized display name for the Relationship.
expiryDateTimeUtc String
The expiry date time in UTC.
fields List<PropertyDefinition>
The properties of the Relationship.
lookupMappings List<RelationshipTypeMapping>
Optional property to be used to map fields in profile to their strong ids in related profile.
relationshipName Changes to this property will trigger replacement. String
The name of the Relationship.
hubName
This property is required.
Changes to this property will trigger replacement.
string
The name of the hub.
profileType This property is required. string
Profile type.
relatedProfileType This property is required. string
Related profile being referenced.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
cardinality CardinalityTypes
The Relationship Cardinality.
description {[key: string]: string}
Localized descriptions for the Relationship.
displayName {[key: string]: string}
Localized display name for the Relationship.
expiryDateTimeUtc string
The expiry date time in UTC.
fields PropertyDefinition[]
The properties of the Relationship.
lookupMappings RelationshipTypeMapping[]
Optional property to be used to map fields in profile to their strong ids in related profile.
relationshipName Changes to this property will trigger replacement. string
The name of the Relationship.
hub_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the hub.
profile_type This property is required. str
Profile type.
related_profile_type This property is required. str
Related profile being referenced.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
cardinality CardinalityTypes
The Relationship Cardinality.
description Mapping[str, str]
Localized descriptions for the Relationship.
display_name Mapping[str, str]
Localized display name for the Relationship.
expiry_date_time_utc str
The expiry date time in UTC.
fields Sequence[PropertyDefinitionArgs]
The properties of the Relationship.
lookup_mappings Sequence[RelationshipTypeMappingArgs]
Optional property to be used to map fields in profile to their strong ids in related profile.
relationship_name Changes to this property will trigger replacement. str
The name of the Relationship.
hubName
This property is required.
Changes to this property will trigger replacement.
String
The name of the hub.
profileType This property is required. String
Profile type.
relatedProfileType This property is required. String
Related profile being referenced.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
cardinality "OneToOne" | "OneToMany" | "ManyToMany"
The Relationship Cardinality.
description Map<String>
Localized descriptions for the Relationship.
displayName Map<String>
Localized display name for the Relationship.
expiryDateTimeUtc String
The expiry date time in UTC.
fields List<Property Map>
The properties of the Relationship.
lookupMappings List<Property Map>
Optional property to be used to map fields in profile to their strong ids in related profile.
relationshipName Changes to this property will trigger replacement. String
The name of the Relationship.

Outputs

All input properties are implicitly available as output properties. Additionally, the Relationship resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
Provisioning state.
RelationshipGuidId string
The relationship guid id.
TenantId string
The hub name.
Type string
Resource type.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
ProvisioningState string
Provisioning state.
RelationshipGuidId string
The relationship guid id.
TenantId string
The hub name.
Type string
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
Provisioning state.
relationshipGuidId String
The relationship guid id.
tenantId String
The hub name.
type String
Resource type.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
provisioningState string
Provisioning state.
relationshipGuidId string
The relationship guid id.
tenantId string
The hub name.
type string
Resource type.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
provisioning_state str
Provisioning state.
relationship_guid_id str
The relationship guid id.
tenant_id str
The hub name.
type str
Resource type.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
provisioningState String
Provisioning state.
relationshipGuidId String
The relationship guid id.
tenantId String
The hub name.
type String
Resource type.

Supporting Types

CardinalityTypes
, CardinalityTypesArgs

OneToOne
OneToOne
OneToMany
OneToMany
ManyToMany
ManyToMany
CardinalityTypesOneToOne
OneToOne
CardinalityTypesOneToMany
OneToMany
CardinalityTypesManyToMany
ManyToMany
OneToOne
OneToOne
OneToMany
OneToMany
ManyToMany
ManyToMany
OneToOne
OneToOne
OneToMany
OneToMany
ManyToMany
ManyToMany
ONE_TO_ONE
OneToOne
ONE_TO_MANY
OneToMany
MANY_TO_MANY
ManyToMany
"OneToOne"
OneToOne
"OneToMany"
OneToMany
"ManyToMany"
ManyToMany

DataSourcePrecedenceResponse
, DataSourcePrecedenceResponseArgs

DataSourceReferenceId This property is required. string
The data source reference id.
DataSourceType This property is required. string
The data source type.
Id This property is required. int
The data source ID.
Name This property is required. string
The data source name
Status This property is required. string
The data source status.
Precedence int
the precedence value.
DataSourceReferenceId This property is required. string
The data source reference id.
DataSourceType This property is required. string
The data source type.
Id This property is required. int
The data source ID.
Name This property is required. string
The data source name
Status This property is required. string
The data source status.
Precedence int
the precedence value.
dataSourceReferenceId This property is required. String
The data source reference id.
dataSourceType This property is required. String
The data source type.
id This property is required. Integer
The data source ID.
name This property is required. String
The data source name
status This property is required. String
The data source status.
precedence Integer
the precedence value.
dataSourceReferenceId This property is required. string
The data source reference id.
dataSourceType This property is required. string
The data source type.
id This property is required. number
The data source ID.
name This property is required. string
The data source name
status This property is required. string
The data source status.
precedence number
the precedence value.
data_source_reference_id This property is required. str
The data source reference id.
data_source_type This property is required. str
The data source type.
id This property is required. int
The data source ID.
name This property is required. str
The data source name
status This property is required. str
The data source status.
precedence int
the precedence value.
dataSourceReferenceId This property is required. String
The data source reference id.
dataSourceType This property is required. String
The data source type.
id This property is required. Number
The data source ID.
name This property is required. String
The data source name
status This property is required. String
The data source status.
precedence Number
the precedence value.

ProfileEnumValidValuesFormat
, ProfileEnumValidValuesFormatArgs

LocalizedValueNames Dictionary<string, string>
Localized names of the enum member.
Value int
The integer value of the enum member.
LocalizedValueNames map[string]string
Localized names of the enum member.
Value int
The integer value of the enum member.
localizedValueNames Map<String,String>
Localized names of the enum member.
value Integer
The integer value of the enum member.
localizedValueNames {[key: string]: string}
Localized names of the enum member.
value number
The integer value of the enum member.
localized_value_names Mapping[str, str]
Localized names of the enum member.
value int
The integer value of the enum member.
localizedValueNames Map<String>
Localized names of the enum member.
value Number
The integer value of the enum member.

ProfileEnumValidValuesFormatResponse
, ProfileEnumValidValuesFormatResponseArgs

LocalizedValueNames Dictionary<string, string>
Localized names of the enum member.
Value int
The integer value of the enum member.
LocalizedValueNames map[string]string
Localized names of the enum member.
Value int
The integer value of the enum member.
localizedValueNames Map<String,String>
Localized names of the enum member.
value Integer
The integer value of the enum member.
localizedValueNames {[key: string]: string}
Localized names of the enum member.
value number
The integer value of the enum member.
localized_value_names Mapping[str, str]
Localized names of the enum member.
value int
The integer value of the enum member.
localizedValueNames Map<String>
Localized names of the enum member.
value Number
The integer value of the enum member.

PropertyDefinition
, PropertyDefinitionArgs

FieldName This property is required. string
Name of the property.
FieldType This property is required. string
Type of the property.
ArrayValueSeparator string
Array value separator for properties with isArray set.
EnumValidValues List<Pulumi.AzureNative.CustomerInsights.Inputs.ProfileEnumValidValuesFormat>
Describes valid values for an enum property.
IsArray bool
Indicates if the property is actually an array of the fieldType above on the data api.
IsAvailableInGraph bool
Whether property is available in graph or not.
IsEnum bool
Indicates if the property is an enum.
IsFlagEnum bool
Indicates if the property is an flag enum.
IsImage bool
Whether the property is an Image.
IsLocalizedString bool
Whether the property is a localized string.
IsName bool
Whether the property is a name or a part of name.
IsRequired bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
MaxLength int
Max length of string. Used only if type is string.
PropertyId string
The ID associated with the property.
SchemaItemPropLink string
URL encoded schema.org item prop link for the property.
FieldName This property is required. string
Name of the property.
FieldType This property is required. string
Type of the property.
ArrayValueSeparator string
Array value separator for properties with isArray set.
EnumValidValues []ProfileEnumValidValuesFormat
Describes valid values for an enum property.
IsArray bool
Indicates if the property is actually an array of the fieldType above on the data api.
IsAvailableInGraph bool
Whether property is available in graph or not.
IsEnum bool
Indicates if the property is an enum.
IsFlagEnum bool
Indicates if the property is an flag enum.
IsImage bool
Whether the property is an Image.
IsLocalizedString bool
Whether the property is a localized string.
IsName bool
Whether the property is a name or a part of name.
IsRequired bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
MaxLength int
Max length of string. Used only if type is string.
PropertyId string
The ID associated with the property.
SchemaItemPropLink string
URL encoded schema.org item prop link for the property.
fieldName This property is required. String
Name of the property.
fieldType This property is required. String
Type of the property.
arrayValueSeparator String
Array value separator for properties with isArray set.
enumValidValues List<ProfileEnumValidValuesFormat>
Describes valid values for an enum property.
isArray Boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph Boolean
Whether property is available in graph or not.
isEnum Boolean
Indicates if the property is an enum.
isFlagEnum Boolean
Indicates if the property is an flag enum.
isImage Boolean
Whether the property is an Image.
isLocalizedString Boolean
Whether the property is a localized string.
isName Boolean
Whether the property is a name or a part of name.
isRequired Boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength Integer
Max length of string. Used only if type is string.
propertyId String
The ID associated with the property.
schemaItemPropLink String
URL encoded schema.org item prop link for the property.
fieldName This property is required. string
Name of the property.
fieldType This property is required. string
Type of the property.
arrayValueSeparator string
Array value separator for properties with isArray set.
enumValidValues ProfileEnumValidValuesFormat[]
Describes valid values for an enum property.
isArray boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph boolean
Whether property is available in graph or not.
isEnum boolean
Indicates if the property is an enum.
isFlagEnum boolean
Indicates if the property is an flag enum.
isImage boolean
Whether the property is an Image.
isLocalizedString boolean
Whether the property is a localized string.
isName boolean
Whether the property is a name or a part of name.
isRequired boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength number
Max length of string. Used only if type is string.
propertyId string
The ID associated with the property.
schemaItemPropLink string
URL encoded schema.org item prop link for the property.
field_name This property is required. str
Name of the property.
field_type This property is required. str
Type of the property.
array_value_separator str
Array value separator for properties with isArray set.
enum_valid_values Sequence[ProfileEnumValidValuesFormat]
Describes valid values for an enum property.
is_array bool
Indicates if the property is actually an array of the fieldType above on the data api.
is_available_in_graph bool
Whether property is available in graph or not.
is_enum bool
Indicates if the property is an enum.
is_flag_enum bool
Indicates if the property is an flag enum.
is_image bool
Whether the property is an Image.
is_localized_string bool
Whether the property is a localized string.
is_name bool
Whether the property is a name or a part of name.
is_required bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
max_length int
Max length of string. Used only if type is string.
property_id str
The ID associated with the property.
schema_item_prop_link str
URL encoded schema.org item prop link for the property.
fieldName This property is required. String
Name of the property.
fieldType This property is required. String
Type of the property.
arrayValueSeparator String
Array value separator for properties with isArray set.
enumValidValues List<Property Map>
Describes valid values for an enum property.
isArray Boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph Boolean
Whether property is available in graph or not.
isEnum Boolean
Indicates if the property is an enum.
isFlagEnum Boolean
Indicates if the property is an flag enum.
isImage Boolean
Whether the property is an Image.
isLocalizedString Boolean
Whether the property is a localized string.
isName Boolean
Whether the property is a name or a part of name.
isRequired Boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength Number
Max length of string. Used only if type is string.
propertyId String
The ID associated with the property.
schemaItemPropLink String
URL encoded schema.org item prop link for the property.

PropertyDefinitionResponse
, PropertyDefinitionResponseArgs

DataSourcePrecedenceRules This property is required. List<Pulumi.AzureNative.CustomerInsights.Inputs.DataSourcePrecedenceResponse>
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
FieldName This property is required. string
Name of the property.
FieldType This property is required. string
Type of the property.
ArrayValueSeparator string
Array value separator for properties with isArray set.
EnumValidValues List<Pulumi.AzureNative.CustomerInsights.Inputs.ProfileEnumValidValuesFormatResponse>
Describes valid values for an enum property.
IsArray bool
Indicates if the property is actually an array of the fieldType above on the data api.
IsAvailableInGraph bool
Whether property is available in graph or not.
IsEnum bool
Indicates if the property is an enum.
IsFlagEnum bool
Indicates if the property is an flag enum.
IsImage bool
Whether the property is an Image.
IsLocalizedString bool
Whether the property is a localized string.
IsName bool
Whether the property is a name or a part of name.
IsRequired bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
MaxLength int
Max length of string. Used only if type is string.
PropertyId string
The ID associated with the property.
SchemaItemPropLink string
URL encoded schema.org item prop link for the property.
DataSourcePrecedenceRules This property is required. []DataSourcePrecedenceResponse
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
FieldName This property is required. string
Name of the property.
FieldType This property is required. string
Type of the property.
ArrayValueSeparator string
Array value separator for properties with isArray set.
EnumValidValues []ProfileEnumValidValuesFormatResponse
Describes valid values for an enum property.
IsArray bool
Indicates if the property is actually an array of the fieldType above on the data api.
IsAvailableInGraph bool
Whether property is available in graph or not.
IsEnum bool
Indicates if the property is an enum.
IsFlagEnum bool
Indicates if the property is an flag enum.
IsImage bool
Whether the property is an Image.
IsLocalizedString bool
Whether the property is a localized string.
IsName bool
Whether the property is a name or a part of name.
IsRequired bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
MaxLength int
Max length of string. Used only if type is string.
PropertyId string
The ID associated with the property.
SchemaItemPropLink string
URL encoded schema.org item prop link for the property.
dataSourcePrecedenceRules This property is required. List<DataSourcePrecedenceResponse>
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
fieldName This property is required. String
Name of the property.
fieldType This property is required. String
Type of the property.
arrayValueSeparator String
Array value separator for properties with isArray set.
enumValidValues List<ProfileEnumValidValuesFormatResponse>
Describes valid values for an enum property.
isArray Boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph Boolean
Whether property is available in graph or not.
isEnum Boolean
Indicates if the property is an enum.
isFlagEnum Boolean
Indicates if the property is an flag enum.
isImage Boolean
Whether the property is an Image.
isLocalizedString Boolean
Whether the property is a localized string.
isName Boolean
Whether the property is a name or a part of name.
isRequired Boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength Integer
Max length of string. Used only if type is string.
propertyId String
The ID associated with the property.
schemaItemPropLink String
URL encoded schema.org item prop link for the property.
dataSourcePrecedenceRules This property is required. DataSourcePrecedenceResponse[]
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
fieldName This property is required. string
Name of the property.
fieldType This property is required. string
Type of the property.
arrayValueSeparator string
Array value separator for properties with isArray set.
enumValidValues ProfileEnumValidValuesFormatResponse[]
Describes valid values for an enum property.
isArray boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph boolean
Whether property is available in graph or not.
isEnum boolean
Indicates if the property is an enum.
isFlagEnum boolean
Indicates if the property is an flag enum.
isImage boolean
Whether the property is an Image.
isLocalizedString boolean
Whether the property is a localized string.
isName boolean
Whether the property is a name or a part of name.
isRequired boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength number
Max length of string. Used only if type is string.
propertyId string
The ID associated with the property.
schemaItemPropLink string
URL encoded schema.org item prop link for the property.
data_source_precedence_rules This property is required. Sequence[DataSourcePrecedenceResponse]
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
field_name This property is required. str
Name of the property.
field_type This property is required. str
Type of the property.
array_value_separator str
Array value separator for properties with isArray set.
enum_valid_values Sequence[ProfileEnumValidValuesFormatResponse]
Describes valid values for an enum property.
is_array bool
Indicates if the property is actually an array of the fieldType above on the data api.
is_available_in_graph bool
Whether property is available in graph or not.
is_enum bool
Indicates if the property is an enum.
is_flag_enum bool
Indicates if the property is an flag enum.
is_image bool
Whether the property is an Image.
is_localized_string bool
Whether the property is a localized string.
is_name bool
Whether the property is a name or a part of name.
is_required bool
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
max_length int
Max length of string. Used only if type is string.
property_id str
The ID associated with the property.
schema_item_prop_link str
URL encoded schema.org item prop link for the property.
dataSourcePrecedenceRules This property is required. List<Property Map>
This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
fieldName This property is required. String
Name of the property.
fieldType This property is required. String
Type of the property.
arrayValueSeparator String
Array value separator for properties with isArray set.
enumValidValues List<Property Map>
Describes valid values for an enum property.
isArray Boolean
Indicates if the property is actually an array of the fieldType above on the data api.
isAvailableInGraph Boolean
Whether property is available in graph or not.
isEnum Boolean
Indicates if the property is an enum.
isFlagEnum Boolean
Indicates if the property is an flag enum.
isImage Boolean
Whether the property is an Image.
isLocalizedString Boolean
Whether the property is a localized string.
isName Boolean
Whether the property is a name or a part of name.
isRequired Boolean
Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
maxLength Number
Max length of string. Used only if type is string.
propertyId String
The ID associated with the property.
schemaItemPropLink String
URL encoded schema.org item prop link for the property.

RelationshipTypeFieldMapping
, RelationshipTypeFieldMappingArgs

ProfileFieldName This property is required. string
Specifies the fieldName in profile.
RelatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
ProfileFieldName This property is required. string
Specifies the fieldName in profile.
RelatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. String
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. String
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. string
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
profile_field_name This property is required. str
Specifies the fieldName in profile.
related_profile_key_property This property is required. str
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. String
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. String
Specifies the KeyProperty (from StrongId) of the related profile.

RelationshipTypeFieldMappingResponse
, RelationshipTypeFieldMappingResponseArgs

ProfileFieldName This property is required. string
Specifies the fieldName in profile.
RelatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
ProfileFieldName This property is required. string
Specifies the fieldName in profile.
RelatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. String
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. String
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. string
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. string
Specifies the KeyProperty (from StrongId) of the related profile.
profile_field_name This property is required. str
Specifies the fieldName in profile.
related_profile_key_property This property is required. str
Specifies the KeyProperty (from StrongId) of the related profile.
profileFieldName This property is required. String
Specifies the fieldName in profile.
relatedProfileKeyProperty This property is required. String
Specifies the KeyProperty (from StrongId) of the related profile.

RelationshipTypeMapping
, RelationshipTypeMappingArgs

FieldMappings This property is required. List<Pulumi.AzureNative.CustomerInsights.Inputs.RelationshipTypeFieldMapping>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
FieldMappings This property is required. []RelationshipTypeFieldMapping
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. List<RelationshipTypeFieldMapping>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. RelationshipTypeFieldMapping[]
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
field_mappings This property is required. Sequence[RelationshipTypeFieldMapping]
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. List<Property Map>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.

RelationshipTypeMappingResponse
, RelationshipTypeMappingResponseArgs

FieldMappings This property is required. List<Pulumi.AzureNative.CustomerInsights.Inputs.RelationshipTypeFieldMappingResponse>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
FieldMappings This property is required. []RelationshipTypeFieldMappingResponse
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. List<RelationshipTypeFieldMappingResponse>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. RelationshipTypeFieldMappingResponse[]
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
field_mappings This property is required. Sequence[RelationshipTypeFieldMappingResponse]
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
fieldMappings This property is required. List<Property Map>
Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:customerinsights:Relationship sdkTestHub/testProfile2326994 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native