Definir e acessar valores

Nesta página

Definir um valor

Acesse um valor

Um Valor é uma referência nomeada de uma parte de dados estáticos armazenados pelo Atlas que você pode acessar emFunções do Atlas . Os valores fornecem uma alternativa a codificar configurações de constantes diretamente em suas funções.

Em outras palavras, os valores permitem separar dados de configuração específicos do sistema da lógica de negócios do seu aplicativo.

Os valores podem resultar em dois tipos de dados:

Texto simples: resolve para um objeto JSON, array ou valor de string normal que você define.
Segredo: resolve para um valor secreto que você define.

Definir um valor

Você pode definir um novo valor a partir da UI ou usando a App Services CLI.

Navegue até a Values Página

Navegue até a página Triggers :
1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.
2. Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.
3. Na barra lateral, clique em Triggers sob o título Services.
  A páginaAcionadores é exibida.
Clique no link Linked App Service: Triggers.
Na barra lateral, clique em Values sob o título Build.
Clique em Create a Value.

Nomear o valor

Insira um Value Name exclusivo. Este nome é como você se refere ao Valor em Funções.

Observação

Restrições de nome de valor

Os nomes dos valores não podem exceder 64 caracteres e só podem conter letras, números, sublinhados e hífens ASCII. O primeiro caractere deve ser uma letra ou um número.

Definir o valor

Selecione o tipo Value.
Defina um valor de texto sem formatação ou link para um valor de segredo:
- Para definir um valor de texto sem formatação, Custom Content e insira o valor de texto sem formatação na caixa de entrada.
- Para vincular ao valor de um segredo existente, selecione Link to Secret e selecione o segredo no menu suspenso.
- Para vincular a um novo valor de segredo, selecione Link to Secret, insira o nome do novo segredo e o novo valor de segredo na caixa de entrada que aparece.
Para obter mais informações sobre como criar um segredo, consulte Criar um segredo.

Salve o Valor

Depois de nomear e definir o novo valor, clique em Save.

Depois de salvar, você pode acessar imediatamente o valor em suas funções.

Autenticar um usuário do MongoDB Atlas

Use sua chave de API de administração do MongoDB Atlas para fazer login na App Services CLI:

appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"

Extraia os arquivos de configuração mais recentes do seu aplicativo

Execute o seguinte comando para obter uma cópia local dos seus arquivos de configuração:

appservices pull --remote=<App ID>

Por padrão, o comando extrai arquivos para o diretório de trabalho atual. Você pode especificar um caminho de diretório com o sinalizador --local opcional.

Adicione a configuração de valor

Adicione um arquivo de configuração JSON para o novo Valor no subdiretório values do seu aplicação local :

touch values/<ValueName>.json

Cada valor é definido em seu próprio arquivo JSON. Por exemplo, um valor denominado myValue seria definido no arquivo /values/myValue.json.

O arquivo de configuração deve ter o seguinte formato geral:

values/<ValueName>.json

{
   "name": "<Value Name>",
   "from_secret": <boolean>,
   "value": <Stored JSON Value|Secret Name>
}

Campo	Descrição
`name`	Um nome exclusivo para o Valor. Este nome é como você se refere ao Valor em Funções e regras.
`from_secret`	Padrão: `false`. Se `true`, o Valor expõe um Segredo em vez de um Valor JSON de texto sem formatação.
`value`	Os dados armazenados que o Valor expõe quando referenciado: Se `from_secret` for `false`, `value` poderá ser uma string, array ou objeto JSON padrão. Se `from_secret` for `true`, `value` é uma string que contém o nome do Segredo que o Valor expõe.

Distribua suas alterações:

Execute o seguinte comando para implementar suas alterações:

appservices push

Acesse um valor

Você pode acessar os dados armazenados de um valor a partir de uma Atlas Function usando o módulo context.values .

context.values.get("<Value Name>")

Por exemplo, a seguinte função retorna true quando o ID do usuário ativo é incluído no array de texto sem formatação Valor adminUsers:

Exemplo de função que usa um valor

exports = function() {
   const adminUsers = context.values.get("adminUsers");
   const isAdminUser = adminUsers.indexOf(context.user.id) > 0;
   return isAdminUser;
}

Voltar

Referência da API do MongoDB

Registros