Partilhar via

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

  • Artigo

Este projeto é utilizado como um pacote de modelos para o SDK do Azure para JavaScript. Destina-se a ajudar os programadores do SDK do Azure a iniciar o arranque de 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.

Introdução

Ambientes atualmente suportados

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

Pré-requisitos

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

Instalar o pacote @azure/template

Instale a biblioteca de cliente do Modelo para JavaScript com npm:

npm install @azure/template

Browser support (Suporte do browser)

Pacote JavaScript

Para utilizar esta biblioteca de cliente no browser, primeiro tem de utilizar um bundler. Para obter detalhes sobre como fazê-lo, veja a nossa documentação de agrupamento.

CORS

Se precisar de programar para browsers, tem de configurar regras de Partilha de Recursos Transversais à Origem (CORS) para a sua conta de armazenamento. Aceda a portal do Azure e Explorador de Armazenamento do Azure, localize a sua conta de armazenamento, crie novas regras CORS para serviços de blobs/filas/ficheiros/tabelas.

Por exemplo, pode criar as seguintes definições CORS para depuração. Mas personalize cuidadosamente as definições de acordo com os seus requisitos num 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

Mais exemplos

Normalmente, os exemplos de nível superior incluem elementos como criar e autenticar o Cliente principal. Se o seu serviço suportar vários meios de autenticação (por exemplo, baseado em chaves e no Azure Active Directory), pode dar um exemplo separado de cada um.

Conceitos-chave

ConfigurationClient

Descreva o seu cliente principal aqui. Fale sobre as operações que pode fazer e quando um programador pretende utilizá-lo.

Exemplos Adicionais

Crie uma secção para cada conceito de serviço de nível superior que pretende explicar.

Exemplos

Primeiro Exemplo

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

Resolução de problemas

Registo

Ativar o registo pode ajudar a descobrir informações úteis sobre falhas. Para ver um registo de pedidos e respostas HTTP, defina a variável de AZURE_LOG_LEVEL ambiente como info. Em alternativa, o registo pode ser ativado no runtime ao chamar setLogLevel no @azure/logger:

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

setLogLevel("info");

Para obter instruções mais detalhadas sobre como ativar os registos, pode ver os documentos do pacote @azure/logger.

Passos seguintes

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

Contribuir

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

Impressões