Azure Template client library para JavaScript - versão 1.0.0-beta.3

Este projeto é usado como um pacote de modelo para o SDK do Azure para JavaScript. Ele se destina a 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.

Como começar

Ambientes com suporte no momento

Consulte nossa política de suporte para obter mais detalhes.

Pré-requisitos

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

Instalar o pacote @azure/template

Instale a biblioteca de cliente de 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ê precisará configurar regras de CORS (Compartilhamento de Recursos entre Origens) para sua conta de armazenamento se precisar desenvolver para navegadores. Acesse o portal do Azure e o Gerenciador de Armazenamento do Azure, localize sua conta de armazenamento, crie novas regras de CORS para serviços de blob/fila/arquivo/tabela.

Por exemplo, você pode criar as seguintes configurações de CORS para depuração. Mas 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

Outros exemplos

Os exemplos de nível superior geralmente incluem coisas como criar e autenticar o cliente principal. Se o serviço der suporte a vários meios de autenticação (baseados em e.g. key e Azure Active Directory), você poderá dar um exemplo separado de cada um.

Conceitos principais

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 de como alguém usaria sua biblioteca para realizar uma tarefa comum com o serviço.

Solução de problemas

Logging

Habilitar o registro em 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 registro em log pode ser habilitado em runtime chamando setLogLevel no @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

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

Próximas Etapas 

Por favor, dê uma olhada no diretório samples para exemplos detalhados que demonstram como usar as bibliotecas clientes.

Contributing

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

  • Last updated on