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

azure-native.customerinsights.getLink

Explore with Pulumi AI

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

    Gets a link in the hub.

    Uses Azure REST API version 2017-04-26.

    Using getLink

    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 getLink(args: GetLinkArgs, opts?: InvokeOptions): Promise<GetLinkResult>
function getLinkOutput(args: GetLinkOutputArgs, opts?: InvokeOptions): Output<GetLinkResult>
    def get_link(hub_name: Optional[str] = None,
             link_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetLinkResult
def get_link_output(hub_name: Optional[pulumi.Input[str]] = None,
             link_name: Optional[pulumi.Input[str]] = None,
             resource_group_name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetLinkResult]
    func LookupLink(ctx *Context, args *LookupLinkArgs, opts ...InvokeOption) (*LookupLinkResult, error)
func LookupLinkOutput(ctx *Context, args *LookupLinkOutputArgs, opts ...InvokeOption) LookupLinkResultOutput

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

    public static class GetLink 
{
    public static Task<GetLinkResult> InvokeAsync(GetLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetLinkResult> Invoke(GetLinkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)
public static Output<GetLinkResult> getLink(GetLinkArgs args, InvokeOptions options)

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

    The following arguments are supported:

    HubName string
    The name of the hub.
    LinkName string
    The name of the link.
    ResourceGroupName string
    The name of the resource group.
    HubName string
    The name of the hub.
    LinkName string
    The name of the link.
    ResourceGroupName string
    The name of the resource group.
    hubName String
    The name of the hub.
    linkName String
    The name of the link.
    resourceGroupName String
    The name of the resource group.
    hubName string
    The name of the hub.
    linkName string
    The name of the link.
    resourceGroupName string
    The name of the resource group.
    hub_name str
    The name of the hub.
    link_name str
    The name of the link.
    resource_group_name str
    The name of the resource group.
    hubName String
    The name of the hub.
    linkName String
    The name of the link.
    resourceGroupName String
    The name of the resource group.

    getLink Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    LinkName string
    The link name.
    Name string
    Resource name.
    ParticipantPropertyReferences List<Pulumi.AzureNative.CustomerInsights.Outputs.ParticipantPropertyReferenceResponse>
    The properties that represent the participating profile.
    ProvisioningState string
    Provisioning state.
    SourceEntityType string
    Type of source entity.
    SourceEntityTypeName string
    Name of the source Entity Type.
    TargetEntityType string
    Type of target entity.
    TargetEntityTypeName string
    Name of the target Entity Type.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description Dictionary<string, string>
    Localized descriptions for the Link.
    DisplayName Dictionary<string, string>
    Localized display name for the Link.
    Mappings List<Pulumi.AzureNative.CustomerInsights.Outputs.TypePropertiesMappingResponse>
    The set of properties mappings between the source and target Types.
    OperationType string
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    ReferenceOnly bool
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID.
    LinkName string
    The link name.
    Name string
    Resource name.
    ParticipantPropertyReferences []ParticipantPropertyReferenceResponse
    The properties that represent the participating profile.
    ProvisioningState string
    Provisioning state.
    SourceEntityType string
    Type of source entity.
    SourceEntityTypeName string
    Name of the source Entity Type.
    TargetEntityType string
    Type of target entity.
    TargetEntityTypeName string
    Name of the target Entity Type.
    TenantId string
    The hub name.
    Type string
    Resource type.
    Description map[string]string
    Localized descriptions for the Link.
    DisplayName map[string]string
    Localized display name for the Link.
    Mappings []TypePropertiesMappingResponse
    The set of properties mappings between the source and target Types.
    OperationType string
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    ReferenceOnly bool
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    linkName String
    The link name.
    name String
    Resource name.
    participantPropertyReferences List<ParticipantPropertyReferenceResponse>
    The properties that represent the participating profile.
    provisioningState String
    Provisioning state.
    sourceEntityType String
    Type of source entity.
    sourceEntityTypeName String
    Name of the source Entity Type.
    targetEntityType String
    Type of target entity.
    targetEntityTypeName String
    Name of the target Entity Type.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String,String>
    Localized descriptions for the Link.
    displayName Map<String,String>
    Localized display name for the Link.
    mappings List<TypePropertiesMappingResponse>
    The set of properties mappings between the source and target Types.
    operationType String
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    referenceOnly Boolean
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID.
    linkName string
    The link name.
    name string
    Resource name.
    participantPropertyReferences ParticipantPropertyReferenceResponse[]
    The properties that represent the participating profile.
    provisioningState string
    Provisioning state.
    sourceEntityType string
    Type of source entity.
    sourceEntityTypeName string
    Name of the source Entity Type.
    targetEntityType string
    Type of target entity.
    targetEntityTypeName string
    Name of the target Entity Type.
    tenantId string
    The hub name.
    type string
    Resource type.
    description {[key: string]: string}
    Localized descriptions for the Link.
    displayName {[key: string]: string}
    Localized display name for the Link.
    mappings TypePropertiesMappingResponse[]
    The set of properties mappings between the source and target Types.
    operationType string
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    referenceOnly boolean
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID.
    link_name str
    The link name.
    name str
    Resource name.
    participant_property_references Sequence[ParticipantPropertyReferenceResponse]
    The properties that represent the participating profile.
    provisioning_state str
    Provisioning state.
    source_entity_type str
    Type of source entity.
    source_entity_type_name str
    Name of the source Entity Type.
    target_entity_type str
    Type of target entity.
    target_entity_type_name str
    Name of the target Entity Type.
    tenant_id str
    The hub name.
    type str
    Resource type.
    description Mapping[str, str]
    Localized descriptions for the Link.
    display_name Mapping[str, str]
    Localized display name for the Link.
    mappings Sequence[TypePropertiesMappingResponse]
    The set of properties mappings between the source and target Types.
    operation_type str
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    reference_only bool
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID.
    linkName String
    The link name.
    name String
    Resource name.
    participantPropertyReferences List<Property Map>
    The properties that represent the participating profile.
    provisioningState String
    Provisioning state.
    sourceEntityType String
    Type of source entity.
    sourceEntityTypeName String
    Name of the source Entity Type.
    targetEntityType String
    Type of target entity.
    targetEntityTypeName String
    Name of the target Entity Type.
    tenantId String
    The hub name.
    type String
    Resource type.
    description Map<String>
    Localized descriptions for the Link.
    displayName Map<String>
    Localized display name for the Link.
    mappings List<Property Map>
    The set of properties mappings between the source and target Types.
    operationType String
    Determines whether this link is supposed to create or delete instances if Link is NOT Reference Only.
    referenceOnly Boolean
    Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles.

    Supporting Types

    ParticipantPropertyReferenceResponse

    SourcePropertyName string
    The source property that maps to the target property.
    TargetPropertyName string
    The target property that maps to the source property.
    SourcePropertyName string
    The source property that maps to the target property.
    TargetPropertyName string
    The target property that maps to the source property.
    sourcePropertyName String
    The source property that maps to the target property.
    targetPropertyName String
    The target property that maps to the source property.
    sourcePropertyName string
    The source property that maps to the target property.
    targetPropertyName string
    The target property that maps to the source property.
    source_property_name str
    The source property that maps to the target property.
    target_property_name str
    The target property that maps to the source property.
    sourcePropertyName String
    The source property that maps to the target property.
    targetPropertyName String
    The target property that maps to the source property.

    TypePropertiesMappingResponse

    SourcePropertyName string
    Property name on the source Entity Type.
    TargetPropertyName string
    Property name on the target Entity Type.
    LinkType string
    Link type.
    SourcePropertyName string
    Property name on the source Entity Type.
    TargetPropertyName string
    Property name on the target Entity Type.
    LinkType string
    Link type.
    sourcePropertyName String
    Property name on the source Entity Type.
    targetPropertyName String
    Property name on the target Entity Type.
    linkType String
    Link type.
    sourcePropertyName string
    Property name on the source Entity Type.
    targetPropertyName string
    Property name on the target Entity Type.
    linkType string
    Link type.
    source_property_name str
    Property name on the source Entity Type.
    target_property_name str
    Property name on the target Entity Type.
    link_type str
    Link type.
    sourcePropertyName String
    Property name on the source Entity Type.
    targetPropertyName String
    Property name on the target Entity Type.
    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 v2 docs if using the v2 version of this package.
    Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-azure-native