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

Este projeto é usado como um pacote de modelo para o SDK do Azure para JavaScript. Destina-se 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 cliente para um serviço do Azure.

Como Começar

Ambientes atualmente suportados

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

Pré-requisitos

  • Uma assinatura do Azure.

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 de navegador

Pacote JavaScript

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

CORS

Você precisa configurar regras de compartilhamento de recursos entre origens (CORS) para sua conta de armazenamento se precisar desenvolver para navegadores. Vá para o portal do Azure e o Gerenciador de Armazenamento do Azure, encontre 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. Mas personalize as configurações cuidadosamente de acordo com suas necessidades 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

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

Conceitos-chave

ConfigurationClient

Descreva o 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.

Examples

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 tempo de execução 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.

Passos seguintes

Por favor, consulte o diretório samples para exemplos detalhados que demonstram como usar as bibliotecas do cliente.

Contributing

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

  • Last updated on