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ızcaNode.js).
baseUri	Belirtildiyse: Bu baseUri, bu ServiceClient için istekte bulunulacak temel URI'ye dönüşür. baseUri bilinen bir kaynak yöneticisi uç noktasıyla eşleşiyorsa ve oluşturucudan bir TokenCredential geçirildiyse, bu baseUrigetTokenolacak ${options.baseUri}/.default kapsamını tanımlar. Aksi takdirde, kapsam varsayılan olarak "https://management.azure.com/.default". Belirtilmezse: Tüm OperationSpecs bir baseUrl özelliği içermelidir. Oluşturucudan bir 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ızcaNode.js).
redirectOptions	Yeniden yönlendirme yanıtlarının nasıl işleneceğini gösteren seçenekler.
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 alan ve kullanılacak requestPolicyFactories değerini döndüren bir işlev.
rpRegistrationRetryTimeout	OtomatikRPRegistration için yeniden deneme zaman aşımını saniyeler içinde 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	İsteği gönderirken telemetri üst bilgisi için kullanılacak üst bilgi adı. Bu belirtilmezse, Node.js çalıştırılırken "User-Agent" kullanılır ve tarayıcıda çalıştırılırken "x-ms-command-name" kullanılır.
withCredentials	Tarayıcıda CORS isteklerine kimlik bilgilerinin eklenip eklenmeyeceği. Daha fazla bilgi 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ızcaNode.js).

agentSettings?: AgentSettings

Özellik Değeri

AgentSettings

baseUri

Belirtildiyse:

• Bu baseUri, bu ServiceClient için istekte bulunulacak temel URI'ye dönüşür.
• baseUri bilinen bir kaynak yöneticisi uç noktasıyla eşleşiyorsa ve oluşturucudan bir TokenCredential geçirildiyse, bu baseUrigetTokenolacak ${options.baseUri}/.default kapsamını tanımlar. Aksi takdirde, kapsam varsayılan olarak "https://management.azure.com/.default".

Belirtilmezse:

• Tüm OperationSpecs bir baseUrl özelliği içermelidir.
• Oluşturucudan bir 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ızcaNode.js).

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

redirectOptions

Yeniden yönlendirme yanıtlarının nasıl işleneceğini gösteren seçenekler.

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 alan ve kullanılacak requestPolicyFactories değerini döndüren bir işlev.

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

Özellik Değeri

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

rpRegistrationRetryTimeout

OtomatikRPRegistration için yeniden deneme zaman aşımını saniyeler içinde 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

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

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

Özellik Değeri

string | (defaultUserAgentHeaderName: string) => string

withCredentials

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

withCredentials?: boolean

Özellik Değeri

boolean