Azure Template client library for JavaScript - wersja 1.0.0-beta.3

Ten projekt jest używany jako pakiet szablonu dla zestawu Azure SDK dla języka JavaScript. Ma on na celu pomóc deweloperom zestawu Azure SDK w uruchamianiu nowych pakietów i zawiera przykład sposobu organizowania kodu i dokumentacji biblioteki klienta dla usługi platformy Azure.

Rozpoczęcie pracy

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Wymagania wstępne

Zwykle w tym miejscu umieszcza się polecenie powłoki do aprowizacji niezbędnych usług platformy Azure.

Instalowanie pakietu @azure/template

Zainstaluj bibliotekę klienta szablonu dla języka JavaScript za pomocą npm:

npm install @azure/template

Obsługa przeglądarek

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

CORS

Musisz skonfigurować reguły udostępniania zasobów między źródłami (CORS) dla konta magazynu, jeśli musisz programować dla przeglądarek. Przejdź do Azure Portal i Eksplorator usługi Azure Storage, znajdź swoje konto magazynu, utwórz nowe reguły CORS dla usług blob/kolejki/plików/tabel.

Można na przykład utworzyć następujące ustawienia CORS na potrzeby debugowania. Należy jednak ostrożnie dostosować ustawienia do swoich wymagań w środowisku produkcyjnym.

  • Dozwolone pochodzenie: *
  • Dozwolone czasowniki: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Dozwolone nagłówki: *
  • Uwidocznione nagłówki: *
  • Maksymalny wiek (w sekundach): 86400

Dalsze przykłady

Przykłady najwyższego poziomu zwykle obejmują takie rzeczy, jak tworzenie i uwierzytelnianie głównego klienta. Jeśli usługa obsługuje wiele sposobów uwierzytelniania (opartych na e.g. key i Azure Active Directory), możesz podać osobny przykład każdego z nich.

Kluczowe pojęcia

ConfigurationClient

Opisz tutaj swojego głównego klienta. Porozmawiaj o tym, jakie operacje może wykonać i kiedy programista chciałby z niego skorzystać.

Dodatkowe przykłady

Utwórz sekcję dla każdej koncepcji usługi najwyższego poziomu, którą chcesz wyjaśnić.

Examples

Pierwszy przykład

Utwórz kilka przykładów kodu, aby określić, w jaki sposób ktoś może użyć Twojej biblioteki do wykonania typowego zadania z usługą.

Troubleshooting

Logging

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Proszę zajrzyć do katalogu samples gdzie znajdziesz szczegółowe przykłady pokazujące, jak korzystać z bibliotek klienckich.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.

  • Last updated on