@azure/core-client package

Classes

ServiceClient

Inicializa uma nova instância do ServiceClient.

Interfaces

AdditionalPolicyConfig	Utilizado para configurar políticas adicionais adicionadas ao pipeline na construção.
BaseMapper	A definição base de um mapeador. Pode ser utilizado para objetos XML e JavaScript simples.
CommonClientOptions	O conjunto comum de opções que se espera que os clientes de alto nível exponham.
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 noutros mapeadores. Apenas deve estar presente uma das seguintes propriedades: classNamee modelPropertiesadditionalProperties.
DeserializationContentTypes	Os tipos de conteúdo que irão indicar que uma resposta de operação deve ser desserializada de uma forma específica.
DeserializationPolicyOptions	Opções para configurar a desserialização da resposta da API.
DictionaryMapper	Um mapeador que descreve objetos JavaScript simples utilizados 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 pedido http e resposta. O objeto desserializado é armazenado na parsedBody propriedade quando o corpo da resposta é recebido em JSON ou XML.
InternalClientPipelineOptions	Opções para criar um Pipeline para utilizar com o ServiceClient. Principalmente para personalizar a política de autenticação (se utilizar a autenticação do token) ou as opções de desserialização ao utilizar XML.
MapperConstraints	Descrição de várias restrições de valores, como intervalos de números inteiros e regex de cadeias.
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 da Operação expandem.
OperationQueryParameter	Um parâmetro para uma operação que será adicionada como um parâmetro de consulta ao pedido HTTP da operação.
OperationRequestInfo	Metadados que são utilizados para analisar corretamente uma resposta.
OperationRequestOptions	Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.
OperationResponseMap	Uma OperationResponse que pode ser devolvida a partir de um pedido de operação para um único código de estado.
OperationSpec	Uma especificação que define uma operação.
OperationURLParameter	Um parâmetro para uma operação que será substituída pelo URL de pedido 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 pode ser utilizado para determinar como anular a serialização da resposta ao tipo correto.
SequenceMapper	Um mapeador que descreve as 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 pedidos de API.
Serializer	Utilizado para mapear objetos de resposta não processados 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 extrair valores de cabeçalhos, bem como inserir valores e constantes predefinidos.
SerializerOptions	Opções para configurar o comportamento de serialização/des serialização.
ServiceClientOptions	Opções a fornecer ao criar o cliente.
SimpleMapperType	O tipo de um mapeador simples.
SpanConfig	Configuração para criar um novo Tracing Span
XmlOptions	Opções para governar o comportamento do analisador xml e do construtor.

Aliases de Tipo

Mapper	Os mapeadores são definições dos modelos de dados utilizados na biblioteca. Estes 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 verificação linguística futura.
ParameterPath	Codifica como aceder a uma determinada propriedade num objeto.
QueryCollectionFormat	O formato que será utilizado para associar 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 pedida. Pode ser chamado várias vezes.

Funções

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)	Esta função pode ser utilizada como uma chamada de retorno para o bearerTokenAuthenticationPolicy de @azure/core-rest-pipeline, para suportar desafios de CAE: 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 bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({ authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge }); Depois de fornecida, a bearerTokenAuthenticationPolicy política irá lidar internamente com os desafios da Avaliação de Acesso Contínuo (CAE). Quando não conseguir concluir um desafio, devolverá a resposta 401 (não autorizada) do ARM. Desafio de exemplo com afirmações: Bearer authorization_uri="https://login.windows-ppe.net/", error="invalid_token", error_description="User session has been revoked", claims="eyJhY2Nlc3NfdG9rZW4iOnsibmJmIjp7ImVzc2VudGlhbCI6dHJ1ZSwgInZhbHVlIjoiMTYwMzc0MjgwMCJ9fX0="
authorizeRequestOnTenantChallenge(AuthorizeRequestOnChallengeOptions)	Define uma chamada de retorno para lidar com o desafio de autenticação das APIs de Armazenamento. Isto implementa o processo de desafio do portador descrito aqui: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge o processamento tem funcionalidades específicas de armazenamento que partem para os documentos gerais de desafio do AAD.
createClientPipeline(InternalClientPipelineOptions)	Cria um novo Pipeline para utilização com um Cliente de Serviço. Adiciona em deserializationPolicy por predefinição. Também adiciona o bearerTokenAuthenticationPolicy se for transmitido um TokenCredential.
createSerializer({[key: string]: any}, boolean)	Método que cria e devolve um Serializador.
deserializationPolicy(DeserializationPolicyOptions)	Esta política processa a análise de respostas de acordo com OperationSpecs no pedido.
serializationPolicy(SerializationPolicyOptions)	Esta política processa a montagem do corpo e dos cabeçalhos do pedido com um OperationSpec e OperationArguments no pedido.

Detalhes de Função

authorizeRequestOnClaimChallenge(AuthorizeRequestOnChallengeOptions)

Esta função pode ser utilizada como uma chamada de retorno para o bearerTokenAuthenticationPolicy de @azure/core-rest-pipeline, para suportar desafios de CAE: 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 bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy({
  authorizeRequestOnChallenge: authorizeRequestOnClaimChallenge
});

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

Desafio de exemplo com afirmaçõ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 uma chamada de retorno para lidar com o desafio de autenticação das APIs de Armazenamento. Isto implementa o processo de desafio do portador descrito aqui: https://docs.microsoft.com/rest/api/storageservices/authorize-with-azure-active-directory#bearer-challenge o processamento tem funcionalidades específicas de 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 utilização com um Cliente de Serviço. Adiciona em deserializationPolicy por predefinição. Também adiciona o bearerTokenAuthenticationPolicy se for transmitido 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 devolve um Serializador.

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

Parâmetros

modelMappers

{[key: string]: any}

Modelos conhecidos a mapear

isXML

boolean

Se o XML tiver de ser suportado

Devoluções

Serializer

deserializationPolicy(DeserializationPolicyOptions)

Esta política processa a análise de respostas de acordo com OperationSpecs no pedido.

function deserializationPolicy(options?: DeserializationPolicyOptions): PipelinePolicy

Parâmetros

options

DeserializationPolicyOptions

Devoluções

PipelinePolicy

serializationPolicy(SerializationPolicyOptions)

Esta política processa a montagem do corpo e dos cabeçalhos do pedido com um OperationSpec e OperationArguments no pedido.

function serializationPolicy(options?: SerializationPolicyOptions): PipelinePolicy

Parâmetros

options

SerializationPolicyOptions

Devoluções

PipelinePolicy