ServiceClientOptions interface
Opzioni da fornire durante la creazione del client.
- Extends
Proprietà
base |
Se specificato, si tratta dell'URI di base a cui verranno eseguite richieste per questo ServiceClient. Se non è specificato, tutti gli oggetti OperationSpecs devono contenere una proprietà baseUrl. |
credential | Credenziali usate per autenticare la richiesta. |
credential |
Se specificato, verrà usato per compilare BearerTokenAuthenticationPolicy. |
endpoint | Se specificato, si tratta dell'endpoint a cui verranno eseguite richieste per questo ServiceClient. Se non è specificato, tutti gli oggetti OperationSpecs devono contenere una proprietà baseUrl. per incoraggiare il cliente a usare l'endpoint, contrassegniamo baseUri come deprecato. |
pipeline | Una pipeline personalizzata da usare; in caso contrario, ne verrà creata una predefinita. |
request |
Tipo di contenuto della richiesta predefinito per il servizio. Utilizzato se non è presente alcun requestContentType in operationSpec. |
Proprietà ereditate
additional |
Criteri aggiuntivi da includere nella pipeline HTTP. |
agent | Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita |
allow |
Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS |
http |
HttpClient che verrà usato per inviare richieste HTTP. |
proxy |
Opzioni per configurare un proxy per le richieste in uscita. |
redirect |
Opzioni per la gestione delle risposte di reindirizzamento. |
retry |
Opzioni che controllano come ripetere le richieste non riuscite. |
telemetry |
Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita. |
tls |
Opzioni per la configurazione dell'autenticazione TLS |
user |
Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita. |
Dettagli proprietà
baseUri
Avviso
Questa API è ora deprecata.
This property is deprecated and will be removed soon, please use endpoint instead
Se specificato, si tratta dell'URI di base a cui verranno eseguite richieste per questo ServiceClient. Se non è specificato, tutti gli oggetti OperationSpecs devono contenere una proprietà baseUrl.
baseUri?: string
Valore della proprietà
string
credential
Credenziali usate per autenticare la richiesta.
credential?: TokenCredential
Valore della proprietà
credentialScopes
Se specificato, verrà usato per compilare BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Valore della proprietà
string | string[]
endpoint
Se specificato, si tratta dell'endpoint a cui verranno eseguite richieste per questo ServiceClient. Se non è specificato, tutti gli oggetti OperationSpecs devono contenere una proprietà baseUrl. per incoraggiare il cliente a usare l'endpoint, contrassegniamo baseUri come deprecato.
endpoint?: string
Valore della proprietà
string
pipeline
Una pipeline personalizzata da usare; in caso contrario, ne verrà creata una predefinita.
pipeline?: Pipeline
Valore della proprietà
requestContentType
Tipo di contenuto della richiesta predefinito per il servizio. Utilizzato se non è presente alcun requestContentType in operationSpec.
requestContentType?: string
Valore della proprietà
string
Dettagli proprietà ereditate
additionalPolicies
Criteri aggiuntivi da includere nella pipeline HTTP.
additionalPolicies?: AdditionalPolicyConfig[]
Valore della proprietà
ereditato daCommonClientOptions.additionalPolicies
agent
Opzioni per la configurazione dell'istanza di Agent per le richieste in uscita
agent?: Agent
Valore della proprietà
Ereditato daCommonClientOptions.agent
allowInsecureConnection
Impostare su true se la richiesta viene inviata tramite HTTP invece di HTTPS
allowInsecureConnection?: boolean
Valore della proprietà
boolean
ereditato daCommonClientOptions.allowInsecureConnection
httpClient
HttpClient che verrà usato per inviare richieste HTTP.
httpClient?: HttpClient
Valore della proprietà
Ereditato daCommonClientOptions.httpClient
proxyOptions
Opzioni per configurare un proxy per le richieste in uscita.
proxyOptions?: ProxySettings
Valore della proprietà
Ereditato daCommonClientOptions.proxyOptions
redirectOptions
Opzioni per la gestione delle risposte di reindirizzamento.
redirectOptions?: RedirectPolicyOptions
Valore della proprietà
ereditato daCommonClientOptions.redirectOptions
retryOptions
Opzioni che controllano come ripetere le richieste non riuscite.
retryOptions?: PipelineRetryOptions
Valore della proprietà
Ereditato daCommonClientOptions.retryOptions
telemetryOptions
Opzioni per impostare dati di telemetria comuni e informazioni di traccia alle richieste in uscita.
telemetryOptions?: TelemetryOptions
Valore della proprietà
ereditato daCommonClientOptions.telemetryOptions
tlsOptions
Opzioni per la configurazione dell'autenticazione TLS
tlsOptions?: TlsSettings
Valore della proprietà
ereditato daCommonClientOptions.tlsOptions
userAgentOptions
Opzioni per l'aggiunta dei dettagli dell'agente utente alle richieste in uscita.
userAgentOptions?: UserAgentPolicyOptions
Valore della proprietà
Ereditato daCommonClientOptions.userAgentOptions