Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. getRelationshipLink
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.customerinsights.getRelationshipLink

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

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

    Other available API versions: 2017-01-01.

    Using getRelationshipLink

    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 getRelationshipLink(args: GetRelationshipLinkArgs, opts?: InvokeOptions): Promise<GetRelationshipLinkResult>
function getRelationshipLinkOutput(args: GetRelationshipLinkOutputArgs, opts?: InvokeOptions): Output<GetRelationshipLinkResult>
    def get_relationship_link(hub_name: Optional[str] = None,
                          relationship_link_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRelationshipLinkResult
def get_relationship_link_output(hub_name: Optional[pulumi.Input[str]] = None,
                          relationship_link_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRelationshipLinkResult]
    func LookupRelationshipLink(ctx *Context, args *LookupRelationshipLinkArgs, opts ...InvokeOption) (*LookupRelationshipLinkResult, error)
func LookupRelationshipLinkOutput(ctx *Context, args *LookupRelationshipLinkOutputArgs, opts ...InvokeOption) LookupRelationshipLinkResultOutput

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

    public static class GetRelationshipLink 
{
    public static Task<GetRelationshipLinkResult> InvokeAsync(GetRelationshipLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetRelationshipLinkResult> Invoke(GetRelationshipLinkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRelationshipLinkResult> getRelationshipLink(GetRelationshipLinkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:customerinsights:getRelationshipLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HubName string
    The name of the hub.
    RelationshipLinkName string
    The name of the relationship link.
    ResourceGroupName string
    The name of the resource group.
    HubName string
    The name of the hub.
    RelationshipLinkName string
    The name of the relationship link.
    ResourceGroupName string
    The name of the resource group.
    hubName String
    The name of the hub.
    relationshipLinkName String
    The name of the relationship link.
    resourceGroupName String
    The name of the resource group.
    hubName string
    The name of the hub.
    relationshipLinkName string
    The name of the relationship link.
    resourceGroupName string
    The name of the resource group.
    hub_name str
    The name of the hub.
    relationship_link_name str
    The name of the relationship link.
    resource_group_name str
    The name of the resource group.
    hubName String
    The name of the hub.
    relationshipLinkName String
    The name of the relationship link.
    resourceGroupName String
    The name of the resource group.

    getRelationshipLink Result

    The following output properties are available:

    Id string
    Resource ID.
    InteractionType string
    The InteractionType associated with the Relationship Link.
    LinkName string
    The name of the Relationship Link.
    Name string
    Resource name.
    ProfilePropertyReferences List<Pulumi.AzureNative.CustomerInsights.Outputs.ParticipantProfilePropertyReferenceResponse>
    The property references for the Profile of the Relationship.
    ProvisioningState string
    Provisioning state.
    RelatedProfilePropertyReferences List<Pulumi.AzureNative.CustomerInsights.Outputs.ParticipantProfilePropertyReferenceResponse>
    The property references for the Related Profile of the Relationship.
    RelationshipGuidId string
    The relationship guid id.
    RelationshipName string
    The Relationship associated with the Link.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description Dictionary<string, string>
    Localized descriptions for the Relationship Link.
    DisplayName Dictionary<string, string>
    Localized display name for the Relationship Link.
    Mappings List<Pulumi.AzureNative.CustomerInsights.Outputs.RelationshipLinkFieldMappingResponse>
    The mappings between Interaction and Relationship fields.
    Id string
    Resource ID.
    InteractionType string
    The InteractionType associated with the Relationship Link.
    LinkName string
    The name of the Relationship Link.
    Name string
    Resource name.
    ProfilePropertyReferences []ParticipantProfilePropertyReferenceResponse
    The property references for the Profile of the Relationship.
    ProvisioningState string
    Provisioning state.
    RelatedProfilePropertyReferences []ParticipantProfilePropertyReferenceResponse
    The property references for the Related Profile of the Relationship.
    RelationshipGuidId string
    The relationship guid id.
    RelationshipName string
    The Relationship associated with the Link.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description map[string]string
    Localized descriptions for the Relationship Link.
    DisplayName map[string]string
    Localized display name for the Relationship Link.
    Mappings []RelationshipLinkFieldMappingResponse
    The mappings between Interaction and Relationship fields.
    id String
    Resource ID.
    interactionType String
    The InteractionType associated with the Relationship Link.
    linkName String
    The name of the Relationship Link.
    name String
    Resource name.
    profilePropertyReferences List<ParticipantProfilePropertyReferenceResponse>
    The property references for the Profile of the Relationship.
    provisioningState String
    Provisioning state.
    relatedProfilePropertyReferences List<ParticipantProfilePropertyReferenceResponse>
    The property references for the Related Profile of the Relationship.
    relationshipGuidId String
    The relationship guid id.
    relationshipName String
    The Relationship associated with the Link.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String,String>
    Localized descriptions for the Relationship Link.
    displayName Map<String,String>
    Localized display name for the Relationship Link.
    mappings List<RelationshipLinkFieldMappingResponse>
    The mappings between Interaction and Relationship fields.
    id string
    Resource ID.
    interactionType string
    The InteractionType associated with the Relationship Link.
    linkName string
    The name of the Relationship Link.
    name string
    Resource name.
    profilePropertyReferences ParticipantProfilePropertyReferenceResponse[]
    The property references for the Profile of the Relationship.
    provisioningState string
    Provisioning state.
    relatedProfilePropertyReferences ParticipantProfilePropertyReferenceResponse[]
    The property references for the Related Profile of the Relationship.
    relationshipGuidId string
    The relationship guid id.
    relationshipName string
    The Relationship associated with the Link.
    tenantId string
    The hub name.
    type string
    Resource type.
    description {[key: string]: string}
    Localized descriptions for the Relationship Link.
    displayName {[key: string]: string}
    Localized display name for the Relationship Link.
    mappings RelationshipLinkFieldMappingResponse[]
    The mappings between Interaction and Relationship fields.
    id str
    Resource ID.
    interaction_type str
    The InteractionType associated with the Relationship Link.
    link_name str
    The name of the Relationship Link.
    name str
    Resource name.
    profile_property_references Sequence[ParticipantProfilePropertyReferenceResponse]
    The property references for the Profile of the Relationship.
    provisioning_state str
    Provisioning state.
    related_profile_property_references Sequence[ParticipantProfilePropertyReferenceResponse]
    The property references for the Related Profile of the Relationship.
    relationship_guid_id str
    The relationship guid id.
    relationship_name str
    The Relationship associated with the Link.
    tenant_id str
    The hub name.
    type str
    Resource type.
    description Mapping[str, str]
    Localized descriptions for the Relationship Link.
    display_name Mapping[str, str]
    Localized display name for the Relationship Link.
    mappings Sequence[RelationshipLinkFieldMappingResponse]
    The mappings between Interaction and Relationship fields.
    id String
    Resource ID.
    interactionType String
    The InteractionType associated with the Relationship Link.
    linkName String
    The name of the Relationship Link.
    name String
    Resource name.
    profilePropertyReferences List<Property Map>
    The property references for the Profile of the Relationship.
    provisioningState String
    Provisioning state.
    relatedProfilePropertyReferences List<Property Map>
    The property references for the Related Profile of the Relationship.
    relationshipGuidId String
    The relationship guid id.
    relationshipName String
    The Relationship associated with the Link.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String>
    Localized descriptions for the Relationship Link.
    displayName Map<String>
    Localized display name for the Relationship Link.
    mappings List<Property Map>
    The mappings between Interaction and Relationship fields.

    Supporting Types

    ParticipantProfilePropertyReferenceResponse

    InteractionPropertyName string
    The source interaction property that maps to the target profile property.
    ProfilePropertyName string
    The target profile property that maps to the source interaction property.
    InteractionPropertyName string
    The source interaction property that maps to the target profile property.
    ProfilePropertyName string
    The target profile property that maps to the source interaction property.
    interactionPropertyName String
    The source interaction property that maps to the target profile property.
    profilePropertyName String
    The target profile property that maps to the source interaction property.
    interactionPropertyName string
    The source interaction property that maps to the target profile property.
    profilePropertyName string
    The target profile property that maps to the source interaction property.
    interaction_property_name str
    The source interaction property that maps to the target profile property.
    profile_property_name str
    The target profile property that maps to the source interaction property.
    interactionPropertyName String
    The source interaction property that maps to the target profile property.
    profilePropertyName String
    The target profile property that maps to the source interaction property.

    RelationshipLinkFieldMappingResponse

    InteractionFieldName string
    The field name on the Interaction Type.
    RelationshipFieldName string
    The field name on the Relationship metadata.
    LinkType string
    Link type.
    InteractionFieldName string
    The field name on the Interaction Type.
    RelationshipFieldName string
    The field name on the Relationship metadata.
    LinkType string
    Link type.
    interactionFieldName String
    The field name on the Interaction Type.
    relationshipFieldName String
    The field name on the Relationship metadata.
    linkType String
    Link type.
    interactionFieldName string
    The field name on the Interaction Type.
    relationshipFieldName string
    The field name on the Relationship metadata.
    linkType string
    Link type.
    interaction_field_name str
    The field name on the Interaction Type.
    relationship_field_name str
    The field name on the Relationship metadata.
    link_type str
    Link type.
    interactionFieldName String
    The field name on the Interaction Type.
    relationshipFieldName String
    The field name on the Relationship metadata.
    linkType String
    Link type.

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native