Partager via

@azure-rest/core-client package

  • Référence

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 error.
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 parsedBody propriété lorsque le corps de la réponse est reçu au format JSON.
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.
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, corps d’un objet de flux NodeJS
HttpNodeStreamResponse

Réponse HTTP, corps d’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 d’accès entouré de {} 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 lequel 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.
RequestParameters

Forme des paramètres de requête par défaut, elle peut être remplacée par les types de requête 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

Fonctions

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.
createRestError(PathUncheckedResponse)

Crée une erreur de repos à partir d’une réponse PathUnchecked
createRestError(string, PathUncheckedResponse)

Crée une erreur de repos à partir d’un message d’erreur et d’une réponse PathUnchecked
getClient(string, ClientOptions)

Crée un client avec un pipeline par défaut
getClient(string, TokenCredential | KeyCredential, ClientOptions)

Crée un client avec un pipeline par défaut
operationOptionsToRequestParameters(OperationOptions)

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

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Crée une erreur de repos à partir d’une réponse PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Paramètres

response
PathUncheckedResponse

Retours

RestError

createRestError(string, PathUncheckedResponse)

Crée une erreur de repos à 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

RestError

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

Client

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

TokenCredential | KeyCredential

Informations d’identification pour authentifier les demandes

options
ClientOptions

Options du client

Retours

Client

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 demande

Retours

RequestParameters

résultat de la conversion dans RequestParameters de la couche RLC