Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. customerinsights
  5. Relationship
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.customerinsights.Relationship

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    The relationship resource format. 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",
    });

});

    package main

import (
	customerinsights "github.com/pulumi/pulumi-azure-native-sdk/customerinsights"
	"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
	})
}

    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());

    }
}

    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")

    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",
});

    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

    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 string
    The unique name of the resource.
    args RelationshipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args RelationshipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RelationshipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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 = "OneToOne",
    Description = 
    {
        { "string", "string" },
    },
    DisplayName = 
    {
        { "string", "string" },
    },
    ExpiryDateTimeUtc = "string",
    Fields = new[]
    {
        
        {
            { "fieldName", "string" },
            { "fieldType", "string" },
            { "isEnum", false },
            { "enumValidValues", new[]
            {
                
                {
                    { "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[]
    {
        
        {
            { "fieldMappings", new[]
            {
                
                {
                    { "profileFieldName", "string" },
                    { "relatedProfileKeyProperty", "string" },
                },
            } },
        },
    },
    RelationshipName = "string",
});

    example, err := customerinsights.NewRelationship(ctx, "relationshipResource", &customerinsights.RelationshipArgs{
	HubName:            "string",
	ProfileType:        "string",
	RelatedProfileType: "string",
	ResourceGroupName:  "string",
	Cardinality:        "OneToOne",
	Description: map[string]interface{}{
		"string": "string",
	},
	DisplayName: map[string]interface{}{
		"string": "string",
	},
	ExpiryDateTimeUtc: "string",
	Fields: []map[string]interface{}{
		map[string]interface{}{
			"fieldName": "string",
			"fieldType": "string",
			"isEnum":    false,
			"enumValidValues": []map[string]interface{}{
				map[string]interface{}{
					"localizedValueNames": map[string]interface{}{
						"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: []map[string]interface{}{
		map[string]interface{}{
			"fieldMappings": []map[string]interface{}{
				map[string]interface{}{
					"profileFieldName":          "string",
					"relatedProfileKeyProperty": "string",
				},
			},
		},
	},
	RelationshipName: "string",
})

    var relationshipResource = new Relationship("relationshipResource", RelationshipArgs.builder()
    .hubName("string")
    .profileType("string")
    .relatedProfileType("string")
    .resourceGroupName("string")
    .cardinality("OneToOne")
    .description(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .displayName(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .expiryDateTimeUtc("string")
    .fields(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .lookupMappings(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .relationshipName("string")
    .build());

    relationship_resource = azure_native.customerinsights.Relationship("relationshipResource",
    hub_name=string,
    profile_type=string,
    related_profile_type=string,
    resource_group_name=string,
    cardinality=OneToOne,
    description={
        string: string,
    },
    display_name={
        string: string,
    },
    expiry_date_time_utc=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,
    }],
    lookup_mappings=[{
        fieldMappings: [{
            profileFieldName: string,
            relatedProfileKeyProperty: string,
        }],
    }],
    relationship_name=string)

    const relationshipResource = new azure_native.customerinsights.Relationship("relationshipResource", {
    hubName: "string",
    profileType: "string",
    relatedProfileType: "string",
    resourceGroupName: "string",
    cardinality: "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",
});

    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

    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

    The Relationship resource accepts the following input properties:

    HubName string
    The name of the hub.
    ProfileType string
    Profile type.
    RelatedProfileType string
    Related profile being referenced.
    ResourceGroupName 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 string
    The name of the Relationship.
    HubName string
    The name of the hub.
    ProfileType string
    Profile type.
    RelatedProfileType string
    Related profile being referenced.
    ResourceGroupName 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 string
    The name of the Relationship.
    hubName String
    The name of the hub.
    profileType String
    Profile type.
    relatedProfileType String
    Related profile being referenced.
    resourceGroupName 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 String
    The name of the Relationship.
    hubName string
    The name of the hub.
    profileType string
    Profile type.
    relatedProfileType string
    Related profile being referenced.
    resourceGroupName 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 string
    The name of the Relationship.
    hub_name str
    The name of the hub.
    profile_type str
    Profile type.
    related_profile_type str
    Related profile being referenced.
    resource_group_name 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 str
    The name of the Relationship.
    hubName String
    The name of the hub.
    profileType String
    Profile type.
    relatedProfileType String
    Related profile being referenced.
    resourceGroupName 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 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:

    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.
    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.
    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.
    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.
    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.
    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 string
    The data source reference id.
    DataSourceType string
    The data source type.
    Id int
    The data source ID.
    Name string
    The data source name
    Status string
    The data source status.
    Precedence int
    the precedence value.
    DataSourceReferenceId string
    The data source reference id.
    DataSourceType string
    The data source type.
    Id int
    The data source ID.
    Name string
    The data source name
    Status string
    The data source status.
    Precedence int
    the precedence value.
    dataSourceReferenceId String
    The data source reference id.
    dataSourceType String
    The data source type.
    id Integer
    The data source ID.
    name String
    The data source name
    status String
    The data source status.
    precedence Integer
    the precedence value.
    dataSourceReferenceId string
    The data source reference id.
    dataSourceType string
    The data source type.
    id number
    The data source ID.
    name string
    The data source name
    status string
    The data source status.
    precedence number
    the precedence value.
    data_source_reference_id str
    The data source reference id.
    data_source_type str
    The data source type.
    id int
    The data source ID.
    name str
    The data source name
    status str
    The data source status.
    precedence int
    the precedence value.
    dataSourceReferenceId String
    The data source reference id.
    dataSourceType String
    The data source type.
    id Number
    The data source ID.
    name String
    The data source name
    status 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 string
    Name of the property.
    FieldType 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 string
    Name of the property.
    FieldType 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 String
    Name of the property.
    fieldType 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 string
    Name of the property.
    fieldType 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 str
    Name of the property.
    field_type 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 String
    Name of the property.
    fieldType 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 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 string
    Name of the property.
    FieldType 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 []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 string
    Name of the property.
    FieldType 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 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 String
    Name of the property.
    fieldType 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 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 string
    Name of the property.
    fieldType 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 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 str
    Name of the property.
    field_type 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 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 String
    Name of the property.
    fieldType 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 string
    Specifies the fieldName in profile.
    RelatedProfileKeyProperty string
    Specifies the KeyProperty (from StrongId) of the related profile.
    ProfileFieldName string
    Specifies the fieldName in profile.
    RelatedProfileKeyProperty string
    Specifies the KeyProperty (from StrongId) of the related profile.
    profileFieldName String
    Specifies the fieldName in profile.
    relatedProfileKeyProperty String
    Specifies the KeyProperty (from StrongId) of the related profile.
    profileFieldName string
    Specifies the fieldName in profile.
    relatedProfileKeyProperty string
    Specifies the KeyProperty (from StrongId) of the related profile.
    profile_field_name str
    Specifies the fieldName in profile.
    related_profile_key_property str
    Specifies the KeyProperty (from StrongId) of the related profile.
    profileFieldName String
    Specifies the fieldName in profile.
    relatedProfileKeyProperty String
    Specifies the KeyProperty (from StrongId) of the related profile.

    RelationshipTypeFieldMappingResponse, RelationshipTypeFieldMappingResponseArgs

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

    RelationshipTypeMapping, RelationshipTypeMappingArgs

    FieldMappings 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 []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 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 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 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 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 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 []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 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 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 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 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/c909e979-ef71-4def-a970-bc7c154db8c5/resourceGroups/TestHubRG/providers/Microsoft.CustomerInsights/hubs/sdkTestHub/relationships/SomeRelationship

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native