이 프로젝트는 JavaScript용 Azure SDK의 템플릿 패키지로 사용됩니다. Azure SDK 개발자가 새 패키지를 부트스트랩하는 데 도움을 주기 위한 것이며, Azure 서비스에 대한 클라이언트 라이브러리의 코드 및 설명서를 구성하는 방법의 예를 제공합니다.
시작하기
현재 지원되는 환경
- Node.js의 LTS 버전
- Safari, Chrome, Edge 및 Firefox의 최신 버전입니다.
자세한 내용은 지원 정책 참조하세요.
사전 요구 사항
일반적으로 필요한 Azure 서비스를 프로비저닝하기 위한 셸 명령을 여기에 넣습니다.
@azure/template 패키지 설치
다음을 사용하여 npmJavaScript용 템플릿 클라이언트 라이브러리를 설치합니다.
npm install @azure/template
브라우저 지원
JavaScript 번들
브라우저에서 이 클라이언트 라이브러리를 사용하려면 먼저 번들러를 사용해야 합니다. 이 작업을 수행하는 방법에 대한 자세한 내용은 번들링 설명서참조하세요.
CORS
브라우저용으로 개발해야 하는 경우 스토리지 계정에 대한 CORS(Cross-Origin Resource Sharing) 규칙을 설정해야 합니다. Azure Portal 및 Azure Storage Explorer로 이동하여 스토리지 계정을 찾고, Blob/큐/파일/테이블 서비스에 대한 새 CORS 규칙을 만듭니다.
예를 들어 디버깅을 위해 다음 CORS 설정을 만들 수 있습니다. 그러나 프로덕션 환경의 요구 사항에 따라 설정을 신중하게 사용자 정의하십시오.
- 허용된 원본: *
- 허용되는 동사: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
- 허용되는 헤더: *
- 노출된 헤더: *
- 최대 연령(초): 86400
추가 예
최상위 예제에는 일반적으로 기본 클라이언트 생성 및 인증과 같은 작업이 포함됩니다. 서비스에서 여러 인증 방법(e.g. key 기반 및 Azure Active Directory)을 지원하는 경우 각각에 대한 별도의 예를 제공할 수 있습니다.
주요 개념
ConfigurationClient
여기에서 기본 클라이언트를 설명합니다. 어떤 작업을 수행할 수 있는지, 그리고 개발자가 언제 사용하고 싶어하는지에 대해 이야기합니다.
추가 예제
설명하려는 각 최상위 서비스 개념에 대한 섹션을 만듭니다.
Examples
첫 번째 예
누군가가 라이브러리를 사용하여 서비스에서 일반적인 작업을 수행하는 방법에 대한 몇 가지 코드 예제를 만듭니다.
Troubleshooting
로깅
로깅을 사용하도록 설정하면 오류에 대한 유용한 정보를 파악하는 데 도움이 될 수 있습니다. HTTP 요청 및 응답 로그를 보려면 AZURE_LOG_LEVEL 환경 변수를 info설정합니다. 또는 setLogLevel@azure/logger 호출하여 런타임에 로깅을 사용하도록 설정할 수 있습니다.
import { setLogLevel } from "@azure/logger";
setLogLevel("info");
로그를 사용하도록 설정하는 방법에 대한 자세한 지침은 @azure/로거 패키지 문서를 참조하세요.
다음 단계
클라이언트 라이브러리 사용 방법을 자세히 보여주는 예시는 samples 디렉터리를 참고해 주세요.
Contributing
이 라이브러리에 기여하려면 기여 가이드 읽어 코드를 빌드하고 테스트하는 방법에 대해 자세히 알아보세요.
관련 프로젝트
- Javascript용 Microsoft Azure SDK
Azure SDK for JavaScript