@azure/core-client package

Odwołanie

Klasy

Inicjuje nowe wystąpienie klasy ServiceClient.

Interfejsy

AdditionalPolicyConfig	Służy do konfigurowania dodatkowych zasad dodanych do potoku w budowie.
BaseMapper	Podstawowa definicja mapowania. Może służyć do obsługi obiektów XML i zwykłych obiektów JavaScript.
CommonClientOptions	Typowy zestaw opcji, które klienci wysokiego poziomu mają uwidocznić.
CompositeMapper	Maper składający się z innych maperów.
CompositeMapperType	Pomaga utworzyć maper opisujący sposób mapowania zestawu właściwości obiektu na podstawie innych maperów. Powinna istnieć tylko jedna z następujących właściwości: `className`, `modelProperties` i `additionalProperties`.
DeserializationContentTypes	Typy zawartości, które będą wskazywać, że odpowiedź operacji powinna zostać zdeserializowana w określony sposób.
DeserializationPolicyOptions	Opcje konfigurowania deserializacji odpowiedzi interfejsu API.
DictionaryMapper	Maper opisujący zwykłe obiekty JavaScript używane jako pary klucz/wartość.
DictionaryMapperType	Pomaga utworzyć maper opisujący sposób analizowania słownika mapowanych wartości.
EnumMapper	Maper opisujący wartość wyliczeniową.
EnumMapperType	Pomaga utworzyć maper opisujący sposób analizowania wartości wyliczenia.
FullOperationResponse	Obiekt otoki dla żądania http i odpowiedzi. Deserializowany obiekt jest przechowywany we właściwości `parsedBody`, gdy treść odpowiedzi zostanie odebrana w formacie JSON lub XML.
InternalClientPipelineOptions	Opcje tworzenia potoku do użycia z elementem ServiceClient. Głównie do dostosowywania zasad uwierzytelniania (jeśli używasz uwierzytelniania tokenu) lub opcji deserializacji podczas korzystania z kodu XML.
MapperConstraints	Opis różnych ograniczeń wartości, takich jak zakresy liczb całkowitych i wyrażenia regularne ciągów.
OperationArguments	Kolekcja właściwości, które mają zastosowanie do pojedynczego wywołania operacji.
OperationOptions	Typ opcji podstawowych dla wszystkich operacji.
OperationParameter	Wspólny interfejs, który rozszerza wszystkie parametry operacji.
OperationQueryParameter	Parametr operacji, która zostanie dodana jako parametr zapytania do żądania HTTP operacji.
OperationRequestInfo	Metadane używane do prawidłowego analizowania odpowiedzi.
OperationRequestOptions	Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
OperationResponseMap	Element OperationResponse, który można zwrócić z żądania operacji dla pojedynczego kodu stanu.
OperationSpec	Specyfikacja definiująca operację.
OperationURLParameter	Parametr operacji, która zostanie zastąpiona adresem URL żądania operacji.
PolymorphicDiscriminator	Służy do uściślania związków typu dyskryminowanego. Jeśli na przykład odpowiedź może zawierać wiele kształtów, ale także pole "kind" (lub podobne), to pole może służyć do określenia, jak deserializować odpowiedź na poprawny typ.
SequenceMapper	Maper opisujący tablice.
SequenceMapperType	Pomaga utworzyć maper opisujący sposób analizowania sekwencji mapowanych wartości.
SerializationPolicyOptions	Opcje konfigurowania serializacji żądań interfejsu API.
Serializer	Służy do mapowania nieprzetworzonych obiektów odpowiedzi na końcowe kształty. Ułatwia pakowanie i rozpakowywanie dat oraz innych typów zakodowanych, które nie są wewnętrzne w formacie JSON. Umożliwia również ściąganie wartości z nagłówków, a także wstawianie wartości domyślnych i stałych.
SerializerOptions	Opcje konfigurowania zachowania serializacji/deseralizacji.
ServiceClientOptions	Opcje, które należy udostępnić podczas tworzenia klienta.
SimpleMapperType	Typ prostego mapowania.
SpanConfig	Konfiguracja tworzenia nowego zakresu śledzenia
XmlOptions	Opcje zarządzania zachowaniem analizatora XML i konstruktora.

Aliasy typu

Mapper	Mapery to definicje modeli danych używanych w bibliotece. Te modele danych są częścią definicji operacji lub klienta w odpowiedziach lub parametrach.
MapperType	Typ mapowania. Zawiera znane mapery.
OperationRequest	Alias typu do sprawdzania przyszłości.
ParameterPath	Koduje sposób uzyskiwania dostępu do określonej właściwości obiektu.
QueryCollectionFormat	Format, który będzie używany do łączenia tablicy wartości razem dla wartości parametru zapytania.
RawResponseCallback	Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

