ServiceClientOptions interface
Opzioni da fornire durante la creazione del client.
Proprietà
agent |
Agenti HTTP e HTTPS che verranno usati per ogni richiesta HTTP (solo Node.js). |
base |
Se specificato:
Se non è specificato:
|
client |
Se specificato, alla pipeline HTTP verrà aggiunta un'intestazione GenerateRequestIdPolicy che aggiungerà un'intestazione a tutte le richieste in uscita con questo nome di intestazione e un UUID casuale come ID richiesta. |
deserialization |
Tipi di contenuto che verranno associati alla serializzazione JSON o XML. |
generate |
Indica se generare o meno un'intestazione ID richiesta client per ogni richiesta HTTP. |
http |
HttpClient che verrà usato per inviare richieste HTTP. |
http |
HttpPipelineLogger che può essere usato per eseguire il debug di RequestPolicies all'interno della pipeline HTTP. |
no |
Se impostato su true, disattivare i criteri di ripetizione dei tentativi predefiniti. |
proxy |
Impostazioni proxy che verranno usate per ogni richiesta HTTP (solo Node.js). |
redirect |
Opzioni per la gestione delle risposte di reindirizzamento. |
request |
Matrice di factory che vengono chiamate per creare la pipeline RequestPolicy usata per inviare una richiesta HTTP in transito o una funzione che accetta defaultRequestPolicyFactories e restituisce requestPolicyFactories che verrà usata. |
rp |
Ottiene o imposta il timeout dei tentativi in secondi per AutomaticRPRegistration. Il valore predefinito è 30. |
user |
Stringa da impostare sull'intestazione di telemetria durante l'invio della richiesta o una funzione che accetta la stringa predefinita dell'agente utente e restituisce la stringa dell'agente utente che verrà utilizzata. |
user |
Nome dell'intestazione da usare per l'intestazione di telemetria durante l'invio della richiesta. Se non viene specificato, "User-Agent" verrà usato durante l'esecuzione in Node.js e "x-ms-command-name" verrà usato durante l'esecuzione in un browser. |
with |
Indica se includere le credenziali nelle richieste CORS nel browser. Per altre informazioni, vedere https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials. |
Dettagli proprietà
agentSettings
Agenti HTTP e HTTPS che verranno usati per ogni richiesta HTTP (solo Node.js).
agentSettings?: AgentSettings
Valore della proprietà
baseUri
Se specificato:
- Questo
baseUri
diventa l'URI di base su cui verranno effettuate richieste per questo ServiceClient. - Se corrisponde
baseUri
a un endpoint di Resource Manager noto e se è stato passato unTokenCredential
oggetto tramite il costruttore, questobaseUri
definisce l'ambitogetToken
come${options.baseUri}/.default
. In caso contrario, per impostazione predefinita l'ambito è "https://management.azure.com/.default".
Se non è specificato:
- All OperationSpecs deve contenere una proprietà baseUrl.
- Se un
TokenCredential
oggetto è stato passato attraverso il costruttore, l'ambitogetToken
viene impostato su "https://management.azure.com/.default".
baseUri?: string
Valore della proprietà
string
clientRequestIdHeaderName
Se specificato, alla pipeline HTTP verrà aggiunta un'intestazione GenerateRequestIdPolicy che aggiungerà un'intestazione a tutte le richieste in uscita con questo nome di intestazione e un UUID casuale come ID richiesta.
clientRequestIdHeaderName?: string
Valore della proprietà
string
deserializationContentTypes
Tipi di contenuto che verranno associati alla serializzazione JSON o XML.
deserializationContentTypes?: DeserializationContentTypes
Valore della proprietà
generateClientRequestIdHeader
Indica se generare o meno un'intestazione ID richiesta client per ogni richiesta HTTP.
generateClientRequestIdHeader?: boolean
Valore della proprietà
boolean
httpClient
HttpClient che verrà usato per inviare richieste HTTP.
httpClient?: HttpClient
Valore della proprietà
httpPipelineLogger
HttpPipelineLogger che può essere usato per eseguire il debug di RequestPolicies all'interno della pipeline HTTP.
httpPipelineLogger?: HttpPipelineLogger
Valore della proprietà
noRetryPolicy
Se impostato su true, disattivare i criteri di ripetizione dei tentativi predefiniti.
noRetryPolicy?: boolean
Valore della proprietà
boolean
proxySettings
Impostazioni proxy che verranno usate per ogni richiesta HTTP (solo Node.js).
proxySettings?: ProxySettings
Valore della proprietà
redirectOptions
Opzioni per la gestione delle risposte di reindirizzamento.
redirectOptions?: RedirectOptions
Valore della proprietà
requestPolicyFactories
Matrice di factory che vengono chiamate per creare la pipeline RequestPolicy usata per inviare una richiesta HTTP in transito o una funzione che accetta defaultRequestPolicyFactories e restituisce requestPolicyFactories che verrà usata.
requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
Valore della proprietà
RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]
rpRegistrationRetryTimeout
Ottiene o imposta il timeout dei tentativi in secondi per AutomaticRPRegistration. Il valore predefinito è 30.
rpRegistrationRetryTimeout?: number
Valore della proprietà
number
userAgent
Stringa da impostare sull'intestazione di telemetria durante l'invio della richiesta o una funzione che accetta la stringa predefinita dell'agente utente e restituisce la stringa dell'agente utente che verrà utilizzata.
userAgent?: string | (defaultUserAgent: string) => string
Valore della proprietà
string | (defaultUserAgent: string) => string
userAgentHeaderName
Nome dell'intestazione da usare per l'intestazione di telemetria durante l'invio della richiesta. Se non viene specificato, "User-Agent" verrà usato durante l'esecuzione in Node.js e "x-ms-command-name" verrà usato durante l'esecuzione in un browser.
userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string
Valore della proprietà
string | (defaultUserAgentHeaderName: string) => string
withCredentials
Indica se includere le credenziali nelle richieste CORS nel browser. Per altre informazioni, vedere https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials.
withCredentials?: boolean
Valore della proprietà
boolean