Hubs/conectores/mapeamentos do Microsoft.CustomerInsights

Definição de recursos do bíceps

O tipo de recurso hubs/conectores/mapeamentos pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.CustomerInsights/hubs/connectors/mappings, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.CustomerInsights/hubs/connectors/mappings@2017-04-26' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    connectorType: 'string'
    description: 'string'
    displayName: 'string'
    entityType: 'string'
    entityTypeName: 'string'
    mappingProperties: {
      availability: {
        frequency: 'string'
        interval: int
      }
      completeOperation: {
        completionOperationType: 'string'
        destinationFolder: 'string'
      }
      errorManagement: {
        errorLimit: int
        errorManagementType: 'string'
      }
      fileFilter: 'string'
      folderPath: 'string'
      format: {
        acceptLanguage: 'string'
        arraySeparator: 'string'
        columnDelimiter: 'string'
        formatType: 'TextFormat'
        quoteCharacter: 'string'
        quoteEscapeCharacter: 'string'
      }
      hasHeader: bool
      structure: [
        {
          columnName: 'string'
          customFormatSpecifier: 'string'
          isEncrypted: bool
          propertyName: 'string'
        }
      ]
    }
  }
}

Valores de propriedade

Microsoft.CustomerInsights/hubs/conectores/mapeamentos

Designação Descrição Valor
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128
Padrão = ^[a-zA-Z][a-zA-Z0-9_]+$ (obrigatório)
elemento principal No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.
Nome simbólico para recurso do tipo: hubs/conectores
propriedades A definição de mapeamento do conector. Mapeamento de conectores

Mapeamento de conectores

Designação Descrição Valor
Tipo de conector Tipo de conector. 'AzureBlob'
'CRM'
'ExchangeOnline'
'Nenhuma'
'Saída'
'Salesforce'
Descrição A descrição do mapeamento do conector. cadeia (de caracteres)
nome de exibição Nome de exibição para o mapeamento do conector. cadeia (de caracteres)
tipo de entidade Define para qual tipo de entidade o arquivo deve ser mapeado. 'Interação'
'Nenhuma'
'Perfil'
'Relacionamento' (obrigatório)
entityTypeName O nome da entidade de mapeamento. string (obrigatório)
mapeamentoPropriedades As propriedades do mapeamento. ConnectorMappingProperties (obrigatório)

ConnectorMappingDisponibilidade

Designação Descrição Valor
frequência A frequência de atualização. 'Dia'
'Hora'
'Minuto'
'Mês'
'Semana'
intervalo O intervalo da frequência dada a utilizar. int (obrigatório)

ConnectorMappingCompleteOperation

Designação Descrição Valor
completionOperationType O tipo de operação de conclusão. 'DeleteFile'
'DoNothing'
'MoveFile'
destinationFolder A pasta de destino para onde os arquivos serão movidos assim que a importação for concluída. cadeia (de caracteres)

ConnectorMappingErrorManagement

Designação Descrição Valor
errorLimit O limite de erro permitido durante a importação de dados. Int
errorManagementType O tipo de gerenciamento de erros a ser usado para o mapeamento. 'Rejeitar e continuar'
'RejectUntilLimit'
'StopImport' (obrigatório)

ConnectorMappingFormat

Designação Descrição Valor
aceitarLíngua A linguagem oData. cadeia (de caracteres)
arraySeparator Caracteres que separam elementos de matriz. cadeia (de caracteres)
columnDelimiter O caractere que significa uma quebra entre colunas. cadeia (de caracteres)
formatType O formato de mapeamento de tipo. 'TextFormat' (obrigatório)
quoteCharacter Caractere de aspas, usado para indicar campos entre aspas. cadeia (de caracteres)
quoteEscapeCharacter Caractere de escape para aspas, pode ser o mesmo que o quoteCharacter. cadeia (de caracteres)

ConnectorMappingProperties

