Compartilhar via

@azure-rest/core-client package

  • Referência

Interfaces

AddCredentialPipelinePolicyOptions

Parâmetros opcionais para adicionar uma política de credencial ao pipeline.
AdditionalPolicyConfig

Usado para configurar políticas adicionais adicionadas ao pipeline na construção.
Client

Forma de um cliente de nível rest
ErrorModel

O objeto de erro.
ErrorResponse

Uma resposta que contém detalhes do erro.
FullOperationResponse

Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na propriedade parsedBody quando o corpo da resposta é recebido no JSON.
InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
OperationOptions

O tipo de opções base para todas as operações.
OperationRequestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.
PathParameterWithOptions

Um objeto que pode ser passado como um parâmetro de caminho, permitindo que opções adicionais sejam definidas relacionadas à forma como o parâmetro é codificado.
ResourceMethods

Define os métodos que podem ser chamados em um recurso

Aliases de tipo

ClientOptions

Opções gerais que um cliente de nível rest pode tomar
HttpBrowserStreamResponse

Resposta Http qual corpo é um objeto de fluxo nodeJS
HttpNodeStreamResponse

Resposta Http qual corpo é um objeto de fluxo nodeJS
HttpResponse

Representa a forma de um HttpResponse
PathParameters

O tipo auxiliar usado para detectar parâmetros em um texto de modelo de caminho cercado por {} será considerado um parâmetro de caminho
PathUnchecked

Define a assinatura de pathUnchecked.
PathUncheckedResponse

Tipo a ser usado com pathUnchecked, substitui o tipo de corpo a qualquer um para permitir flexibilidade
RawResponseCallback

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

Esse retorno de chamada será chamado com dois parâmetros: a resposta bruta, incluindo cabeçalhos e corpo da resposta; e um objeto de erro que será fornecido se um erro tiver sido gerado durante o processamento da solicitação. O terceiro parâmetro __legacyError é fornecido apenas para compatibilidade com versões anteriores e terá um valor idêntico ao parâmetro error.
RequestParameters

Forma dos parâmetros de solicitação padrão, isso pode ser substituído pelos tipos de solicitação específicos para fornecer tipos fortes
StreamableMethod

Define o tipo para um método que dá suporte à obtenção do corpo da resposta como um fluxo bruto

Funções

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Adiciona uma política de credencial ao pipeline se uma credencial for fornecida. Se nenhuma for fornecida, nenhuma política será adicionada.
createRestError(PathUncheckedResponse)

Cria um erro de repouso com base em uma resposta PathUnchecked
createRestError(string, PathUncheckedResponse)

Cria um erro de repouso com base em uma mensagem de erro e uma resposta PathUnchecked
getClient(string, ClientOptions)

Cria um cliente com um pipeline padrão
getClient(string, TokenCredential | KeyCredential, ClientOptions)

Cria um cliente com um pipeline padrão
operationOptionsToRequestParameters(OperationOptions)

Função auxiliar para converter OperationOptions em RequestParameters

Detalhes da função

addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)

Adiciona uma política de credencial ao pipeline se uma credencial for fornecida. Se nenhuma for fornecida, nenhuma política será adicionada.

function addCredentialPipelinePolicy(pipeline: Pipeline, endpoint: string, options?: AddCredentialPipelinePolicyOptions)

Parâmetros

pipeline
Pipeline
endpoint

string

options
AddCredentialPipelinePolicyOptions

createRestError(PathUncheckedResponse)

Cria um erro de repouso com base em uma resposta PathUnchecked

function createRestError(response: PathUncheckedResponse): RestError

Parâmetros

response
PathUncheckedResponse

Retornos

RestError

createRestError(string, PathUncheckedResponse)

Cria um erro de repouso com base em uma mensagem de erro e uma resposta PathUnchecked

function createRestError(message: string, response: PathUncheckedResponse): RestError

Parâmetros

message

string

response
PathUncheckedResponse

Retornos

RestError

getClient(string, ClientOptions)

Cria um cliente com um pipeline padrão

function getClient(endpoint: string, options?: ClientOptions): Client

Parâmetros

endpoint

string

Ponto de extremidade base para o cliente

options
ClientOptions

Opções do cliente

Retornos

Client

getClient(string, TokenCredential | KeyCredential, ClientOptions)

Cria um cliente com um pipeline padrão

function getClient(endpoint: string, credentials?: TokenCredential | KeyCredential, options?: ClientOptions): Client

Parâmetros

endpoint

string

Ponto de extremidade base para o cliente

credentials

TokenCredential | KeyCredential

Credenciais para autenticar as solicitações

options
ClientOptions

Opções do cliente

Retornos

Client

operationOptionsToRequestParameters(OperationOptions)

Função auxiliar para converter OperationOptions em RequestParameters

function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters

Parâmetros

options
OperationOptions

as opções usadas pela camada modular para enviar a solicitação

Retornos

RequestParameters

o resultado da conversão em RequestParameters da camada RLC