1. Packages
  2. Azure Native
  3. API Docs
  4. customerinsights
  5. getConnectorMapping
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.46.0 published on Friday, Jun 21, 2024 by Pulumi

azure-native.customerinsights.getConnectorMapping

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.46.0 published on Friday, Jun 21, 2024 by Pulumi

    Gets a connector mapping in the connector. Azure REST API version: 2017-04-26.

    Using getConnectorMapping

    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 getConnectorMapping(args: GetConnectorMappingArgs, opts?: InvokeOptions): Promise<GetConnectorMappingResult>
    function getConnectorMappingOutput(args: GetConnectorMappingOutputArgs, opts?: InvokeOptions): Output<GetConnectorMappingResult>
    def get_connector_mapping(connector_name: Optional[str] = None,
                              hub_name: Optional[str] = None,
                              mapping_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetConnectorMappingResult
    def get_connector_mapping_output(connector_name: Optional[pulumi.Input[str]] = None,
                              hub_name: Optional[pulumi.Input[str]] = None,
                              mapping_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetConnectorMappingResult]
    func LookupConnectorMapping(ctx *Context, args *LookupConnectorMappingArgs, opts ...InvokeOption) (*LookupConnectorMappingResult, error)
    func LookupConnectorMappingOutput(ctx *Context, args *LookupConnectorMappingOutputArgs, opts ...InvokeOption) LookupConnectorMappingResultOutput

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

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

    The following arguments are supported:

    ConnectorName string
    The name of the connector.
    HubName string
    The name of the hub.
    MappingName string
    The name of the connector mapping.
    ResourceGroupName string
    The name of the resource group.
    ConnectorName string
    The name of the connector.
    HubName string
    The name of the hub.
    MappingName string
    The name of the connector mapping.
    ResourceGroupName string
    The name of the resource group.
    connectorName String
    The name of the connector.
    hubName String
    The name of the hub.
    mappingName String
    The name of the connector mapping.
    resourceGroupName String
    The name of the resource group.
    connectorName string
    The name of the connector.
    hubName string
    The name of the hub.
    mappingName string
    The name of the connector mapping.
    resourceGroupName string
    The name of the resource group.
    connector_name str
    The name of the connector.
    hub_name str
    The name of the hub.
    mapping_name str
    The name of the connector mapping.
    resource_group_name str
    The name of the resource group.
    connectorName String
    The name of the connector.
    hubName String
    The name of the hub.
    mappingName String
    The name of the connector mapping.
    resourceGroupName String
    The name of the resource group.

    getConnectorMapping Result

    The following output properties are available:

    ConnectorMappingName string
    The connector mapping name
    ConnectorName string
    The connector name.
    Created string
    The created time.
    DataFormatId string
    The DataFormat ID.
    EntityType string
    Defines which entity type the file should map to.
    EntityTypeName string
    The mapping entity name.
    Id string
    Resource ID.
    LastModified string
    The last modified time.
    MappingProperties Pulumi.AzureNative.CustomerInsights.Outputs.ConnectorMappingPropertiesResponse
    The properties of the mapping.
    Name string
    Resource name.
    NextRunTime string
    The next run time based on customer's settings.
    RunId string
    The RunId.
    State string
    State of connector mapping.
    TenantId string
    The hub name.
    Type string
    Resource type.
    ConnectorType string
    Type of connector.
    Description string
    The description of the connector mapping.
    DisplayName string
    Display name for the connector mapping.
    ConnectorMappingName string
    The connector mapping name
    ConnectorName string
    The connector name.
    Created string
    The created time.
    DataFormatId string
    The DataFormat ID.
    EntityType string
    Defines which entity type the file should map to.
    EntityTypeName string
    The mapping entity name.
    Id string
    Resource ID.
    LastModified string
    The last modified time.
    MappingProperties ConnectorMappingPropertiesResponse
    The properties of the mapping.
    Name string
    Resource name.
    NextRunTime string
    The next run time based on customer's settings.
    RunId string
    The RunId.
    State string
    State of connector mapping.
    TenantId string
    The hub name.
    Type string
    Resource type.
    ConnectorType string
    Type of connector.
    Description string
    The description of the connector mapping.
    DisplayName string
    Display name for the connector mapping.
    connectorMappingName String
    The connector mapping name
    connectorName String
    The connector name.
    created String
    The created time.
    dataFormatId String
    The DataFormat ID.
    entityType String
    Defines which entity type the file should map to.
    entityTypeName String
    The mapping entity name.
    id String
    Resource ID.
    lastModified String
    The last modified time.
    mappingProperties ConnectorMappingPropertiesResponse
    The properties of the mapping.
    name String
    Resource name.
    nextRunTime String
    The next run time based on customer's settings.
    runId String
    The RunId.
    state String
    State of connector mapping.
    tenantId String
    The hub name.
    type String
    Resource type.
    connectorType String
    Type of connector.
    description String
    The description of the connector mapping.
    displayName String
    Display name for the connector mapping.
    connectorMappingName string
    The connector mapping name
    connectorName string
    The connector name.
    created string
    The created time.
    dataFormatId string
    The DataFormat ID.
    entityType string
    Defines which entity type the file should map to.
    entityTypeName string
    The mapping entity name.
    id string
    Resource ID.
    lastModified string
    The last modified time.
    mappingProperties ConnectorMappingPropertiesResponse
    The properties of the mapping.
    name string
    Resource name.
    nextRunTime string
    The next run time based on customer's settings.
    runId string
    The RunId.
    state string
    State of connector mapping.
    tenantId string
    The hub name.
    type string
    Resource type.
    connectorType string
    Type of connector.
    description string
    The description of the connector mapping.
    displayName string
    Display name for the connector mapping.
    connector_mapping_name str
    The connector mapping name
    connector_name str
    The connector name.
    created str
    The created time.
    data_format_id str
    The DataFormat ID.
    entity_type str
    Defines which entity type the file should map to.
    entity_type_name str
    The mapping entity name.
    id str
    Resource ID.
    last_modified str
    The last modified time.
    mapping_properties ConnectorMappingPropertiesResponse
    The properties of the mapping.
    name str
    Resource name.
    next_run_time str
    The next run time based on customer's settings.
    run_id str
    The RunId.
    state str
    State of connector mapping.
    tenant_id str
    The hub name.
    type str
    Resource type.
    connector_type str
    Type of connector.
    description str
    The description of the connector mapping.
    display_name str
    Display name for the connector mapping.
    connectorMappingName String
    The connector mapping name
    connectorName String
    The connector name.
    created String
    The created time.
    dataFormatId String
    The DataFormat ID.
    entityType String
    Defines which entity type the file should map to.
    entityTypeName String
    The mapping entity name.
    id String
    Resource ID.
    lastModified String
    The last modified time.
    mappingProperties Property Map
    The properties of the mapping.
    name String
    Resource name.
    nextRunTime String
    The next run time based on customer's settings.
    runId String
    The RunId.
    state String
    State of connector mapping.
    tenantId String
    The hub name.
    type String
    Resource type.
    connectorType String
    Type of connector.
    description String
    The description of the connector mapping.
    displayName String
    Display name for the connector mapping.

    Supporting Types

    ConnectorMappingAvailabilityResponse

    Interval int
    The interval of the given frequency to use.
    Frequency string
    The frequency to update.
    Interval int
    The interval of the given frequency to use.
    Frequency string
    The frequency to update.
    interval Integer
    The interval of the given frequency to use.
    frequency String
    The frequency to update.
    interval number
    The interval of the given frequency to use.
    frequency string
    The frequency to update.
    interval int
    The interval of the given frequency to use.
    frequency str
    The frequency to update.
    interval Number
    The interval of the given frequency to use.
    frequency String
    The frequency to update.

    ConnectorMappingCompleteOperationResponse

    CompletionOperationType string
    The type of completion operation.
    DestinationFolder string
    The destination folder where files will be moved to once the import is done.
    CompletionOperationType string
    The type of completion operation.
    DestinationFolder string
    The destination folder where files will be moved to once the import is done.
    completionOperationType String
    The type of completion operation.
    destinationFolder String
    The destination folder where files will be moved to once the import is done.
    completionOperationType string
    The type of completion operation.
    destinationFolder string
    The destination folder where files will be moved to once the import is done.
    completion_operation_type str
    The type of completion operation.
    destination_folder str
    The destination folder where files will be moved to once the import is done.
    completionOperationType String
    The type of completion operation.
    destinationFolder String
    The destination folder where files will be moved to once the import is done.

    ConnectorMappingErrorManagementResponse

    ErrorManagementType string
    The type of error management to use for the mapping.
    ErrorLimit int
    The error limit allowed while importing data.
    ErrorManagementType string
    The type of error management to use for the mapping.
    ErrorLimit int
    The error limit allowed while importing data.
    errorManagementType String
    The type of error management to use for the mapping.
    errorLimit Integer
    The error limit allowed while importing data.
    errorManagementType string
    The type of error management to use for the mapping.
    errorLimit number
    The error limit allowed while importing data.
    error_management_type str
    The type of error management to use for the mapping.
    error_limit int
    The error limit allowed while importing data.
    errorManagementType String
    The type of error management to use for the mapping.
    errorLimit Number
    The error limit allowed while importing data.

    ConnectorMappingFormatResponse

    FormatType string
    The type mapping format.
    AcceptLanguage string
    The oData language.
    ArraySeparator string
    Character separating array elements.
    ColumnDelimiter string
    The character that signifies a break between columns.
    QuoteCharacter string
    Quote character, used to indicate enquoted fields.
    QuoteEscapeCharacter string
    Escape character for quotes, can be the same as the quoteCharacter.
    FormatType string
    The type mapping format.
    AcceptLanguage string
    The oData language.
    ArraySeparator string
    Character separating array elements.
    ColumnDelimiter string
    The character that signifies a break between columns.
    QuoteCharacter string
    Quote character, used to indicate enquoted fields.
    QuoteEscapeCharacter string
    Escape character for quotes, can be the same as the quoteCharacter.
    formatType String
    The type mapping format.
    acceptLanguage String
    The oData language.
    arraySeparator String
    Character separating array elements.
    columnDelimiter String
    The character that signifies a break between columns.
    quoteCharacter String
    Quote character, used to indicate enquoted fields.
    quoteEscapeCharacter String
    Escape character for quotes, can be the same as the quoteCharacter.
    formatType string
    The type mapping format.
    acceptLanguage string
    The oData language.
    arraySeparator string
    Character separating array elements.
    columnDelimiter string
    The character that signifies a break between columns.
    quoteCharacter string
    Quote character, used to indicate enquoted fields.
    quoteEscapeCharacter string
    Escape character for quotes, can be the same as the quoteCharacter.
    format_type str
    The type mapping format.
    accept_language str
    The oData language.
    array_separator str
    Character separating array elements.
    column_delimiter str
    The character that signifies a break between columns.
    quote_character str
    Quote character, used to indicate enquoted fields.
    quote_escape_character str
    Escape character for quotes, can be the same as the quoteCharacter.
    formatType String
    The type mapping format.
    acceptLanguage String
    The oData language.
    arraySeparator String
    Character separating array elements.
    columnDelimiter String
    The character that signifies a break between columns.
    quoteCharacter String
    Quote character, used to indicate enquoted fields.
    quoteEscapeCharacter String
    Escape character for quotes, can be the same as the quoteCharacter.

    ConnectorMappingPropertiesResponse

    Availability Pulumi.AzureNative.CustomerInsights.Inputs.ConnectorMappingAvailabilityResponse
    The availability of mapping property.
    CompleteOperation Pulumi.AzureNative.CustomerInsights.Inputs.ConnectorMappingCompleteOperationResponse
    The operation after import is done.
    ErrorManagement Pulumi.AzureNative.CustomerInsights.Inputs.ConnectorMappingErrorManagementResponse
    The error management setting for the mapping.
    Format Pulumi.AzureNative.CustomerInsights.Inputs.ConnectorMappingFormatResponse
    The format of mapping property.
    Structure List<Pulumi.AzureNative.CustomerInsights.Inputs.ConnectorMappingStructureResponse>
    Ingestion mapping information at property level.
    FileFilter string
    The file filter for the mapping.
    FolderPath string
    The folder path for the mapping.
    HasHeader bool
    If the file contains a header or not.
    Availability ConnectorMappingAvailabilityResponse
    The availability of mapping property.
    CompleteOperation ConnectorMappingCompleteOperationResponse
    The operation after import is done.
    ErrorManagement ConnectorMappingErrorManagementResponse
    The error management setting for the mapping.
    Format ConnectorMappingFormatResponse
    The format of mapping property.
    Structure []ConnectorMappingStructureResponse
    Ingestion mapping information at property level.
    FileFilter string
    The file filter for the mapping.
    FolderPath string
    The folder path for the mapping.
    HasHeader bool
    If the file contains a header or not.
    availability ConnectorMappingAvailabilityResponse
    The availability of mapping property.
    completeOperation ConnectorMappingCompleteOperationResponse
    The operation after import is done.
    errorManagement ConnectorMappingErrorManagementResponse
    The error management setting for the mapping.
    format ConnectorMappingFormatResponse
    The format of mapping property.
    structure List<ConnectorMappingStructureResponse>
    Ingestion mapping information at property level.
    fileFilter String
    The file filter for the mapping.
    folderPath String
    The folder path for the mapping.
    hasHeader Boolean
    If the file contains a header or not.
    availability ConnectorMappingAvailabilityResponse
    The availability of mapping property.
    completeOperation ConnectorMappingCompleteOperationResponse
    The operation after import is done.
    errorManagement ConnectorMappingErrorManagementResponse
    The error management setting for the mapping.
    format ConnectorMappingFormatResponse
    The format of mapping property.
    structure ConnectorMappingStructureResponse[]
    Ingestion mapping information at property level.
    fileFilter string
    The file filter for the mapping.
    folderPath string
    The folder path for the mapping.
    hasHeader boolean
    If the file contains a header or not.
    availability ConnectorMappingAvailabilityResponse
    The availability of mapping property.
    complete_operation ConnectorMappingCompleteOperationResponse
    The operation after import is done.
    error_management ConnectorMappingErrorManagementResponse
    The error management setting for the mapping.
    format ConnectorMappingFormatResponse
    The format of mapping property.
    structure Sequence[ConnectorMappingStructureResponse]
    Ingestion mapping information at property level.
    file_filter str
    The file filter for the mapping.
    folder_path str
    The folder path for the mapping.
    has_header bool
    If the file contains a header or not.
    availability Property Map
    The availability of mapping property.
    completeOperation Property Map
    The operation after import is done.
    errorManagement Property Map
    The error management setting for the mapping.
    format Property Map
    The format of mapping property.
    structure List<Property Map>
    Ingestion mapping information at property level.
    fileFilter String
    The file filter for the mapping.
    folderPath String
    The folder path for the mapping.
    hasHeader Boolean
    If the file contains a header or not.

    ConnectorMappingStructureResponse

    ColumnName string
    The column name of the import file.
    PropertyName string
    The property name of the mapping entity.
    CustomFormatSpecifier string
    Custom format specifier for input parsing.
    IsEncrypted bool
    Indicates if the column is encrypted.
    ColumnName string
    The column name of the import file.
    PropertyName string
    The property name of the mapping entity.
    CustomFormatSpecifier string
    Custom format specifier for input parsing.
    IsEncrypted bool
    Indicates if the column is encrypted.
    columnName String
    The column name of the import file.
    propertyName String
    The property name of the mapping entity.
    customFormatSpecifier String
    Custom format specifier for input parsing.
    isEncrypted Boolean
    Indicates if the column is encrypted.
    columnName string
    The column name of the import file.
    propertyName string
    The property name of the mapping entity.
    customFormatSpecifier string
    Custom format specifier for input parsing.
    isEncrypted boolean
    Indicates if the column is encrypted.
    column_name str
    The column name of the import file.
    property_name str
    The property name of the mapping entity.
    custom_format_specifier str
    Custom format specifier for input parsing.
    is_encrypted bool
    Indicates if the column is encrypted.
    columnName String
    The column name of the import file.
    propertyName String
    The property name of the mapping entity.
    customFormatSpecifier String
    Custom format specifier for input parsing.
    isEncrypted Boolean
    Indicates if the column is encrypted.

    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.46.0 published on Friday, Jun 21, 2024 by Pulumi