azure-native.customerinsights.Relationship
Explore with Pulumi AI
The relationship resource format. Azure REST API version: 2017-04-26. Prior API version in Azure Native 1.x: 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/v2"
	"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 * 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",
});
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")
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 = 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",
});
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"),
})
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());
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")
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",
});
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
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 string
- The name of the hub.
- ProfileType string
- Profile type.
- string
- Related profile being referenced.
- ResourceGroup stringName 
- The name of the resource group.
- Cardinality
Pulumi.Azure Native. Customer Insights. Cardinality Types 
- The Relationship Cardinality.
- Description Dictionary<string, string>
- Localized descriptions for the Relationship.
- DisplayName Dictionary<string, string>
- Localized display name for the Relationship.
- ExpiryDate stringTime Utc 
- The expiry date time in UTC.
- Fields
List<Pulumi.Azure Native. Customer Insights. Inputs. Property Definition> 
- The properties of the Relationship.
- LookupMappings List<Pulumi.Azure Native. Customer Insights. Inputs. Relationship Type Mapping> 
- 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.
- string
- Related profile being referenced.
- ResourceGroup stringName 
- 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.
- ExpiryDate stringTime Utc 
- The expiry date time in UTC.
- Fields
[]PropertyDefinition Args 
- The properties of the Relationship.
- LookupMappings []RelationshipType Mapping Args 
- 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.
- String
- Related profile being referenced.
- resourceGroup StringName 
- 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.
- expiryDate StringTime Utc 
- The expiry date time in UTC.
- fields
List<PropertyDefinition> 
- The properties of the Relationship.
- lookupMappings List<RelationshipType Mapping> 
- 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.
- string
- Related profile being referenced.
- resourceGroup stringName 
- 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.
- expiryDate stringTime Utc 
- The expiry date time in UTC.
- fields
PropertyDefinition[] 
- The properties of the Relationship.
- lookupMappings RelationshipType Mapping[] 
- 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.
- str
- Related profile being referenced.
- resource_group_ strname 
- 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_ strtime_ utc 
- The expiry date time in UTC.
- fields
Sequence[PropertyDefinition Args] 
- The properties of the Relationship.
- lookup_mappings Sequence[RelationshipType Mapping Args] 
- 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.
- String
- Related profile being referenced.
- resourceGroup StringName 
- The name of the resource group.
- cardinality
"OneTo One" | "One To Many" | "Many To Many" 
- The Relationship Cardinality.
- description Map<String>
- Localized descriptions for the Relationship.
- displayName Map<String>
- Localized display name for the Relationship.
- expiryDate StringTime Utc 
- 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.
- RelationshipGuid stringId 
- 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.
- RelationshipGuid stringId 
- 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.
- relationshipGuid StringId 
- 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.
- relationshipGuid stringId 
- 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_ strid 
- 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.
- relationshipGuid StringId 
- The relationship guid id.
- tenantId String
- The hub name.
- type String
- Resource type.
Supporting Types
CardinalityTypes, CardinalityTypesArgs    
- OneTo One 
- OneToOne
- OneTo Many 
- OneToMany
- ManyTo Many 
- ManyToMany
- CardinalityTypes One To One 
- OneToOne
- CardinalityTypes One To Many 
- OneToMany
- CardinalityTypes Many To Many 
- ManyToMany
- OneTo One 
- OneToOne
- OneTo Many 
- OneToMany
- ManyTo Many 
- ManyToMany
- OneTo One 
- OneToOne
- OneTo Many 
- OneToMany
- ManyTo Many 
- ManyToMany
- ONE_TO_ONE
- OneToOne
- ONE_TO_MANY
- OneToMany
- MANY_TO_MANY
- ManyToMany
- "OneTo One" 
- OneToOne
- "OneTo Many" 
- OneToMany
- "ManyTo Many" 
- ManyToMany
DataSourcePrecedenceResponse, DataSourcePrecedenceResponseArgs        
- DataSource stringReference Id 
- The data source reference id.
- DataSource stringType 
- 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.
- DataSource stringReference Id 
- The data source reference id.
- DataSource stringType 
- 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.
- dataSource StringReference Id 
- The data source reference id.
- dataSource StringType 
- 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.
- dataSource stringReference Id 
- The data source reference id.
- dataSource stringType 
- 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_ strreference_ id 
- The data source reference id.
- data_source_ strtype 
- 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.
- dataSource StringReference Id 
- The data source reference id.
- dataSource StringType 
- 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          
- LocalizedValue Dictionary<string, string>Names 
- Localized names of the enum member.
- Value int
- The integer value of the enum member.
- LocalizedValue map[string]stringNames 
- Localized names of the enum member.
- Value int
- The integer value of the enum member.
- localizedValue Map<String,String>Names 
- Localized names of the enum member.
- value Integer
- The integer value of the enum member.
- localizedValue {[key: string]: string}Names 
- Localized names of the enum member.
- value number
- The integer value of the enum member.
- localized_value_ Mapping[str, str]names 
- Localized names of the enum member.
- value int
- The integer value of the enum member.
- localizedValue Map<String>Names 
- Localized names of the enum member.
- value Number
- The integer value of the enum member.
ProfileEnumValidValuesFormatResponse, ProfileEnumValidValuesFormatResponseArgs            
- LocalizedValue Dictionary<string, string>Names 
- Localized names of the enum member.
- Value int
- The integer value of the enum member.
- LocalizedValue map[string]stringNames 
- Localized names of the enum member.
- Value int
- The integer value of the enum member.
- localizedValue Map<String,String>Names 
- Localized names of the enum member.
- value Integer
- The integer value of the enum member.
- localizedValue {[key: string]: string}Names 
- Localized names of the enum member.
- value number
- The integer value of the enum member.
- localized_value_ Mapping[str, str]names 
- Localized names of the enum member.
- value int
- The integer value of the enum member.
- localizedValue Map<String>Names 
- 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.
- ArrayValue stringSeparator 
- Array value separator for properties with isArray set.
- EnumValid List<Pulumi.Values Azure Native. Customer Insights. Inputs. Profile Enum Valid Values Format> 
- 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.
- IsAvailable boolIn Graph 
- Whether property is available in graph or not.
- IsEnum bool
- Indicates if the property is an enum.
- IsFlag boolEnum 
- Indicates if the property is an flag enum.
- IsImage bool
- Whether the property is an Image.
- IsLocalized boolString 
- 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.
- SchemaItem stringProp Link 
- URL encoded schema.org item prop link for the property.
- FieldName string
- Name of the property.
- FieldType string
- Type of the property.
- ArrayValue stringSeparator 
- Array value separator for properties with isArray set.
- EnumValid []ProfileValues Enum Valid Values Format 
- 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.
- IsAvailable boolIn Graph 
- Whether property is available in graph or not.
- IsEnum bool
- Indicates if the property is an enum.
- IsFlag boolEnum 
- Indicates if the property is an flag enum.
- IsImage bool
- Whether the property is an Image.
- IsLocalized boolString 
- 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.
- SchemaItem stringProp Link 
- URL encoded schema.org item prop link for the property.
- fieldName String
- Name of the property.
- fieldType String
- Type of the property.
- arrayValue StringSeparator 
- Array value separator for properties with isArray set.
- enumValid List<ProfileValues Enum Valid Values Format> 
- 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.
- isAvailable BooleanIn Graph 
- Whether property is available in graph or not.
- isEnum Boolean
- Indicates if the property is an enum.
- isFlag BooleanEnum 
- Indicates if the property is an flag enum.
- isImage Boolean
- Whether the property is an Image.
- isLocalized BooleanString 
- 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.
- schemaItem StringProp Link 
- URL encoded schema.org item prop link for the property.
- fieldName string
- Name of the property.
- fieldType string
- Type of the property.
- arrayValue stringSeparator 
- Array value separator for properties with isArray set.
- enumValid ProfileValues Enum Valid Values Format[] 
- 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.
- isAvailable booleanIn Graph 
- Whether property is available in graph or not.
- isEnum boolean
- Indicates if the property is an enum.
- isFlag booleanEnum 
- Indicates if the property is an flag enum.
- isImage boolean
- Whether the property is an Image.
- isLocalized booleanString 
- 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.
- schemaItem stringProp Link 
- 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_ strseparator 
- Array value separator for properties with isArray set.
- enum_valid_ Sequence[Profilevalues Enum Valid Values Format] 
- 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_ boolin_ graph 
- Whether property is available in graph or not.
- is_enum bool
- Indicates if the property is an enum.
- is_flag_ boolenum 
- Indicates if the property is an flag enum.
- is_image bool
- Whether the property is an Image.
- is_localized_ boolstring 
- 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_ strprop_ link 
- URL encoded schema.org item prop link for the property.
- fieldName String
- Name of the property.
- fieldType String
- Type of the property.
- arrayValue StringSeparator 
- Array value separator for properties with isArray set.
- enumValid List<Property Map>Values 
- 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.
- isAvailable BooleanIn Graph 
- Whether property is available in graph or not.
- isEnum Boolean
- Indicates if the property is an enum.
- isFlag BooleanEnum 
- Indicates if the property is an flag enum.
- isImage Boolean
- Whether the property is an Image.
- isLocalized BooleanString 
- 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.
- schemaItem StringProp Link 
- URL encoded schema.org item prop link for the property.
PropertyDefinitionResponse, PropertyDefinitionResponseArgs      
- DataSource List<Pulumi.Precedence Rules Azure Native. Customer Insights. Inputs. Data Source Precedence Response> 
- 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.
- ArrayValue stringSeparator 
- Array value separator for properties with isArray set.
- EnumValid List<Pulumi.Values Azure Native. Customer Insights. Inputs. Profile Enum Valid Values Format Response> 
- 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.
- IsAvailable boolIn Graph 
- Whether property is available in graph or not.
- IsEnum bool
- Indicates if the property is an enum.
- IsFlag boolEnum 
- Indicates if the property is an flag enum.
- IsImage bool
- Whether the property is an Image.
- IsLocalized boolString 
- 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.
- SchemaItem stringProp Link 
- URL encoded schema.org item prop link for the property.
- DataSource []DataPrecedence Rules Source Precedence Response 
- 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.
- ArrayValue stringSeparator 
- Array value separator for properties with isArray set.
- EnumValid []ProfileValues Enum Valid Values Format Response 
- 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.
- IsAvailable boolIn Graph 
- Whether property is available in graph or not.
- IsEnum bool
- Indicates if the property is an enum.
- IsFlag boolEnum 
- Indicates if the property is an flag enum.
- IsImage bool
- Whether the property is an Image.
- IsLocalized boolString 
- 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.
- SchemaItem stringProp Link 
- URL encoded schema.org item prop link for the property.
- dataSource List<DataPrecedence Rules Source Precedence Response> 
- 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.
- arrayValue StringSeparator 
- Array value separator for properties with isArray set.
- enumValid List<ProfileValues Enum Valid Values Format Response> 
- 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.
- isAvailable BooleanIn Graph 
- Whether property is available in graph or not.
- isEnum Boolean
- Indicates if the property is an enum.
- isFlag BooleanEnum 
- Indicates if the property is an flag enum.
- isImage Boolean
- Whether the property is an Image.
- isLocalized BooleanString 
- 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.
- schemaItem StringProp Link 
- URL encoded schema.org item prop link for the property.
- dataSource DataPrecedence Rules Source Precedence Response[] 
- 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.
- arrayValue stringSeparator 
- Array value separator for properties with isArray set.
- enumValid ProfileValues Enum Valid Values Format Response[] 
- 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.
- isAvailable booleanIn Graph 
- Whether property is available in graph or not.
- isEnum boolean
- Indicates if the property is an enum.
- isFlag booleanEnum 
- Indicates if the property is an flag enum.
- isImage boolean
- Whether the property is an Image.
- isLocalized booleanString 
- 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.
- schemaItem stringProp Link 
- URL encoded schema.org item prop link for the property.
- data_source_ Sequence[Dataprecedence_ rules Source Precedence Response] 
- 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_ strseparator 
- Array value separator for properties with isArray set.
- enum_valid_ Sequence[Profilevalues Enum Valid Values Format Response] 
- 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_ boolin_ graph 
- Whether property is available in graph or not.
- is_enum bool
- Indicates if the property is an enum.
- is_flag_ boolenum 
- Indicates if the property is an flag enum.
- is_image bool
- Whether the property is an Image.
- is_localized_ boolstring 
- 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_ strprop_ link 
- URL encoded schema.org item prop link for the property.
- dataSource List<Property Map>Precedence Rules 
- 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.
- arrayValue StringSeparator 
- Array value separator for properties with isArray set.
- enumValid List<Property Map>Values 
- 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.
- isAvailable BooleanIn Graph 
- Whether property is available in graph or not.
- isEnum Boolean
- Indicates if the property is an enum.
- isFlag BooleanEnum 
- Indicates if the property is an flag enum.
- isImage Boolean
- Whether the property is an Image.
- isLocalized BooleanString 
- 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.
- schemaItem StringProp Link 
- URL encoded schema.org item prop link for the property.
RelationshipTypeFieldMapping, RelationshipTypeFieldMappingArgs        
- ProfileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- ProfileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField StringName 
- Specifies the fieldName in profile.
- String
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- profile_field_ strname 
- Specifies the fieldName in profile.
- str
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField StringName 
- Specifies the fieldName in profile.
- String
- Specifies the KeyProperty (from StrongId) of the related profile.
RelationshipTypeFieldMappingResponse, RelationshipTypeFieldMappingResponseArgs          
- ProfileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- ProfileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField StringName 
- Specifies the fieldName in profile.
- String
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField stringName 
- Specifies the fieldName in profile.
- string
- Specifies the KeyProperty (from StrongId) of the related profile.
- profile_field_ strname 
- Specifies the fieldName in profile.
- str
- Specifies the KeyProperty (from StrongId) of the related profile.
- profileField StringName 
- Specifies the fieldName in profile.
- String
- Specifies the KeyProperty (from StrongId) of the related profile.
RelationshipTypeMapping, RelationshipTypeMappingArgs      
- FieldMappings List<Pulumi.Azure Native. Customer Insights. Inputs. Relationship Type Field Mapping> 
- Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
- FieldMappings []RelationshipType Field Mapping 
- 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<RelationshipType Field Mapping> 
- Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
- fieldMappings RelationshipType Field Mapping[] 
- 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[RelationshipType Field Mapping] 
- 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.Azure Native. Customer Insights. Inputs. Relationship Type Field Mapping Response> 
- Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
- FieldMappings []RelationshipType Field Mapping Response 
- 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<RelationshipType Field Mapping Response> 
- Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well.
- fieldMappings RelationshipType Field Mapping Response[] 
- 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[RelationshipType Field Mapping Response] 
- 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/relationships/{relationshipName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0