@azure-rest/core-client package
인터페이스
AddCredentialPipelinePolicyOptions |
파이프라인에 자격 증명 정책을 추가하기 위한 선택적 매개 변수입니다. |
AdditionalPolicyConfig |
생성 시 파이프라인에 추가된 추가 정책을 구성하는 데 사용됩니다. |
Client |
Rest Level 클라이언트의 셰이프 |
ErrorModel |
Error 개체. |
ErrorResponse |
오류 세부 정보가 포함된 응답입니다. |
FullOperationResponse |
http 요청 및 응답에 대한 래퍼 개체입니다. 역직렬화된 개체는 JSON에서 |
InnerError |
오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
OperationOptions |
모든 작업에 대한 기본 옵션 유형입니다. |
OperationRequestOptions |
이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다. |
ResourceMethods |
리소스에서 호출할 수 있는 메서드를 정의합니다. |
형식 별칭
ClientOptions |
Rest Level 클라이언트에서 사용할 수 있는 일반 옵션 |
HttpBrowserStreamResponse |
본문이 NodeJS 스트림 개체인 Http 응답 |
HttpNodeStreamResponse |
본문이 NodeJS 스트림 개체인 Http 응답 |
HttpResponse |
HttpResponse의 셰이프를 나타냅니다. |
PathParameters |
로 둘러싸인 {} 경로 템플릿 텍스트에서 매개 변수를 검색하는 데 사용되는 도우미 형식은 경로 매개 변수로 간주됩니다. |
PathUnchecked |
pathUnchecked에 대한 서명을 정의합니다. |
PathUncheckedResponse |
pathUnchecked와 함께 사용할 형식은 유연성을 허용하기 위해 본문 유형을 임의의 형식으로 재정의합니다. |
RawResponseCallback |
요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출될 수 있습니다. |
RequestParameters |
기본 요청 매개 변수의 모양입니다. 강력한 형식을 제공하기 위해 특정 요청 형식에 의해 재정의될 수 있습니다. |
StreamableMethod |
응답 본문을 원시 스트림으로 가져오는 것을 지원하는 메서드의 형식을 정의합니다. |
함수
add |
자격 증명이 제공된 경우 파이프라인에 자격 증명 정책을 추가합니다. 아무 것도 제공되지 않으면 정책이 추가되지 않습니다. |
create |
PathUnchecked 응답에서 나머지 오류를 만듭니다. |
create |
오류 메시지 및 PathUnchecked 응답에서 나머지 오류를 만듭니다. |
get |
기본 파이프라인을 사용하여 클라이언트를 만듭니다. |
get |
기본 파이프라인을 사용하여 클라이언트를 만듭니다. |
operation |
OperationOptions를 RequestParameters로 변환하는 도우미 함수 |
함수 세부 정보
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
자격 증명이 제공된 경우 파이프라인에 자격 증명 정책을 추가합니다. 아무 것도 제공되지 않으면 정책이 추가되지 않습니다.
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)
매개 변수
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
PathUnchecked 응답에서 나머지 오류를 만듭니다.
function createRestError(response: PathUncheckedResponse): RestError
매개 변수
- response
- PathUncheckedResponse
반환
createRestError(string, PathUncheckedResponse)
오류 메시지 및 PathUnchecked 응답에서 나머지 오류를 만듭니다.
function createRestError(message: string, response: PathUncheckedResponse): RestError
매개 변수
- message
-
string
- response
- PathUncheckedResponse
반환
getClient(string, ClientOptions)
기본 파이프라인을 사용하여 클라이언트를 만듭니다.
function getClient(endpoint: string, options?: ClientOptions): Client
매개 변수
- endpoint
-
string
클라이언트에 대한 기본 엔드포인트
- options
- ClientOptions
클라이언트 옵션
반환
getClient(string, TokenCredential | KeyCredential, ClientOptions)
기본 파이프라인을 사용하여 클라이언트를 만듭니다.
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client
매개 변수
- endpoint
-
string
클라이언트에 대한 기본 엔드포인트
- credentials
요청을 인증하기 위한 자격 증명
- options
- ClientOptions
클라이언트 옵션
반환
operationOptionsToRequestParameters(OperationOptions)
OperationOptions를 RequestParameters로 변환하는 도우미 함수
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
매개 변수
- options
- OperationOptions
모듈식 계층에서 요청을 보내는 데 사용되는 옵션
반환
RLC 계층의 RequestParameters 변환 결과