@azure-rest/core-client package
Interfaces
| AddCredentialPipelinePolicyOptions |
Parâmetros opcionais para adicionar uma política de credenciais ao pipeline. |
| AdditionalPolicyConfig |
Usado para configurar políticas adicionais adicionadas ao pipeline na construção. |
| Client |
Forma de um cliente de nível de descanso |
| ErrorModel |
O objeto de erro. |
| ErrorResponse |
Uma resposta contendo detalhes do erro. |
| FullOperationResponse |
Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na propriedade |
| 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. |
| NodeJSReadableStream |
Um fluxo Node.js legível que também tem um |
| 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 a 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 de descanso 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 |
Tipo auxiliar usado para detetar parâmetros em um texto de modelo de caminho cercado por {} será considerado um parâmetro de caminho |
| PathUnchecked |
Define a assinatura para pathUnchecked. |
| PathUncheckedResponse |
Tipo a ser usado com pathUnchecked, substitui o tipo de corpo para qualquer para permitir flexibilidade |
| RawResponseCallback |
Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. Este retorno de chamada será chamado com dois parâmetros: a resposta bruta, incluindo cabeçalhos e corpo de resposta; e um objeto de erro que será fornecido se um erro foi lançado 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 |
| 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 suporta a obtenção do corpo de resposta como um fluxo bruto |
Funções
| add |
Adiciona uma política de credenciais ao pipeline se uma credencial for fornecida. Se nenhuma for fornecida, nenhuma política será adicionada. |
| create |
Cria um erro de repouso a partir de uma resposta PathUnchecked |
| create |
Cria um erro de repouso a partir de uma mensagem de erro e uma resposta PathUnchecked |
| get |
Cria um cliente com um pipeline padrão |
| get |
Cria um cliente com um pipeline padrão |
| operation |
Função auxiliar para converter OperationOptions em RequestParameters |
Detalhes de Função
addCredentialPipelinePolicy(Pipeline, string, AddCredentialPipelinePolicyOptions)
Adiciona uma política de credenciais 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
createRestError(PathUncheckedResponse)
Cria um erro de repouso a partir de uma resposta PathUnchecked
function createRestError(response: PathUncheckedResponse): RestError
Parâmetros
- response
- PathUncheckedResponse
Devoluções
createRestError(string, PathUncheckedResponse)
Cria um erro de repouso a partir de uma mensagem de erro e uma resposta PathUnchecked
function createRestError(message: string, response: PathUncheckedResponse): RestError
Parâmetros
- message
-
string
- response
- PathUncheckedResponse
Devoluções
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
Devoluções
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
Credenciais para autenticar as solicitações
- options
- ClientOptions
Opções do cliente
Devoluções
operationOptionsToRequestParameters(OperationOptions)
Função auxiliar para converter OperationOptions em RequestParameters
function operationOptionsToRequestParameters(options: OperationOptions): RequestParameters
Parâmetros
- options
- OperationOptions
as opções que são usadas pela camada modular para enviar a solicitação
Devoluções
o resultado da conversão em RequestParameters da camada RLC