Designação Descrição Valor
disponibilidade A disponibilidade da propriedade de mapeamento. ConnectorMappingAvailability (obrigatório)
completeOperation A operação após a importação é feita. ConnectorMappingCompleteOperation (obrigatório)
Gestão de erros A configuração de gerenciamento de erros para o mapeamento. ConnectorMappingErrorManagement (obrigatório)
fileFilter O filtro de arquivo para o mapeamento. cadeia (de caracteres)
folderPath O caminho da pasta para o mapeamento. cadeia (de caracteres)
Formato O formato da propriedade de mapeamento. ConnectorMappingFormat (obrigatório)
hasHeader Se o arquivo contém um cabeçalho ou não. Bool
estrutura Informações de mapeamento de ingestão no nível da propriedade. ConnectorMappingStructure[] (obrigatório)

ConnectorMappingStructure

Designação Descrição Valor
nomeDaColuna O nome da coluna do arquivo de importação. string (obrigatório)
customFormatSpecifier Especificador de formato personalizado para análise de entrada. cadeia (de caracteres)
éEncriptado Indica se a coluna está criptografada. Bool
nomeDaPropriedade O nome da propriedade da entidade de mapeamento. string (obrigatório)

Definição de recurso de modelo ARM

O tipo de recurso hubs/conectores/mapeamentos pode ser implantado com operações que visam:

Exemplos de uso

Formato do recurso

Para criar um recurso Microsoft.CustomerInsights/hubs/connectors/mappings, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.CustomerInsights/hubs/connectors/mappings",
  "apiVersion": "2017-04-26",
  "name": "string",
  "properties": {
    "connectorType": "string",
    "description": "string",
    "displayName": "string",
    "entityType": "string",
    "entityTypeName": "string",
    "mappingProperties": {
      "availability": {
        "frequency": "string",
        "interval": "int"
      },
      "completeOperation": {
        "completionOperationType": "string",
        "destinationFolder": "string"
      },
      "errorManagement": {
        "errorLimit": "int",
        "errorManagementType": "string"
      },
      "fileFilter": "string",
      "folderPath": "string",
      "format": {
        "acceptLanguage": "string",
        "arraySeparator": "string",
        "columnDelimiter": "string",
        "formatType": "TextFormat",
        "quoteCharacter": "string",
        "quoteEscapeCharacter": "string"
      },
      "hasHeader": "bool",
      "structure": [
        {
          "columnName": "string",
          "customFormatSpecifier": "string",
          "isEncrypted": "bool",
          "propertyName": "string"
        }
      ]
    }
  }
}

Valores de propriedade

Microsoft.CustomerInsights/hubs/conectores/mapeamentos

Designação Descrição Valor
Versão da API A versão api '2017-04-26'
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128
Padrão = ^[a-zA-Z][a-zA-Z0-9_]+$ (obrigatório)
propriedades A definição de mapeamento do conector. Mapeamento de conectores
tipo O tipo de recurso 'Microsoft.CustomerInsights/hubs/conectores/mapeamentos'

Mapeamento de conectores

Designação Descrição Valor
Tipo de conector Tipo de conector. 'AzureBlob'
'CRM'
'ExchangeOnline'
'Nenhuma'
'Saída'
'Salesforce'
Descrição A descrição do mapeamento do conector. cadeia (de caracteres)
nome de exibição Nome de exibição para o mapeamento do conector. cadeia (de caracteres)
tipo de entidade Define para qual tipo de entidade o arquivo deve ser mapeado. 'Interação'
'Nenhuma'
'Perfil'
'Relacionamento' (obrigatório)
entityTypeName O nome da entidade de mapeamento. string (obrigatório)
mapeamentoPropriedades As propriedades do mapeamento. ConnectorMappingProperties (obrigatório)

ConnectorMappingDisponibilidade

