1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. getRelationship
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.customerinsights.getRelationship

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Gets information about the specified relationship. Azure REST API version: 2017-04-26.

    Using getRelationship

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRelationship(args: GetRelationshipArgs, opts?: InvokeOptions): Promise<GetRelationshipResult>
    function getRelationshipOutput(args: GetRelationshipOutputArgs, opts?: InvokeOptions): Output<GetRelationshipResult>
    def get_relationship(hub_name: Optional[str] = None,
                         relationship_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRelationshipResult
    def get_relationship_output(hub_name: Optional[pulumi.Input[str]] = None,
                         relationship_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRelationshipResult]
    func LookupRelationship(ctx *Context, args *LookupRelationshipArgs, opts ...InvokeOption) (*LookupRelationshipResult, error)
    func LookupRelationshipOutput(ctx *Context, args *LookupRelationshipOutputArgs, opts ...InvokeOption) LookupRelationshipResultOutput

    > Note: This function is named LookupRelationship in the Go SDK.

    public static class GetRelationship 
    {
        public static Task<GetRelationshipResult> InvokeAsync(GetRelationshipArgs args, InvokeOptions? opts = null)
        public static Output<GetRelationshipResult> Invoke(GetRelationshipInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRelationshipResult> getRelationship(GetRelationshipArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:customerinsights:getRelationship
      arguments:
        # arguments dictionary

    The following arguments are supported:

    HubName string
    The name of the hub.
    RelationshipName string
    The name of the relationship.
    ResourceGroupName string
    The name of the resource group.
    HubName string
    The name of the hub.
    RelationshipName string
    The name of the relationship.
    ResourceGroupName string
    The name of the resource group.
    hubName String
    The name of the hub.
    relationshipName String
    The name of the relationship.
    resourceGroupName String
    The name of the resource group.
    hubName string
    The name of the hub.
    relationshipName string
    The name of the relationship.
    resourceGroupName string
    The name of the resource group.
    hub_name str
    The name of the hub.
    relationship_name str
    The name of the relationship.
    resource_group_name str
    The name of the resource group.
    hubName String
    The name of the hub.
    relationshipName String
    The name of the relationship.
    resourceGroupName String
    The name of the resource group.

    getRelationship Result

    The following output properties are available:

    Id string
    Resource ID.
    Name string
    Resource name.
    ProfileType string
    Profile type.
    ProvisioningState string
    Provisioning state.
    RelatedProfileType string
    Related profile being referenced.
    RelationshipGuidId string
    The relationship guid id.
    RelationshipName string
    The Relationship name.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Cardinality string
    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.Outputs.PropertyDefinitionResponse>
    The properties of the Relationship.
    LookupMappings List<Pulumi.AzureNative.CustomerInsights.Outputs.RelationshipTypeMappingResponse>
    Optional property to be used to map fields in profile to their strong ids in related profile.
    Id string
    Resource ID.
    Name string
    Resource name.
    ProfileType string
    Profile type.
    ProvisioningState string
    Provisioning state.
    RelatedProfileType string
    Related profile being referenced.
    RelationshipGuidId string
    The relationship guid id.
    RelationshipName string
    The Relationship name.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Cardinality string
    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 []PropertyDefinitionResponse
    The properties of the Relationship.
    LookupMappings []RelationshipTypeMappingResponse
    Optional property to be used to map fields in profile to their strong ids in related profile.
    id String
    Resource ID.
    name String
    Resource name.
    profileType String
    Profile type.
    provisioningState String
    Provisioning state.
    relatedProfileType String
    Related profile being referenced.
    relationshipGuidId String
    The relationship guid id.
    relationshipName String
    The Relationship name.
    tenantId String
    The hub name.
    type String
    Resource type.
    cardinality String
    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<PropertyDefinitionResponse>
    The properties of the Relationship.
    lookupMappings List<RelationshipTypeMappingResponse>
    Optional property to be used to map fields in profile to their strong ids in related profile.
    id string
    Resource ID.
    name string
    Resource name.
    profileType string
    Profile type.
    provisioningState string
    Provisioning state.
    relatedProfileType string
    Related profile being referenced.
    relationshipGuidId string
    The relationship guid id.
    relationshipName string
    The Relationship name.
    tenantId string
    The hub name.
    type string
    Resource type.
    cardinality string
    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 PropertyDefinitionResponse[]
    The properties of the Relationship.
    lookupMappings RelationshipTypeMappingResponse[]
    Optional property to be used to map fields in profile to their strong ids in related profile.
    id str
    Resource ID.
    name str
    Resource name.
    profile_type str
    Profile type.
    provisioning_state str
    Provisioning state.
    related_profile_type str
    Related profile being referenced.
    relationship_guid_id str
    The relationship guid id.
    relationship_name str
    The Relationship name.
    tenant_id str
    The hub name.
    type str
    Resource type.
    cardinality str
    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[PropertyDefinitionResponse]
    The properties of the Relationship.
    lookup_mappings Sequence[RelationshipTypeMappingResponse]
    Optional property to be used to map fields in profile to their strong ids in related profile.
    id String
    Resource ID.
    name String
    Resource name.
    profileType String
    Profile type.
    provisioningState String
    Provisioning state.
    relatedProfileType String
    Related profile being referenced.
    relationshipGuidId String
    The relationship guid id.
    relationshipName String
    The Relationship name.
    tenantId String
    The hub name.
    type String
    Resource type.
    cardinality String
    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.

    Supporting Types

    DataSourcePrecedenceResponse

    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.

    ProfileEnumValidValuesFormatResponse

    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.

    PropertyDefinitionResponse

    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.

    RelationshipTypeFieldMappingResponse

    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.

    RelationshipTypeMappingResponse

    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.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.34.0 published on Thursday, Mar 28, 2024 by Pulumi