@azure-rest/core-client package
Interfaces
AddCredentialPipelinePolicyOptions |
Paramètres facultatifs pour l’ajout d’une stratégie d’informations d’identification au pipeline. |
AdditionalPolicyConfig |
Permet de configurer des stratégies supplémentaires ajoutées au pipeline lors de la construction. |
Client |
Forme d’un client de niveau rest |
ErrorModel |
Objet d’erreur. |
ErrorResponse |
Réponse contenant les détails de l’erreur. |
FullOperationResponse |
Objet wrapper pour la requête et la réponse http. L’objet désérialisé est stocké dans la propriété |
InnerError |
Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
OperationOptions |
Type d’options de base pour toutes les opérations. |
OperationRequestOptions |
Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération. |
PathParameterWithOptions |
Objet qui peut être passé en tant que paramètre de chemin d’accès, ce qui permet de définir des options supplémentaires relatives à la façon dont le paramètre est encodé. |
ResourceMethods |
Définit les méthodes qui peuvent être appelées sur une ressource |
Alias de type
ClientOptions |
Options générales qu’un client de niveau rest peut prendre |
HttpBrowserStreamResponse |
Réponse Http qui est un objet de flux NodeJS |
HttpNodeStreamResponse |
Réponse Http qui est un objet de flux NodeJS |
HttpResponse |
Représente la forme d’un HttpResponse |
PathParameters |
Le type d’assistance utilisé pour détecter les paramètres dans un texte de modèle de chemin entouré par {} sera considéré comme un paramètre de chemin d’accès |
PathUnchecked |
Définit la signature pour pathUnchecked. |
PathUncheckedResponse |
Type à utiliser avec pathUnchecked, remplace le type de corps par n’importe quel pour permettre la flexibilité |
RawResponseCallback |
Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois. Ce rappel est appelé avec deux paramètres : la réponse brute, y compris les en-têtes et le corps de la réponse ; et un objet d’erreur qui sera fourni si une erreur a été levée lors du traitement de la demande.
Le troisième paramètre __legacyError est fourni uniquement pour la compatibilité descendante et aura une valeur identique au paramètre |
RequestParameters |
Forme des paramètres de requête par défaut, cela peut être remplacé par les types de requêtes spécifiques pour fournir des types forts |
StreamableMethod |
Définit le type d’une méthode qui prend en charge l’obtention du corps de la réponse en tant que flux brut |
Functions
add |
Ajoute une stratégie d’informations d’identification au pipeline si des informations d’identification sont fournies. Si aucun n’est fourni, aucune stratégie n’est ajoutée. |
create |
Crée une erreur rest à partir d’une réponse PathUnchecked |
create |
Crée une erreur rest à partir d’un message d’erreur et d’une réponse PathUnchecked |
get |
Crée un client avec un pipeline par défaut |
get |
Crée un client avec un pipeline par défaut |
operation |
Fonction d’assistance pour convertir OperationOptions en RequestParameters |
Informations relatives à la fonction
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
Ajoute une stratégie d’informations d’identification au pipeline si des informations d’identification sont fournies. Si aucun n’est fourni, aucune stratégie n’est ajoutée.
function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)
Paramètres
- pipeline
- Pipeline
- endpoint
-
string
createRestError(PathUncheckedResponse)
Crée une erreur rest à partir d’une réponse PathUnchecked
function createRestError(response: PathUncheckedResponse): RestError
Paramètres
- response
- PathUncheckedResponse
Retours
createRestError(string, PathUncheckedResponse)
Crée une erreur rest à partir d’un message d’erreur et d’une réponse PathUnchecked
function createRestError(message: string, response: PathUncheckedResponse): RestError
Paramètres
- message
-
string
- response
- PathUncheckedResponse
Retours
getClient(string, ClientOptions)
Crée un client avec un pipeline par défaut
function getClient(endpoint: string, options?: ClientOptions): Client
Paramètres
- endpoint
-
string
Point de terminaison de base pour le client
- options
- ClientOptions
Options du client
Retours
getClient(string, TokenCredential | KeyCredential, ClientOptions)
Crée un client avec un pipeline par défaut
function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client
Paramètres
- endpoint
-
string
Point de terminaison de base pour le client
- credentials
Informations d’identification pour authentifier les demandes
- options
- ClientOptions
Options du client
Retours
operationOptionsToRequestParameters(OperationOptions)
Fonction d’assistance pour convertir OperationOptions en RequestParameters
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
Paramètres
- options
- OperationOptions
options utilisées par la couche modulaire pour envoyer la requête
Retours
résultat de la conversion dans RequestParameters de la couche RLC