Designação Descrição Valor
frequência A frequência de atualização. 'Dia'
'Hora'
'Minuto'
'Mês'
'Semana'
intervalo O intervalo da frequência dada a utilizar. int (obrigatório)

ConnectorMappingCompleteOperation

Designação Descrição Valor
completionOperationType O tipo de operação de conclusão. 'DeleteFile'
'DoNothing'
'MoveFile'
destinationFolder A pasta de destino para onde os arquivos serão movidos assim que a importação for concluída. cadeia (de caracteres)

ConnectorMappingErrorManagement

Designação Descrição Valor
errorLimit O limite de erro permitido durante a importação de dados. Int
errorManagementType O tipo de gerenciamento de erros a ser usado para o mapeamento. 'Rejeitar e continuar'
'RejectUntilLimit'
'StopImport' (obrigatório)

ConnectorMappingFormat

Designação Descrição Valor
aceitarLíngua A linguagem oData. cadeia (de caracteres)
arraySeparator Caracteres que separam elementos de matriz. cadeia (de caracteres)
columnDelimiter O caractere que significa uma quebra entre colunas. cadeia (de caracteres)
formatType O formato de mapeamento de tipo. 'TextFormat' (obrigatório)
quoteCharacter Caractere de aspas, usado para indicar campos entre aspas. cadeia (de caracteres)
quoteEscapeCharacter Caractere de escape para aspas, pode ser o mesmo que o quoteCharacter. cadeia (de caracteres)

ConnectorMappingProperties

Designação Descrição Valor
disponibilidade A disponibilidade da propriedade de mapeamento. ConnectorMappingAvailability (obrigatório)
completeOperation A operação após a importação é feita. ConnectorMappingCompleteOperation (obrigatório)
Gestão de erros A configuração de gerenciamento de erros para o mapeamento. ConnectorMappingErrorManagement (obrigatório)
fileFilter O filtro de arquivo para o mapeamento. cadeia (de caracteres)
folderPath O caminho da pasta para o mapeamento. cadeia (de caracteres)
Formato O formato da propriedade de mapeamento. ConnectorMappingFormat (obrigatório)
hasHeader Se o arquivo contém um cabeçalho ou não. Bool
estrutura Informações de mapeamento de ingestão no nível da propriedade. ConnectorMappingStructure[] (obrigatório)

ConnectorMappingStructure

Designação Descrição Valor
nomeDaColuna O nome da coluna do arquivo de importação. string (obrigatório)
customFormatSpecifier Especificador de formato personalizado para análise de entrada. cadeia (de caracteres)
éEncriptado Indica se a coluna está criptografada. Bool
nomeDaPropriedade O nome da propriedade da entidade de mapeamento. string (obrigatório)

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso hubs/conectores/mapeamentos pode ser implantado com operações que visam:

  • Grupos de recursos Para uma lista das propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.CustomerInsights/hubs/connectors/mappings, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.CustomerInsights/hubs/connectors/mappings@2017-04-26"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      connectorType = "string"
      description = "string"
      displayName = "string"
      entityType = "string"
      entityTypeName = "string"
      mappingProperties = {
        availability = {
          frequency = "string"
          interval = int
        }
        completeOperation = {
          completionOperationType = "string"
          destinationFolder = "string"
        }
        errorManagement = {
          errorLimit = int
          errorManagementType = "string"
        }
        fileFilter = "string"
        folderPath = "string"
        format = {
          acceptLanguage = "string"
          arraySeparator = "string"
          columnDelimiter = "string"
          formatType = "TextFormat"
          quoteCharacter = "string"
          quoteEscapeCharacter = "string"
        }
        hasHeader = bool
        structure = [
          {
            columnName = "string"
            customFormatSpecifier = "string"
            isEncrypted = bool
            propertyName = "string"
          }
        ]
      }
    }
  }
}

Valores de propriedade

Microsoft.CustomerInsights/hubs/conectores/mapeamentos

