SynapseClientOptions interface

Uma interface que representa synapseClientOptions.

Extends
@azure/ms-rest-azure-js.AzureServiceClientOptions

Propriedades

livyApiVersion

Versão de API válida para a solicitação. Valor padrão: '2019-11-01-preview'.

synapseDnsSuffix

Obtém o sufixo DNS usado como base para todas as solicitações de serviço do Synapse. Valor padrão: 'azuresynapse.net'.

Propriedades herdadas

acceptLanguage

Obtém ou define o idioma preferencial para a resposta. O valor padrão é: "en-US".

agentSettings

Agentes HTTP e HTTPS que serão usados para cada solicitação HTTP (somenteNode.js).

baseUri

Se especificado:

  • Esse baseUri se torna o URI base no qual as solicitações serão feitas para esse ServiceClient.
  • Se o baseUri corresponder a um ponto de extremidade conhecido do gerenciador de recursos e se um TokenCredential tiver sido passado pelo construtor, esse baseUri definirá o escopo getToken a ser ${options.baseUri}/.default. Caso contrário, o escopo seria padrão para "https://management.azure.com/.default".

Se não for especificado:

  • Todos os OperationSpecs devem conter uma propriedade baseUrl.
  • Se um TokenCredential foi passado pelo construtor, o escopo do getToken será definido como "https://management.azure.com/.default".
clientRequestIdHeaderName

Se especificado, um GenerateRequestIdPolicy será adicionado ao pipeline HTTP que adicionará um cabeçalho a todas as solicitações de saída com esse nome de cabeçalho e uma UUID aleatória como a ID da solicitação.

deserializationContentTypes

Os tipos de conteúdo que serão associados à serialização JSON ou XML.

generateClientRequestIdHeader

Se deve ou não gerar um cabeçalho de ID de solicitação do cliente para cada solicitação HTTP.

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpPipelineLogger

O HttpPipelineLogger que pode ser usado para depurar RequestPolicies no pipeline HTTP.

longRunningOperationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

noRetryPolicy

Se definido como true, desative a política de repetição padrão.

proxySettings

Configurações de proxy que serão usadas para cada solicitação HTTP (somenteNode.js).

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy usado para enviar uma solicitação HTTP no fio ou uma função que usa o defaultRequestPolicyFactories e retorna o requestPolicyFactories que será usado.

rpRegistrationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor padrão é 30.

userAgent

A cadeia de caracteres a ser definida como o cabeçalho de telemetria ao enviar a solicitação ou uma função que usa a cadeia de caracteres padrão do agente do usuário e retorna a cadeia de caracteres de agente de usuário que será usada.

userAgentHeaderName

O nome do cabeçalho a ser usado para o cabeçalho de telemetria ao enviar a solicitação. Se isso não for especificado, "User-Agent" será usado ao executar em Node.js e "x-ms-command-name" será usado ao executar em um navegador.

withCredentials

Se deve incluir credenciais em solicitações CORS no navegador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

Detalhes da propriedade

livyApiVersion

Versão de API válida para a solicitação. Valor padrão: '2019-11-01-preview'.

livyApiVersion?: string

Valor da propriedade

string

synapseDnsSuffix

Obtém o sufixo DNS usado como base para todas as solicitações de serviço do Synapse. Valor padrão: 'azuresynapse.net'.

synapseDnsSuffix?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

acceptLanguage

Obtém ou define o idioma preferencial para a resposta. O valor padrão é: "en-US".

acceptLanguage?: string

Valor da propriedade

string

herdado de AzureServiceClientOptions.acceptLanguage

agentSettings

Agentes HTTP e HTTPS que serão usados para cada solicitação HTTP (somenteNode.js).

agentSettings?: AgentSettings

Valor da propriedade

herdado de AzureServiceClientOptions.agentSettings

baseUri