Funkcje

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Tej funkcji można użyć jako wywołania zwrotnego dla `bearerTokenAuthenticationPolicy@azure/core-rest-pipeline`, aby obsługiwać wyzwania caE: oceny ciągłego dostępu. Wywołaj `bearerTokenAuthenticationPolicy` przy użyciu następujących opcji: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const policy = bearerTokenAuthenticationPolicy({ challengeCallbacks: { authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge, }, scopes: ["https://service/.default"], });` Po podaniu zasady `bearerTokenAuthenticationPolicy` będą wewnętrznie obsługiwać wyzwania związane z ciągłą oceną dostępu (CAE). Gdy nie może ukończyć zadania, zwróci odpowiedź 401 (nieautoryzowaną) z usługi ARM. Przykładowe wyzwanie z oświadczeniami: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Definiuje wywołanie zwrotne do obsługi wyzwania uwierzytelniania dla interfejsów API usługi Storage. Spowoduje to zaimplementowanie procesu wyzwania elementu nośnego opisanego tutaj: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Obsługa ma określone funkcje magazynu, które odchodzą do ogólnych dokumentów wyzwania usługi AAD.
createClientPipeline(InternalClientPipelineOptions)	Tworzy nowy potok do użycia z klientem usługi. Domyślnie dodaje element deserializationPolicy. Dodaje również element bearerTokenAuthenticationPolicy, jeśli przekazano tokenCredential.
createSerializer({[key: string]: any}, boolean)	Metoda, która tworzy i zwraca serializator.
deserializationPolicy(DeserializationPolicyOptions)	Te zasady obsługują analizowanie odpowiedzi zgodnie z operacjąSpecs w żądaniu.
serializationPolicy(SerializationPolicyOptions)	Te zasady obsługują składanie treści żądania i nagłówków przy użyciu elementów OperationSpec i OperationArguments w żądaniu.

Szczegóły funkcji

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Tej funkcji można użyć jako wywołania zwrotnego dla bearerTokenAuthenticationPolicy@azure/core-rest-pipeline, aby obsługiwać wyzwania caE: oceny ciągłego dostępu.

Wywołaj bearerTokenAuthenticationPolicy przy użyciu następujących opcji:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Po podaniu zasady bearerTokenAuthenticationPolicy będą wewnętrznie obsługiwać wyzwania związane z ciągłą oceną dostępu (CAE). Gdy nie może ukończyć zadania, zwróci odpowiedź 401 (nieautoryzowaną) z usługi ARM.

Przykładowe wyzwanie z oświadczeniami:

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>

Parametry

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Zwraca

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Definiuje wywołanie zwrotne do obsługi wyzwania uwierzytelniania dla interfejsów API usługi Storage. Spowoduje to zaimplementowanie procesu wyzwania elementu nośnego opisanego tutaj: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Obsługa ma określone funkcje magazynu, które odchodzą do ogólnych dokumentów wyzwania usługi AAD.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parametry

challengeOptions: AuthorizeRequestOnChallengeOptions

Zwraca

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Tworzy nowy potok do użycia z klientem usługi. Domyślnie dodaje element deserializationPolicy. Dodaje również element bearerTokenAuthenticationPolicy, jeśli przekazano tokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parametry

options: InternalClientPipelineOptions

Opcje dostosowywania utworzonego potoku.

Zwraca

Pipeline

createSerializer({[key: string]: any}, boolean)

Metoda, która tworzy i zwraca serializator.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Parametry

modelMappers: {[key: string]: any}

Znane modele do mapowania

isXML: boolean

Jeśli plik XML powinien być obsługiwany

Zwraca

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Te zasady obsługują analizowanie odpowiedzi zgodnie z operacjąSpecs w żądaniu.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parametry

options: DeserializationPolicyOptions

Zwraca

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Te zasady obsługują składanie treści żądania i nagłówków przy użyciu elementów OperationSpec i OperationArguments w żądaniu.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parametry

options: SerializationPolicyOptions

Zwraca

PipelinePolicy

Udostępnij za pośrednictwem

@azure/core-client package

Klasy

Interfejsy

Aliasy typu

Funkcje

Szczegóły funkcji

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parametry

Zwraca

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parametry

Zwraca

createClientPipeline(InternalClientPipelineOptions)

Parametry

Zwraca

createSerializer({[key: string]: any}, boolean)

Parametry

Zwraca

deserializationPolicy(DeserializationPolicyOptions)

Parametry

Zwraca

serializationPolicy(SerializationPolicyOptions)

Parametry

Zwraca

Dodatkowe zasoby