DeviceUpdateClientOptionalParams interface

Paket:

@azure/iot-device-update

İsteğe bağlı parametreler.

Extends

ServiceClientOptions

Özellikler

endpoint

İstemci uç noktasını geçersiz kılar.

Devralınan Özellikler

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.
credentialScopes	Belirtilirse, BearerTokenAuthenticationPolicy derlemek için kullanılır.
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).
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 üzerinde çalışırken "User-Agent" kullanılır ve tarayıcıda çalışırken "x-ms-useragent" 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ı

endpoint

İstemci uç noktasını geçersiz kılar.

endpoint?: string

Özellik Değeri

string

Devralınan Özellik Detayları

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

çekirdeğinden DevralındıHttp.ServiceClientOptions.clientRequestIdHeaderName

credentialScopes

Belirtilirse, BearerTokenAuthenticationPolicy derlemek için kullanılır.

credentialScopes?: string | string[]

Özellik Değeri

string | string[]

çekirdeğinden DevralındıHttp.ServiceClientOptions.credentialScopes

deserializationContentTypes

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

deserializationContentTypes?: DeserializationContentTypes

Özellik Değeri

DeserializationContentTypes

Çekirdeğinden Devralınan Http.ServiceClientOptions.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

Çekirdeğinden Devralınan Http.ServiceClientOptions.generateClientRequestIdHeader

httpClient

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

httpClient?: HttpClient

Özellik Değeri

HttpClient

çekirdeğinden Devralınan Http.ServiceClientOptions.httpClient

httpPipelineLogger

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

httpPipelineLogger?: HttpPipelineLogger

Özellik Değeri

HttpPipelineLogger

çekirdeğinden Devralınan Http.ServiceClientOptions.httpPipelineLogger

noRetryPolicy

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

noRetryPolicy?: boolean

Özellik Değeri

boolean

çekirdeğinden Devralınan Http.ServiceClientOptions.noRetryPolicy

proxySettings

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

proxySettings?: ProxySettings

Özellik Değeri

ProxySettings

çekirdeğinden DevralındıHttp.ServiceClientOptions.proxySettings

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[]

çekirdeğinden Devralınan Http.ServiceClientOptions.requestPolicyFactories

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

çekirdeğinden Devralınan Http.ServiceClientOptions.rpRegistrationRetryTimeout

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

çekirdeğinden Devralınan Http.ServiceClientOptions.userAgent

userAgentHeaderName

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

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

Özellik Değeri

string | (defaultUserAgentHeaderName: string) => string

Çekirdekten Devralınan Http.ServiceClientOptions.userAgentHeaderName

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

çekirdeğinden Devralınan Http.ServiceClientOptions.withCredentials