Biblioteca de clientes do Modelo do Azure para JavaScript – versão 1.0.0-beta.1

  • Artigo

Esse projeto é usado como um pacote de modelo para o SDK do Azure para JavaScript. O objetivo é ajudar os desenvolvedores do SDK do Azure a inicializar novos pacotes e fornece um exemplo de como organizar o código e a documentação de uma biblioteca de clientes para um serviço do Azure.

Introdução

Ambientes com suporte no momento

Confira nossa política de suporte para mais detalhes.

Pré-requisitos

Normalmente, você coloca um comando de shell para provisionar os serviços necessários do Azure aqui.

Instalar o pacote @azure/template

Instale a biblioteca de clientes modelo para JavaScript com npm:

npm install @azure/template

Suporte ao navegador

Pacote JavaScript

Para usar essa biblioteca de clientes no navegador, primeiro você precisa usar um empacotador. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agrupamento.

CORS

Você precisa configurar regras de CORS (Compartilhamento de Recursos entre Origens) para sua conta de armazenamento se precisar desenvolver para navegadores. Vá para portal do Azure e Gerenciador de Armazenamento do Azure, localize sua conta de armazenamento, crie novas regras CORS para serviços de blob/fila/arquivo/tabela.

Por exemplo, você pode criar as seguintes configurações de CORS para depuração. Porém, personalize as configurações cuidadosamente de acordo com seus requisitos em um ambiente de produção.

  • Origens permitidas: *
  • Verbos permitidos: DELETE, GET, HEAD,MERGE,POST,OPTIONS,PUT
  • Cabeçalhos permitidos: *
  • Cabeçalhos expostos: *
  • Idade máxima (segundos): 86400

Exemplos adicionais

Exemplos de nível superior geralmente incluem coisas como criar e autenticar o cliente main. Se o serviço der suporte a vários meios de autenticação (por exemplo, baseado em chave e Azure Active Directory), você poderá dar um exemplo separado de cada um.

Principais conceitos

ConfigurationClient

Descreva seu cliente principal aqui. Fale sobre quais operações ele pode fazer e quando um desenvolvedor gostaria de usá-lo.

Exemplos adicionais

Crie uma seção para cada conceito de serviço de nível superior que você deseja explicar.

Exemplos

Primeiro exemplo

Crie vários exemplos de código para saber como alguém usaria sua biblioteca para realizar uma tarefa comum com o serviço.

Solução de problemas

Log

A habilitação do log pode ajudar a descobrir informações úteis sobre falhas. Para ver um log de solicitações e respostas HTTP, defina a variável de ambiente AZURE_LOG_LEVEL como info. Como alternativa, o log pode ser habilitado no runtime chamando setLogLevel em @azure/logger:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Para obter instruções mais detalhadas sobre como habilitar logs, veja os documentos do pacote @azure/logger.

Próximas etapas

Examine o diretório de exemplos para obter exemplos detalhados que demonstram como usar as bibliotecas de cliente.

Contribuição

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber como criar e testar o código.

Impressões