Conexão do Azure Cosmos DB

Introdução

Uma conexão do Azure Cosmos DB, criada usando o conector do Azure Cosmos DB, estabelece acesso ao Azure Cosmos DB. Essas atividades, uma vez configuradas, interagem com o Azure Cosmos DB por meio da conexão.

Criar ou editar uma conexão do Azure Cosmos DB

Uma nova conexão do Azure Cosmos DB é criada usando o conector do Azure Cosmos DB a partir de uma dessas localizações:

A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
A página Endpoints Globais (veja Criar um endpoint global em Endpoints Globais).

Uma conexão existente do Azure Cosmos DB pode ser editada a partir dessas localizações:

A aba Endpoints e conectores do projeto na paleta de componentes de design (veja Paleta de componentes de design).
A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba Componentes do painel do projeto).
A página Endpoints Globais (veja Editar um endpoint global em Endpoints Globais).

Configurar uma conexão do Azure Cosmos DB

Cada elemento da interface do usuário da tela de configuração da conexão do Azure Cosmos DB é descrito abaixo.

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis do Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir um menu com as variáveis existentes para escolher.

Nome da Conexão: Insira um nome para identificar a conexão. O nome deve ser exclusivo para cada conexão do Azure Cosmos DB e não deve conter barras (/) ou dois pontos (:). Este nome também é usado para identificar o endpoint do Azure Cosmos DB, que se refere tanto a uma conexão específica quanto às suas atividades.
Endpoint da Conta: Insira o endpoint da conta.
Esquema de Autenticação: Selecione o esquema de autorização, um dos seguintes:
- AccountKey
  - Chave da Conta: Insira a chave da conta.
  - Tipo de Token: Selecione o tipo de token, um dos seguintes:
    - master
    - resource
- AzureAD
  - Iniciar OAuth: Selecione a configuração de OAuth, uma das seguintes:
    - OFF
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
    - GETANDREFRESH
    - REFRESH
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
  - ID do Cliente OAuth: Insira o ID do cliente OAuth.
  - Segredo do Cliente OAuth: Insira o segredo do cliente OAuth.
  - Token de Atualização OAuth: Insira o token de atualização OAuth.
- AzureServicePrincipal
  - Inquilino do Azure: Insira o inquilino do Azure.
  - Iniciar OAuth: Selecione a configuração de OAuth, uma das seguintes:
    - OFF
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
    - GETANDREFRESH
    - REFRESH
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
  - ID do Cliente OAuth: Insira o ID do cliente OAuth.
  - Segredo do Cliente OAuth: Insira o segredo do cliente OAuth.
  - Token de Atualização OAuth: Insira o token de atualização OAuth.
- AzureServicePrincipalCert
  - Inquilino do Azure: Insira o inquilino do Azure.
  - Iniciar OAuth: Selecione a configuração de OAuth, uma das seguintes:
    - OFF
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
    - GETANDREFRESH
    - REFRESH
      - Token de Acesso OAuth: Insira o token de acesso OAuth.
  - ID do Cliente OAuth: Insira o ID do cliente OAuth.
  - Token de Atualização OAuth: Insira o token de atualização OAuth.
  - Certificado JWT OAuth: Insira o certificado JWT OAuth.
  - Tipo de Certificado JWT OAuth: Selecione o tipo de certificado JWT OAuth, um dos:
    - USUÁRIO
    - MÁQUINA
    - ARQUIVO PFX
    - BLOB PFX
    - ARQUIVO JKS
    - BLOB JKS
    - ARQUIVO PEMKEY
    - BLOB PEMKEY
    - ARQUIVO CHAVE PÚBLICA
    - BLOB CHAVE PÚBLICA
    - ARQUIVO CHAVE PÚBLICA SSH
    - BLOB CHAVE PÚBLICA SSH
    - ARQUIVO P7B
    - ARQUIVO PPK
    - ARQUIVO XML
    - BLOB XML
  - Senha do Certificado JWT OAuth: Insira a senha do certificado JWT OAuth.
  - Assunto do Certificado JWT OAuth: Insira o assunto do certificado JWT OAuth.
Esquema: Insira o esquema.
Usar Configurações de Proxy: Selecione para usar as configurações de proxy do agente privado.
Configurações Avançadas: Quando selecionado, mostra a tabela Propriedades de Configurações Avançadas, que é usada para adicionar propriedades de configuração adicionais como pares chave-valor.
- Adicionar: Adiciona uma linha à tabela. Insira um par chave-valor para cada propriedade.
- Enviar: Salva o par chave-valor na tabela. Visível ao passar o mouse sobre uma linha no modo de edição.
- Descartar: Descartar uma nova linha ou quaisquer edições feitas em uma linha existente. Visível ao passar o mouse sobre uma linha no modo de edição.
- Editar: Permite editar um par chave-valor existente. Visível ao passar o mouse sobre uma linha existente.
- Excluir: Exclui a linha da tabela. Visível ao passar o mouse sobre uma linha existente.
- Limpar Tudo: Exclui todas as linhas da tabela.
Importante

Campos na tabela Propriedades de Configurações Avançadas exibem o ícone de variável apenas no modo de edição. Para que os valores de variável desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

Campos na tabela Propriedades de Configurações Avançadas não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.
Testar: Clique para verificar a conexão usando a configuração especificada. Quando a conexão é testada, a versão mais recente do conector é baixada pelos agentes no grupo de agentes associado ao ambiente atual. Este conector suporta suspender o download da versão mais recente do conector usando a política de Desativar Atualização Automática do Conector.
Salvar Alterações: Clique para salvar e fechar a configuração da conexão.
Descartar Alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (veja Dependências de componentes, exclusão e remoção). Uma mensagem pede para você confirmar que deseja excluir a conexão.

Próximas etapas

Após a criação de uma conexão com o conector do Azure Cosmos DB, você coloca um tipo de atividade na tela de design para criar instâncias de atividade a serem usadas como fontes (para fornecer dados em uma operação) ou como alvos (para consumir dados em uma operação).

As ações de menu para uma conexão e seus tipos de atividade estão acessíveis no painel do projeto e na paleta de componentes de design. Para mais detalhes, veja Menus de ações em Conceitos básicos do conector.

Estes tipos de atividade estão disponíveis:

Consulta: Recupera registros de uma tabela no Azure Cosmos DB e é destinado a ser usado como uma fonte em uma operação.
Criar: Insere um registro em uma tabela no Azure Cosmos DB e é destinado a ser usado como um destino em uma operação.
Atualizar: Atualiza um registro em uma tabela no Azure Cosmos DB e é destinado a ser usado como um destino em uma operação.
Excluir: Exclui um registro de uma tabela no Azure Cosmos DB e é destinado a ser usado como um destino em uma operação.
Executar: Executa um procedimento no Azure Cosmos DB e é destinado a ser usado como um destino em uma operação.