@azure/core-client package

Referência

Classes

Inicializa uma nova instância do ServiceClient.

Interfaces

AdditionalPolicyConfig	Usado para configurar políticas adicionais adicionadas ao pipeline na construção.
BaseMapper	A definição base de um mapeador. Pode ser usado para objetos XML e JavaScript simples.
CommonClientOptions	O conjunto comum de opções que os clientes de alto nível devem expor.
CompositeMapper	Um mapeador composto por outros mapeadores.
CompositeMapperType	Ajuda a criar um mapeador que descreve como mapear um conjunto de propriedades de um objeto com base em outros mapeadores. Apenas uma das seguintes propriedades deve estar presente: `className`, `modelProperties` e `additionalProperties`.
DeserializationContentTypes	Os tipos de conteúdo que indicarão que uma resposta de operação deve ser desserializada de uma maneira específica.
DeserializationPolicyOptions	Opções para configurar a desserialização da resposta da API.
DictionaryMapper	Um mapeador que descreve objetos JavaScript simples usados como pares chave/valor.
DictionaryMapperType	Ajuda a criar um mapeador que descreve como analisar um dicionário de valores mapeados.
EnumMapper	Um mapeador que descreve um valor de enumeração.
EnumMapperType	Ajuda a criar um mapeador que descreve como analisar um valor de enumeração.
FullOperationResponse	Objeto wrapper para solicitação e resposta http. O objeto desserializado é armazenado na propriedade `parsedBody` quando o corpo da resposta é recebido em JSON ou XML.
InternalClientPipelineOptions	Opções para criar um Pipeline a ser usado com o ServiceClient. Principalmente para personalizar a política de autenticação (se estiver usando autenticação de token) ou as opções de desserialização ao usar XML.
MapperConstraints	Descrição de várias restrições de valor, como intervalos inteiros e regex de cadeia de caracteres.
OperationArguments	Uma coleção de propriedades que se aplicam a uma única invocação de uma operação.
OperationOptions	O tipo de opções base para todas as operações.
OperationParameter	Uma interface comum que todos os parâmetros de operação se estendem.
OperationQueryParameter	Um parâmetro para uma operação que será adicionada como um parâmetro de consulta à solicitação HTTP da operação.
OperationRequestInfo	Metadados usados para analisar corretamente uma resposta.
OperationRequestOptions	Opções usadas ao criar e enviar solicitações HTTP para esta operação.
OperationResponseMap	Um OperationResponse que pode ser retornado de uma solicitação de operação para um único código de status.
OperationSpec	Uma especificação que define uma operação.
OperationURLParameter	Um parâmetro para uma operação que será substituída na URL de solicitação da operação.
PolymorphicDiscriminator	Usado para desambiguar uniões de tipos discriminados. Por exemplo, se a resposta puder ter muitas formas, mas também incluir um campo "tipo" (ou semelhante), esse campo poderá ser usado para determinar como desserializar a resposta ao tipo correto.
SequenceMapper	Um mapeador que descreve matrizes.
SequenceMapperType	Ajuda a criar um mapeador que descreve como analisar uma sequência de valores mapeados.
SerializationPolicyOptions	Opções para configurar a serialização de solicitação de API.
Serializer	Usado para mapear objetos de resposta brutos para formas finais. Ajuda a empacotar e desempacotar datas e outros tipos codificados que não são intrínsecos ao JSON. Também permite a extração de valores de cabeçalhos, bem como a inserção de valores e constantes padrão.
SerializerOptions	Opções para configurar o comportamento de serialização/des serialização.
ServiceClientOptions	Opções a serem fornecidas durante a criação do cliente.
SimpleMapperType	O tipo de um mapeador simples.
SpanConfig	Configuração para criar um novo intervalo de rastreamento
XmlOptions	Opções para controlar o comportamento do analisador xml e do construtor.

Aliases de tipo

Mapper	Mapeadores são definições dos modelos de dados usados na biblioteca. Esses modelos de dados fazem parte das definições de operação ou cliente nas respostas ou parâmetros.
MapperType	Tipo do mapeador. Inclui mapeadores conhecidos.
OperationRequest	Um alias de tipo para revisão de texto futura.
ParameterPath	Codifica como alcançar uma propriedade específica em um objeto.
QueryCollectionFormat	O formato que será usado para unir uma matriz de valores para um valor de parâmetro de consulta.
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.