Designação Descrição Valor
Designação O nome do recurso cadeia de caracteres

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 128
Padrão = ^[a-zA-Z][a-zA-Z0-9_]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID para recurso do tipo: hubs/conectores
propriedades A definição de mapeamento do conector. Mapeamento de conectores
tipo O tipo de recurso "Microsoft.CustomerInsights/hubs/connectors/mappings@2017-04-26"

Mapeamento de conectores

Designação Descrição Valor
Tipo de conector Tipo de conector. 'AzureBlob'
'CRM'
'ExchangeOnline'
'Nenhuma'
'Saída'
'Salesforce'
Descrição A descrição do mapeamento do conector. cadeia (de caracteres)
nome de exibição Nome de exibição para o mapeamento do conector. cadeia (de caracteres)
tipo de entidade Define para qual tipo de entidade o arquivo deve ser mapeado. 'Interação'
'Nenhuma'
'Perfil'
'Relacionamento' (obrigatório)
entityTypeName O nome da entidade de mapeamento. string (obrigatório)
mapeamentoPropriedades As propriedades do mapeamento. ConnectorMappingProperties (obrigatório)

ConnectorMappingDisponibilidade

Designação Descrição Valor
frequência A frequência de atualização. 'Dia'
'Hora'
'Minuto'
'Mês'
'Semana'
intervalo O intervalo da frequência dada a utilizar. int (obrigatório)

ConnectorMappingCompleteOperation

Designação Descrição Valor
completionOperationType O tipo de operação de conclusão. 'DeleteFile'
'DoNothing'
'MoveFile'
destinationFolder A pasta de destino para onde os arquivos serão movidos assim que a importação for concluída. cadeia (de caracteres)

ConnectorMappingErrorManagement

Designação Descrição Valor
errorLimit O limite de erro permitido durante a importação de dados. Int
errorManagementType O tipo de gerenciamento de erros a ser usado para o mapeamento. 'Rejeitar e continuar'
'RejectUntilLimit'
'StopImport' (obrigatório)

ConnectorMappingFormat

Designação Descrição Valor
aceitarLíngua A linguagem oData. cadeia (de caracteres)
arraySeparator Caracteres que separam elementos de matriz. cadeia (de caracteres)
columnDelimiter O caractere que significa uma quebra entre colunas. cadeia (de caracteres)
formatType O formato de mapeamento de tipo. 'TextFormat' (obrigatório)
quoteCharacter Caractere de aspas, usado para indicar campos entre aspas. cadeia (de caracteres)
quoteEscapeCharacter Caractere de escape para aspas, pode ser o mesmo que o quoteCharacter. cadeia (de caracteres)

ConnectorMappingProperties

Designação Descrição Valor
disponibilidade A disponibilidade da propriedade de mapeamento. ConnectorMappingAvailability (obrigatório)
completeOperation A operação após a importação é feita. ConnectorMappingCompleteOperation (obrigatório)
Gestão de erros A configuração de gerenciamento de erros para o mapeamento. ConnectorMappingErrorManagement (obrigatório)
fileFilter O filtro de arquivo para o mapeamento. cadeia (de caracteres)
folderPath O caminho da pasta para o mapeamento. cadeia (de caracteres)
Formato O formato da propriedade de mapeamento. ConnectorMappingFormat (obrigatório)
hasHeader Se o arquivo contém um cabeçalho ou não. Bool
estrutura Informações de mapeamento de ingestão no nível da propriedade. ConnectorMappingStructure[] (obrigatório)

ConnectorMappingStructure

Designação Descrição Valor
nomeDaColuna O nome da coluna do arquivo de importação. string (obrigatório)
customFormatSpecifier Especificador de formato personalizado para análise de entrada. cadeia (de caracteres)
éEncriptado Indica se a coluna está criptografada. Bool
nomeDaPropriedade O nome da propriedade da entidade de mapeamento. string (obrigatório)