@azure/core-client package
클래스
| ServiceClient |
ServiceClient의 새 인스턴스를 초기화합니다. |
인터페이스
| AdditionalPolicyConfig |
생성 시 파이프라인에 추가된 추가 정책을 구성하는 데 사용됩니다. |
| BaseMapper |
매퍼의 기본 정의입니다. XML 및 일반 JavaScript 개체에 사용할 수 있습니다. |
| CommonClientOptions |
상위 수준 클라이언트가 노출해야 하는 일반적인 옵션 집합입니다. |
| CompositeMapper |
다른 매퍼로 구성된 매퍼입니다. |
| CompositeMapperType |
다른 매퍼를 기반으로 개체의 속성 집합을 매핑하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다. , |
| DeserializationContentTypes |
작업 응답을 특정 방식으로 역직렬화해야 함을 나타내는 콘텐츠 형식입니다. |
| DeserializationPolicyOptions |
API 응답 역직렬화를 구성하는 옵션입니다. |
| DictionaryMapper |
키/값 쌍으로 사용되는 일반 JavaScript 개체를 설명하는 매퍼입니다. |
| DictionaryMapperType |
매핑된 값의 사전을 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다. |
| EnumMapper |
열거형 값을 설명하는 매퍼입니다. |
| EnumMapperType |
열거형 값을 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다. |
| FullOperationResponse |
http 요청 및 응답에 대한 래퍼 개체입니다. 역직렬화된 개체는 응답 본문을 JSON 또는 XML로 받으면 속성에 저장 |
| InternalClientPipelineOptions |
ServiceClient와 함께 사용할 파이프라인을 만들기 위한 옵션입니다. 주로 XML을 사용할 때 인증 정책(토큰 인증을 사용하는 경우) 또는 역직렬화 옵션을 사용자 지정합니다. |
| MapperConstraints |
정수 범위 및 문자열 정규식과 같은 다양한 값 제약 조건에 대한 설명입니다. |
| OperationArguments |
작업의 단일 호출에 적용되는 속성의 컬렉션입니다. |
| OperationOptions |
모든 작업에 대한 기본 옵션 형식입니다. |
| OperationParameter |
모든 Operation 매개 변수가 확장되는 공통 인터페이스입니다. |
| OperationQueryParameter |
작업의 HTTP 요청에 쿼리 매개 변수로 추가될 작업에 대한 매개 변수입니다. |
| OperationRequestInfo |
응답을 올바르게 구문 분석하는 데 사용되는 메타데이터입니다. |
| OperationRequestOptions |
이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다. |
| OperationResponseMap |
단일 상태 코드에 대한 작업 요청에서 반환할 수 있는 OperationResponse입니다. |
| OperationSpec |
작업을 정의하는 사양입니다. |
| OperationURLParameter |
작업의 요청 URL로 대체될 작업에 대한 매개 변수입니다. |
| PolymorphicDiscriminator |
차별된 형식 공용 구조체를 명확하게 구분하는 데 사용됩니다. 예를 들어 응답에 셰이프가 많을 수 있지만 'kind' 필드(또는 이와 유사)도 포함된 경우 해당 필드를 사용하여 올바른 형식에 대한 응답을 역직렬화하는 방법을 결정할 수 있습니다. |
| SequenceMapper |
배열을 설명하는 매퍼입니다. |
| SequenceMapperType |
매핑된 값 시퀀스를 구문 분석하는 방법을 설명하는 매퍼를 빌드하는 데 도움이 됩니다. |
| SerializationPolicyOptions |
API 요청 serialization을 구성하는 옵션입니다. |
| Serializer |
원시 응답 개체를 최종 셰이프에 매핑하는 데 사용됩니다. JSON에 내장되지 않는 날짜 및 기타 인코딩된 형식을 압축하고 압축 해제하는 데 도움이 됩니다. 또한 헤더에서 값을 끌어와 기본값 및 상수를 삽입할 수 있습니다. |
| SerializerOptions |
serialization/de-serialization 동작을 구성하는 옵션입니다. |
| ServiceClientOptions |
클라이언트를 만드는 동안 제공할 옵션입니다. |
| SimpleMapperType |
간단한 매퍼의 형식입니다. |
| SpanConfig |
새 추적 범위를 만들기 위한 구성 |
| XmlOptions |
xml 파서 및 작성기의 동작을 제어하는 옵션입니다. |
형식 별칭
| Mapper |
매퍼는 라이브러리에 사용되는 데이터 모델의 정의입니다. 이러한 데이터 모델은 응답 또는 매개 변수의 작업 또는 클라이언트 정의에 속합니다. |
| MapperType |
매퍼의 형식입니다. 알려진 매퍼를 포함합니다. |
| OperationRequest |
이후 언어 교정을 위한 형식 별칭입니다. |
| ParameterPath |
개체의 특정 속성에 도달하는 방법을 인코딩합니다. |
| QueryCollectionFormat |
쿼리 매개 변수 값에 대해 값 배열을 함께 조인하는 데 사용할 형식입니다. |
| RawResponseCallback |
요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다. |
함수
| authorize |
이 함수는 의 에 대한
일단 제공되면 클레임에 대한 예제 챌린지: |
| authorize |
스토리지 API에 대한 인증 챌린지를 처리하는 콜백을 정의합니다. 이렇게 하면 처리 https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 에 일반적인 AAD 챌린지 문서로 떠나는 스토리지에 대한 특정 기능이 있습니다. |
| create |
서비스 클라이언트와 함께 사용할 새 파이프라인을 만듭니다. 기본적으로 deserializationPolicy에 를 추가합니다. TokenCredential을 전달한 경우 bearerTokenAuthenticationPolicy에도 를 추가합니다. |
| create |
Serializer를 만들고 반환하는 메서드입니다. |
| deserialization |
이 정책은 요청에 대한 OperationSpecs에 따라 응답 구문 분석을 처리합니다. |
| serialization |
이 정책은 요청 시 OperationSpec 및 OperationArguments를 사용하여 요청 본문 및 헤더를 어셈블하는 작업을 처리합니다. |
함수 세부 정보
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
이 함수는 의 에 대한 bearerTokenAuthenticationPolicy@azure/core-rest-pipeline콜백으로 사용하여 CAE 챌린지인 지속적인 액세스 평가를 지원할 수 있습니다.
bearerTokenAuthenticationPolicy 다음 옵션을 사용하여 를 호출합니다.
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
일단 제공되면 bearerTokenAuthenticationPolicy 정책은 내부적으로 CAE(지속적인 액세스 평가) 챌린지를 처리합니다.
챌린지를 완료할 수 없으면 ARM에서 401(권한 없는) 응답을 반환합니다.
클레임에 대한 예제 챌린지:
Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token",
error_description="User session has been revoked",
claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
function authorizeRequestOnClaimChallenge(onChallengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>매개 변수
- onChallengeOptions
- AuthorizeRequestOnChallengeOptions
반환
Promise<boolean>
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)
스토리지 API에 대한 인증 챌린지를 처리하는 콜백을 정의합니다. 이렇게 하면 처리 https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge 에 일반적인 AAD 챌린지 문서로 떠나는 스토리지에 대한 특정 기능이 있습니다.
function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>매개 변수
- challengeOptions
- AuthorizeRequestOnChallengeOptions
반환
Promise<boolean>
createClientPipeline(InternalClientPipelineOptions)
서비스 클라이언트와 함께 사용할 새 파이프라인을 만듭니다. 기본적으로 deserializationPolicy에 를 추가합니다. TokenCredential을 전달한 경우 bearerTokenAuthenticationPolicy에도 를 추가합니다.
function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline매개 변수
- options
- InternalClientPipelineOptions
생성된 파이프라인을 사용자 지정하는 옵션입니다.
반환
createSerializer({[key: string]: any}, boolean)
Serializer를 만들고 반환하는 메서드입니다.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer매개 변수
- modelMappers
-
{[key: string]: any}
매핑할 알려진 모델
- isXML
-
boolean
XML을 지원해야 하는 경우
반환
deserializationPolicy(DeserializationPolicyOptions)
이 정책은 요청에 대한 OperationSpecs에 따라 응답 구문 분석을 처리합니다.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy매개 변수
- options
- DeserializationPolicyOptions
반환
serializationPolicy(SerializationPolicyOptions)
이 정책은 요청 시 OperationSpec 및 OperationArguments를 사용하여 요청 본문 및 헤더를 어셈블하는 작업을 처리합니다.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy매개 변수
- options
- SerializationPolicyOptions