Se especificado:

  • Esse baseUri se torna o URI base no qual as solicitações serão feitas para esse ServiceClient.
  • Se o baseUri corresponder a um ponto de extremidade conhecido do gerenciador de recursos e se um TokenCredential tiver sido passado pelo construtor, esse baseUri definirá o escopo getToken a ser ${options.baseUri}/.default. Caso contrário, o escopo seria padrão para "https://management.azure.com/.default".

Se não for especificado:

  • Todos os OperationSpecs devem conter uma propriedade baseUrl.
  • Se um TokenCredential foi passado pelo construtor, o escopo do getToken será definido como "https://management.azure.com/.default".
baseUri?: string

Valor da propriedade

string

herdado de AzureServiceClientOptions.baseUri

clientRequestIdHeaderName

Se especificado, um GenerateRequestIdPolicy será adicionado ao pipeline HTTP que adicionará um cabeçalho a todas as solicitações de saída com esse nome de cabeçalho e uma UUID aleatória como a ID da solicitação.

clientRequestIdHeaderName?: string

Valor da propriedade

string

Herdado de AzureServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Os tipos de conteúdo que serão associados à serialização JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valor da propriedade

herdado de AzureServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Se deve ou não gerar um cabeçalho de ID de solicitação do cliente para cada solicitação HTTP.

generateClientRequestIdHeader?: boolean

Valor da propriedade

boolean

Herdado de AzureServiceClientOptions.generateClientRequestIdHeader

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor da propriedade

herdado de AzureServiceClientOptions.httpClient

httpPipelineLogger

O HttpPipelineLogger que pode ser usado para depurar RequestPolicies no pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valor da propriedade

herdado de AzureServiceClientOptions.httpPipelineLogger

longRunningOperationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para Operações de Execução Longa. O valor padrão é 30.

longRunningOperationRetryTimeout?: number

Valor da propriedade

number

herdado de AzureServiceClientOptions.longRunningOperationRetryTimeout

noRetryPolicy

Se definido como true, desative a política de repetição padrão.

noRetryPolicy?: boolean

Valor da propriedade

boolean

herdado de AzureServiceClientOptions.noRetryPolicy

proxySettings

Configurações de proxy que serão usadas para cada solicitação HTTP (somenteNode.js).

proxySettings?: ProxySettings

Valor da propriedade

herdado de AzureServiceClientOptions.proxySettings

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectOptions

Valor da propriedade

herdado de AzureServiceClientOptions.redirectOptions

requestPolicyFactories

Uma matriz de fábricas que são chamadas para criar o pipeline RequestPolicy usado para enviar uma solicitação HTTP no fio ou uma função que usa o defaultRequestPolicyFactories e retorna o requestPolicyFactories que será usado.

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

Valor da propriedade

RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

herdado de AzureServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtém ou define o tempo limite de repetição em segundos para AutomaticRPRegistration. O valor padrão é 30.

rpRegistrationRetryTimeout?: number

Valor da propriedade

number

herdado de AzureServiceClientOptions.rpRegistrationRetryTimeout

userAgent

A cadeia de caracteres a ser definida como o cabeçalho de telemetria ao enviar a solicitação ou uma função que usa a cadeia de caracteres padrão do agente do usuário e retorna a cadeia de caracteres de agente de usuário que será usada.

userAgent?: string | (defaultUserAgent: string) => string

Valor da propriedade

string | (defaultUserAgent: string) => string

herdado de AzureServiceClientOptions.userAgent

userAgentHeaderName

O nome do cabeçalho a ser usado para o cabeçalho de telemetria ao enviar a solicitação. Se isso não for especificado, "User-Agent" será usado ao executar em Node.js e "x-ms-command-name" será usado ao executar em um navegador.

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

Valor da propriedade

string | (defaultUserAgentHeaderName: string) => string

Herdado de AzureServiceClientOptions.userAgentHeaderName

withCredentials

Se deve incluir credenciais em solicitações CORS no navegador. Consulte https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials para obter mais informações.

withCredentials?: boolean

Valor da propriedade

boolean

herdado de AzureServiceClientOptions.withCredentials