ServiceClientOptions interface

Pakket:

@azure/ms-rest-js

Opties die moeten worden opgegeven tijdens het maken van de client.

Eigenschappen

agentSettings	HTTP- en HTTPS-agents die worden gebruikt voor elke HTTP-aanvraag (alleenNode.js).
baseUri	Indien opgegeven: Deze baseUri wordt de basis-URI waarmee aanvragen worden gedaan voor deze ServiceClient. Als de baseUri overeenkomt met een bekend resource manager-eindpunt en als er een TokenCredential is doorgegeven via de constructor, definieert dit baseUri het getToken bereik dat moet worden ${options.baseUri}/.default. Anders wordt het bereik standaard ingesteld op 'https://management.azure.com/.default". Als dit niet is opgegeven: Alle OperationSpecs moet een baseUrl-eigenschap bevatten. Als een TokenCredential is doorgegeven via de constructor, wordt het getToken bereik ingesteld op 'https://management.azure.com/.default".
clientRequestIdHeaderName	Indien opgegeven, wordt een GenerateRequestIdPolicy toegevoegd aan de HTTP-pijplijn waarmee een header wordt toegevoegd aan alle uitgaande aanvragen met deze headernaam en een willekeurige UUID als de aanvraag-id.
deserializationContentTypes	De inhoudstypen die worden gekoppeld aan JSON- of XML-serialisatie.
generateClientRequestIdHeader	Of u wel of niet een header voor clientaanvraag-id's voor elke HTTP-aanvraag wilt genereren.
httpClient	De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.
httpPipelineLogger	HttpPipelineLogger die kan worden gebruikt voor het opsporen van fouten in RequestPolicies in de HTTP-pijplijn.
noRetryPolicy	Als dit is ingesteld op waar, schakelt u het standaardbeleid voor opnieuw proberen uit.
proxySettings	Proxy-instellingen die worden gebruikt voor elke HTTP-aanvraag (alleenNode.js).
redirectOptions	Opties voor de manier waarop omleidingsreacties worden verwerkt.
requestPolicyFactories	Een matrix van factory's die worden aangeroepen om de RequestPolicy-pijplijn te maken die wordt gebruikt voor het verzenden van een HTTP-aanvraag op de wire, of een functie die de defaultRequestPolicyFactories gebruikt en retourneert de requestPolicyFactories die worden gebruikt.
rpRegistrationRetryTimeout	Hiermee haalt u de time-out voor opnieuw proberen in seconden op voor AutomaticRPRegistration. De standaardwaarde is 30.
userAgent	De tekenreeks die moet worden ingesteld op de telemetrieheader tijdens het verzenden van de aanvraag, of een functie die de standaardtekenreeks van de gebruikersagent gebruikt, retourneert de tekenreeks van de gebruiker-agent die wordt gebruikt.
userAgentHeaderName	De headernaam die moet worden gebruikt voor de telemetrieheader tijdens het verzenden van de aanvraag. Als dit niet is opgegeven, wordt 'User-Agent' gebruikt wanneer deze wordt uitgevoerd op Node.js en 'x-ms-command-name' wordt gebruikt bij uitvoering in een browser.
withCredentials	Of u referenties wilt opnemen in CORS-aanvragen in de browser. Zie https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials voor meer informatie.

Eigenschapdetails

agentSettings

HTTP- en HTTPS-agents die worden gebruikt voor elke HTTP-aanvraag (alleenNode.js).

agentSettings?: AgentSettings

Waarde van eigenschap

AgentSettings

baseUri

Indien opgegeven:

• Deze baseUri wordt de basis-URI waarmee aanvragen worden gedaan voor deze ServiceClient.
• Als de baseUri overeenkomt met een bekend resource manager-eindpunt en als er een TokenCredential is doorgegeven via de constructor, definieert dit baseUri het getToken bereik dat moet worden ${options.baseUri}/.default. Anders wordt het bereik standaard ingesteld op 'https://management.azure.com/.default".

Als dit niet is opgegeven:

• Alle OperationSpecs moet een baseUrl-eigenschap bevatten.
• Als een TokenCredential is doorgegeven via de constructor, wordt het getToken bereik ingesteld op 'https://management.azure.com/.default".

baseUri?: string

Waarde van eigenschap

string

clientRequestIdHeaderName

Indien opgegeven, wordt een GenerateRequestIdPolicy toegevoegd aan de HTTP-pijplijn waarmee een header wordt toegevoegd aan alle uitgaande aanvragen met deze headernaam en een willekeurige UUID als de aanvraag-id.

clientRequestIdHeaderName?: string

Waarde van eigenschap

string

deserializationContentTypes

De inhoudstypen die worden gekoppeld aan JSON- of XML-serialisatie.

deserializationContentTypes?: DeserializationContentTypes

Waarde van eigenschap

DeserializationContentTypes

generateClientRequestIdHeader

Of u wel of niet een header voor clientaanvraag-id's voor elke HTTP-aanvraag wilt genereren.

generateClientRequestIdHeader?: boolean

Waarde van eigenschap

boolean

httpClient

De HttpClient die wordt gebruikt voor het verzenden van HTTP-aanvragen.

httpClient?: HttpClient

Waarde van eigenschap

HttpClient

httpPipelineLogger

HttpPipelineLogger die kan worden gebruikt voor het opsporen van fouten in RequestPolicies in de HTTP-pijplijn.

httpPipelineLogger?: HttpPipelineLogger

Waarde van eigenschap

HttpPipelineLogger

noRetryPolicy

Als dit is ingesteld op waar, schakelt u het standaardbeleid voor opnieuw proberen uit.

noRetryPolicy?: boolean

Waarde van eigenschap

boolean

proxySettings

Proxy-instellingen die worden gebruikt voor elke HTTP-aanvraag (alleenNode.js).

proxySettings?: ProxySettings

Waarde van eigenschap

ProxySettings

redirectOptions

Opties voor de manier waarop omleidingsreacties worden verwerkt.

redirectOptions?: RedirectOptions

Waarde van eigenschap

RedirectOptions

requestPolicyFactories

Een matrix van factory's die worden aangeroepen om de RequestPolicy-pijplijn te maken die wordt gebruikt voor het verzenden van een HTTP-aanvraag op de wire, of een functie die de defaultRequestPolicyFactories gebruikt en retourneert de requestPolicyFactories die worden gebruikt.

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

Waarde van eigenschap

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

rpRegistrationRetryTimeout

Hiermee haalt u de time-out voor opnieuw proberen in seconden op voor AutomaticRPRegistration. De standaardwaarde is 30.

rpRegistrationRetryTimeout?: number

Waarde van eigenschap

number

userAgent

De tekenreeks die moet worden ingesteld op de telemetrieheader tijdens het verzenden van de aanvraag, of een functie die de standaardtekenreeks van de gebruikersagent gebruikt, retourneert de tekenreeks van de gebruiker-agent die wordt gebruikt.

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

Waarde van eigenschap

string | (defaultUserAgent: string) => string

userAgentHeaderName

De headernaam die moet worden gebruikt voor de telemetrieheader tijdens het verzenden van de aanvraag. Als dit niet is opgegeven, wordt 'User-Agent' gebruikt wanneer deze wordt uitgevoerd op Node.js en 'x-ms-command-name' wordt gebruikt bij uitvoering in een browser.

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

Waarde van eigenschap

string | (defaultUserAgentHeaderName: string) => string

withCredentials

Of u referenties wilt opnemen in CORS-aanvragen in de browser. Zie https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials voor meer informatie.

withCredentials?: boolean

Waarde van eigenschap

boolean