@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 se espera que os clientes de alto nível expõem.
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 de 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 enum.
EnumMapperType	Ajuda a criar um mapeador que descreve como analisar um valor de enum.
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 para usar com ServiceClient. Principalmente para personalizar a política de autenticação (se estiver usando token auth) 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 Operation estendem.
OperationQueryParameter	Um parâmetro para uma operação que será adicionado como um parâmetro de consulta à solicitação HTTP da operação.
OperationRequestInfo	Metadados que são 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 tipo discriminado. Por exemplo, se a resposta pode ter muitas formas, mas também inclui um campo 'tipo' (ou similar), esse campo pode ser usado para determinar como desserializar a resposta para o tipo correto.
SequenceMapper	Um mapeador descrevendo 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 bruta para formas finais. Ajuda a embalar e desembalar datas e outros tipos codificados que não são intrínsecos ao JSON. Também permite extrair valores de cabeçalhos, bem como inserir valores padrão e constantes.
SerializerOptions	Opções para configurar o comportamento de serialização/desserializaçã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 uma nova extensão de rastreamento
XmlOptions	Opções para governar o comportamento do analisador e construtor xml.

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 preparação 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 cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

Funções

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Esta função pode ser usada como um retorno de chamada para o `bearerTokenAuthenticationPolicy` de `@azure/core-rest-pipeline`, para suportar os desafios CAE: Avaliação de Acesso Contínuo. Ligue para 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 da Avaliação Contínua de Acesso (CAE). Quando não conseguir concluir um desafio, ele retornará a resposta 401 (não autorizada) da ARM. Exemplo de contestação com reivindicaçõ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 ao portador descrito aqui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling 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 deserializationPolicy por padrão. Também adiciona em bearerTokenAuthenticationPolicy se passou um TokenCredential.
createSerializer({[key: string]: any}, boolean)	Método que cria e retorna um Serializer.
deserializationPolicy(DeserializationPolicyOptions)	Esta política lida com a análise de respostas de acordo com OperationSpecs na solicitação.
serializationPolicy(SerializationPolicyOptions)	Esta política lida com a montagem do corpo da solicitação e cabeçalhos usando um OperationSpec e OperationArguments na solicitação.

Detalhes de Função

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

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

Ligue para 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 da Avaliação Contínua de Acesso (CAE). Quando não conseguir concluir um desafio, ele retornará a resposta 401 (não autorizada) da ARM.

Exemplo de contestação com reivindicaçõ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

Devoluções

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 ao portador descrito aqui: https://learn.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge Handling 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

Devoluções

Promise<boolean>

createClientPipeline(InternalClientPipelineOptions)

Cria um novo Pipeline para uso com um Cliente de Serviço. Adiciona em deserializationPolicy por padrão. Também adiciona em bearerTokenAuthenticationPolicy se passou um TokenCredential.

function createClientPipeline(options?: InternalClientPipelineOptions): Pipeline

Parâmetros

options: InternalClientPipelineOptions

Opções para personalizar o pipeline criado.

Devoluções

Pipeline

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

Método que cria e retorna um Serializer.

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

Parâmetros

modelMappers: {[key: string]: any}

Modelos conhecidos para mapear

isXML: boolean

Se o XML deve ser suportado

Devoluções

Serializer

deserializationPolicy(DeserializationPolicyOptions)

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

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parâmetros

options: DeserializationPolicyOptions

Devoluções

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Esta política lida com a montagem do corpo da solicitação e cabeçalhos usando um OperationSpec e OperationArguments na solicitação.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parâmetros

options: SerializationPolicyOptions

Devoluções

PipelinePolicy

Partilhar via

@azure/core-client package

Classes

Interfaces

Aliases de Tipo

Funções

Detalhes de Função

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Parâmetros

Devoluções

authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)

Parâmetros

Devoluções

createClientPipeline(InternalClientPipelineOptions)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

deserializationPolicy(DeserializationPolicyOptions)

Parâmetros

Devoluções

serializationPolicy(SerializationPolicyOptions)

Parâmetros

Devoluções

Recursos adicionais