ServiceClientOptions interface

Paket:

@azure/ms-rest-js

İstemci oluşturulurken sağlanacak seçenekler.

Özellikler

agentSettings	Her HTTP isteği için kullanılacak HTTP ve HTTPS aracıları (yalnızca Node.js).
baseUri	Belirtilirse: Bu baseUri , bu ServiceClient için isteklerin yapılacağı temel URI olur. bilinen baseUri bir kaynak yöneticisi uç noktasıyla eşleşiyorsa ve oluşturucu aracılığıyla bir TokenCredential geçirildiyse, bubaseUri, kapsamı olarak ${options.baseUri}/.defaulttanımlargetToken. Aksi takdirde kapsam varsayılan olarak "https://management.azure.com/.default". Belirtilmezse: Tüm OperationSpecs bir baseUrl özelliği içermelidir. oluşturucudan TokenCredential geçirildiyse, getToken kapsam "https://management.azure.com/.default"" olarak ayarlanır.
clientRequestIdHeaderName	Belirtilirse, HTTP işlem hattına bu üst bilgi adına ve istek kimliği olarak rastgele bir UUID'ye sahip tüm giden isteklere üst bilgi ekleyecek bir GenerateRequestIdPolicy eklenir.
deserializationContentTypes	JSON veya XML serileştirme ile ilişkilendirilecek içerik türleri.
generateClientRequestIdHeader	Her HTTP isteği için bir istemci istek kimliği üst bilgisi oluşturulup oluşturulmayacağı.
httpClient	HTTP istekleri göndermek için kullanılacak HttpClient.
httpPipelineLogger	HTTP işlem hattı içinde RequestPolicies hatalarını ayıklamak için kullanılabilecek HttpPipelineLogger.
noRetryPolicy	true olarak ayarlanırsa, varsayılan yeniden deneme ilkesini kapatın.
proxySettings	Her HTTP isteği için kullanılacak ara sunucu ayarları (yalnızca Node.js).
redirectOptions	Yeniden yönlendirme yanıtlarının nasıl işlenme seçenekleri.
requestPolicyFactories	Tel üzerinde HTTP isteği göndermek için kullanılan RequestPolicy işlem hattını oluşturmak için çağrılan fabrika dizisi veya defaultRequestPolicyFactories değerini alıp kullanılacak requestPolicyFactories'i döndüren bir işlev.
rpRegistrationRetryTimeout	AutomaticRPRegistration için yeniden deneme zaman aşımını saniye olarak alır veya ayarlar. Varsayılan değer 30’dur.
userAgent	İstek gönderilirken telemetri üst bilgisine ayarlanacak dize veya varsayılan kullanıcı aracısı dizesini alan ve kullanılacak kullanıcı aracısı dizesini döndüren bir işlev.
userAgentHeaderName	İstek gönderilirken telemetri üst bilgisi için kullanılacak üst bilgi adı. Bu belirtilmezse, Node.js üzerinde çalıştırılırken "User-Agent" kullanılır ve tarayıcıda çalışırken "x-ms-command-name" kullanılır.
withCredentials	Tarayıcıdaki CORS isteklerine kimlik bilgilerinin eklenip eklenmeyeceği. Daha fazla bilgi edinmek için bkz. https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

Özellik Ayrıntıları

agentSettings

Her HTTP isteği için kullanılacak HTTP ve HTTPS aracıları (yalnızca Node.js).

agentSettings?: AgentSettings

Özellik Değeri

AgentSettings

baseUri

Belirtilirse:

• Bu baseUri , bu ServiceClient için isteklerin yapılacağı temel URI olur.
• bilinen baseUri bir kaynak yöneticisi uç noktasıyla eşleşiyorsa ve oluşturucu aracılığıyla bir TokenCredential geçirildiyse, bubaseUri, kapsamı olarak ${options.baseUri}/.defaulttanımlargetToken. Aksi takdirde kapsam varsayılan olarak "https://management.azure.com/.default".

Belirtilmezse:

• Tüm OperationSpecs bir baseUrl özelliği içermelidir.
• oluşturucudan TokenCredential geçirildiyse, getToken kapsam "https://management.azure.com/.default"" olarak ayarlanır.

baseUri?: string

Özellik Değeri

string

clientRequestIdHeaderName

Belirtilirse, HTTP işlem hattına bu üst bilgi adına ve istek kimliği olarak rastgele bir UUID'ye sahip tüm giden isteklere üst bilgi ekleyecek bir GenerateRequestIdPolicy eklenir.

clientRequestIdHeaderName?: string

Özellik Değeri

string

deserializationContentTypes

JSON veya XML serileştirme ile ilişkilendirilecek içerik türleri.

deserializationContentTypes?: DeserializationContentTypes

Özellik Değeri

DeserializationContentTypes

generateClientRequestIdHeader

Her HTTP isteği için bir istemci istek kimliği üst bilgisi oluşturulup oluşturulmayacağı.

generateClientRequestIdHeader?: boolean

Özellik Değeri

boolean

httpClient

HTTP istekleri göndermek için kullanılacak HttpClient.

httpClient?: HttpClient

Özellik Değeri

HttpClient

httpPipelineLogger

HTTP işlem hattı içinde RequestPolicies hatalarını ayıklamak için kullanılabilecek HttpPipelineLogger.

httpPipelineLogger?: HttpPipelineLogger

Özellik Değeri

HttpPipelineLogger

noRetryPolicy

true olarak ayarlanırsa, varsayılan yeniden deneme ilkesini kapatın.

noRetryPolicy?: boolean

Özellik Değeri

boolean

proxySettings

Her HTTP isteği için kullanılacak ara sunucu ayarları (yalnızca Node.js).

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

redirectOptions

Yeniden yönlendirme yanıtlarının nasıl işlenme seçenekleri.

redirectOptions?: RedirectOptions

Özellik Değeri

RedirectOptions

requestPolicyFactories

Tel üzerinde HTTP isteği göndermek için kullanılan RequestPolicy işlem hattını oluşturmak için çağrılan fabrika dizisi veya defaultRequestPolicyFactories değerini alıp kullanılacak requestPolicyFactories'i döndüren bir işlev.

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

Özellik Değeri

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

rpRegistrationRetryTimeout

AutomaticRPRegistration için yeniden deneme zaman aşımını saniye olarak alır veya ayarlar. Varsayılan değer 30’dur.

rpRegistrationRetryTimeout?: number

Özellik Değeri

number

userAgent

İstek gönderilirken telemetri üst bilgisine ayarlanacak dize veya varsayılan kullanıcı aracısı dizesini alan ve kullanılacak kullanıcı aracısı dizesini döndüren bir işlev.

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

Özellik Değeri

string | (defaultUserAgent: string) => string

userAgentHeaderName

İstek gönderilirken telemetri üst bilgisi için kullanılacak üst bilgi adı. Bu belirtilmezse, Node.js üzerinde çalıştırılırken "User-Agent" kullanılır ve tarayıcıda çalışırken "x-ms-command-name" kullanılır.

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

Özellik Değeri

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Tarayıcıdaki CORS isteklerine kimlik bilgilerinin eklenip eklenmeyeceği. Daha fazla bilgi edinmek için bkz. https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.

withCredentials?: boolean

Özellik Değeri

boolean