@azure/core-client package
Klasy
| ServiceClient |
Inicjuje nowe wystąpienie klasy ServiceClient. |
Interfejsy
| AdditionalPolicyConfig |
Służy do konfigurowania dodatkowych zasad dodanych do potoku podczas budowy. |
| BaseMapper |
Podstawowa definicja mapowania. Może być używany w przypadku obiektów XML i zwykłego języka 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: |
| DeserializationContentTypes |
Typy zawartości, które wskazują, że odpowiedź operacji powinna być deserializacji 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, który opisuje sposób analizowania słownika zamapowanych wartości. |
| EnumMapper |
Maper opisujący wartość wyliczenia. |
| 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, |
| InternalClientPipelineOptions |
Opcje tworzenia potoku do użycia z usługą 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 ciąg regex. |
| 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 poprawnego analizowania odpowiedzi. |
| OperationRequestOptions |
Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji. |
| OperationResponseMap |
OperacjaResponse, która może zostać zwrócona z żądania operacji dla pojedynczego kodu stanu. |
| OperationSpec |
Specyfikacja, która definiuje operację. |
| OperationURLParameter |
Parametr operacji, która zostanie zastąpiona adresem URL żądania operacji. |
| PolymorphicDiscriminator |
Służy do uściślania dyskryminowanych związków typu. Jeśli na przykład odpowiedź może zawierać wiele kształtów, ale zawiera również 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, który opisuje sposób analizowania sekwencji zamapowanych 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 zakodowanych typów, 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/de serializacji. |
| ServiceClientOptions |
Opcje, które należy podać 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 na potrzeby przyszłego sprawdzania. |
| 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 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
| authorize |
Ta funkcja może służyć jako wywołanie zwrotne dla Wywołaj metodę Po udostępnieniu Przykładowe wyzwanie z oświadczeniami: |
| authorize |
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://docs.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 dotyczących wyzwania usługi AAD. |
| create |
Tworzy nowy potok do użycia z klientem usługi. Domyślnie dodaje wartość deserializationPolicy. Ponadto dodaje element bearerTokenAuthenticationPolicy, jeśli przekazano tokenCredential. |
| create |
Metoda, która tworzy i zwraca serializator. |
| deserialization |
Te zasady obsługują analizowanie odpowiedzi zgodnie z operacjąSpecs w żądaniu. |
| serialization |
Te zasady obsługują składanie treści żądania i nagłówków przy użyciu elementu OperationSpec i OperationArguments w żądaniu. |
Szczegóły funkcji
authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)
Ta funkcja może służyć jako wywołanie zwrotne dla bearerTokenAuthenticationPolicy@azure/core-rest-pipelineelementu , aby obsługiwać wyzwania caE: ciągła ocena dostępu.
Wywołaj metodę bearerTokenAuthenticationPolicy za pomocą następujących opcji:
import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";
const bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});
Po udostępnieniu bearerTokenAuthenticationPolicy zasady 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://docs.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 dotyczących 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 wartość deserializationPolicy. Ponadto dodaje element bearerTokenAuthenticationPolicy, jeśli przekazano tokenCredential.
function createClientPipeline(options?: InternalClientPipelineOptions): PipelineParametry
- options
- InternalClientPipelineOptions
Opcje dostosowywania utworzonego potoku.
Zwraca
createSerializer({[key: string]: any}, boolean)
Metoda, która tworzy i zwraca serializator.
function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): SerializerParametry
- modelMappers
-
{[key: string]: any}
Znane modele do mapowania
- isXML
-
boolean
Jeśli plik XML powinien być obsługiwany
Zwraca
deserializationPolicy(DeserializationPolicyOptions)
Te zasady obsługują analizowanie odpowiedzi zgodnie z operacjąSpecs w żądaniu.
function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicyParametry
- options
- DeserializationPolicyOptions
Zwraca
serializationPolicy(SerializationPolicyOptions)
Te zasady obsługują składanie treści żądania i nagłówków przy użyciu elementu OperationSpec i OperationArguments w żądaniu.
function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicyParametry
- options
- SerializationPolicyOptions