Funções

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Essa função pode ser usada como um retorno de chamada para o `bearerTokenAuthenticationPolicy` de `@azure/core-rest-pipeline`, para dar suporte a desafios de CAE: de Avaliação de Acesso Contínuo. Chame o `bearerTokenAuthenticationPolicy` com as seguintes opções: `import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline"; import { authorizeRequestOnClaimChallenge } from "@azure/core-client"; const policy = bearerTokenAuthenticationPolicy({ challengeCallbacks: { authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge, }, scopes: ["https://service/.default"], });` Uma vez fornecida, a política de `bearerTokenAuthenticationPolicy` lidará internamente com os desafios de CAE (Avaliação de Acesso Contínuo). Quando não conseguir concluir um desafio, retornará a resposta 401 (não autorizada) do ARM. Desafio de exemplo com declarações: `Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="`
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Define um retorno de chamada para lidar com o desafio de autenticação para APIs de Armazenamento. Isso implementa o processo de desafio do portador descrito aqui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Manipulação tem recursos específicos para armazenamento que partem para os documentos gerais de desafio do AAD.
createClientPipeline(InternalClientPipelineOptions)	Cria um novo Pipeline para uso com um cliente de serviço. Adiciona em desserializationPolicy por padrão. Também adicionará bearerTokenAuthenticationPolicy se passar um TokenCredential.
createSerializer({[key: string]: any}, boolean)	Método que cria e retorna um Serializador.
deserializationPolicy(DeserializationPolicyOptions)	Essa política lida com a análise de respostas de acordo com o OperationSpecs na solicitação.
serializationPolicy(SerializationPolicyOptions)	Essa política manipula a montagem do corpo da solicitação e dos cabeçalhos usando um OperationSpec e OperationArguments na solicitação.

Detalhes da função

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Essa função pode ser usada como um retorno de chamada para o bearerTokenAuthenticationPolicy de @azure/core-rest-pipeline, para dar suporte a desafios de CAE: de Avaliação de Acesso Contínuo.

Chame o bearerTokenAuthenticationPolicy com as seguintes opções:

import { bearerTokenAuthenticationPolicy } from "@azure/core-rest-pipeline";
import { authorizeRequestOnClaimChallenge } from "@azure/core-client";

const policy = bearerTokenAuthenticationPolicy({
  challengeCallbacks: {
    authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge,
  },
  scopes: ["https://service/.default"],
});

Uma vez fornecida, a política de bearerTokenAuthenticationPolicy lidará internamente com os desafios de CAE (Avaliação de Acesso Contínuo). Quando não conseguir concluir um desafio, retornará a resposta 401 (não autorizada) do ARM.

Desafio de exemplo com declarações:

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>

Parâmetros

onChallengeOptions: AuthorizeRequestOnChallengeOptions

Retornos

Promise<boolean>

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Define um retorno de chamada para lidar com o desafio de autenticação para APIs de Armazenamento. Isso implementa o processo de desafio do portador descrito aqui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Manipulação tem recursos específicos para armazenamento que partem para os documentos gerais de desafio do AAD.

function authorizeRequestOnTenantChallenge(challengeOptions: AuthorizeRequestOnChallengeOptions): Promise<boolean>

Parâmetros

challengeOptions: AuthorizeRequestOnChallengeOptions

Retornos

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Cria um novo Pipeline para uso com um cliente de serviço. Adiciona em desserializationPolicy por padrão. Também adicionará bearerTokenAuthenticationPolicy se passar um TokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parâmetros

options: InternalClientPipelineOptions

Opções para personalizar o pipeline criado.

Retornos

Pipeline

createSerializer({[key: string]: any}, boolean)

Método que cria e retorna um Serializador.

function createSerializer(modelMappers?: {[key: string]: any}, isXML?: boolean): Serializer

Parâmetros

modelMappers: {[key: string]: any}

Modelos conhecidos a serem mapeados

isXML: boolean

Se for necessário ter suporte para XML

Retornos

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Essa política lida com a análise de respostas de acordo com o OperationSpecs na solicitação.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parâmetros

options: DeserializationPolicyOptions

Retornos

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Essa política manipula a montagem do corpo da solicitação e dos cabeçalhos usando um OperationSpec e OperationArguments na solicitação.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parâmetros

options: SerializationPolicyOptions

Retornos

PipelinePolicy

Compartilhar via

@azure/core-client package

Classes

Interfaces

Aliases de tipo

Funções

Detalhes da função

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parâmetros

Retornos

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parâmetros

Retornos

createClientPipeline(InternalClientPipelineOptions)

Parâmetros

Retornos

createSerializer({[key: string]: any}, boolean)

Parâmetros

Retornos

deserializationPolicy(DeserializationPolicyOptions)

Parâmetros

Retornos

serializationPolicy(SerializationPolicyOptions)

Parâmetros

Retornos

Recursos adicionais