OperationsManagementClientOptionalParams interface
Optional parameters.
- Extends
Properties
$host | server parameter |
api |
Api Version |
endpoint | Overrides client endpoint. |
Inherited Properties
additional |
Additional policies to include in the HTTP pipeline. |
allow |
Set to true if the request is sent over HTTP instead of HTTPS |
base |
If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property. |
credential | Credential used to authenticate the request. |
credential |
If specified, will be used to build the BearerTokenAuthenticationPolicy. |
http |
The HttpClient that will be used to send HTTP requests. |
pipeline | A customized pipeline to use, otherwise a default one will be created. |
proxy |
Options to configure a proxy for outgoing requests. |
redirect |
Options for how redirect responses are handled. |
request |
The default request content type for the service. Used if no requestContentType is present on an OperationSpec. |
retry |
Options that control how to retry failed requests. |
telemetry |
Options for setting common telemetry and tracing info to outgoing requests. |
tls |
Options for configuring TLS authentication |
user |
Options for adding user agent details to outgoing requests. |
Property Details
$host
server parameter
$host?: string
Property Value
string
apiVersion
Api Version
apiVersion?: string
Property Value
string
endpoint
Overrides client endpoint.
endpoint?: string
Property Value
string
Inherited Property Details
additionalPolicies
Additional policies to include in the HTTP pipeline.
additionalPolicies?: AdditionalPolicyConfig[]
Property Value
Inherited From coreClient.ServiceClientOptions.additionalPolicies
allowInsecureConnection
Set to true if the request is sent over HTTP instead of HTTPS
allowInsecureConnection?: boolean
Property Value
boolean
Inherited From coreClient.ServiceClientOptions.allowInsecureConnection
baseUri
Warning
This API is now deprecated.
This property is deprecated and will be removed soon, please use endpoint instead
If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.
baseUri?: string
Property Value
string
Inherited From coreClient.ServiceClientOptions.baseUri
credential
Credential used to authenticate the request.
credential?: TokenCredential
Property Value
Inherited From coreClient.ServiceClientOptions.credential
credentialScopes
If specified, will be used to build the BearerTokenAuthenticationPolicy.
credentialScopes?: string | string[]
Property Value
string | string[]
Inherited From coreClient.ServiceClientOptions.credentialScopes
httpClient
The HttpClient that will be used to send HTTP requests.
httpClient?: HttpClient
Property Value
Inherited From coreClient.ServiceClientOptions.httpClient
pipeline
A customized pipeline to use, otherwise a default one will be created.
pipeline?: Pipeline
Property Value
Inherited From coreClient.ServiceClientOptions.pipeline
proxyOptions
Options to configure a proxy for outgoing requests.
proxyOptions?: ProxySettings
Property Value
Inherited From coreClient.ServiceClientOptions.proxyOptions
redirectOptions
Options for how redirect responses are handled.
redirectOptions?: RedirectPolicyOptions
Property Value
Inherited From coreClient.ServiceClientOptions.redirectOptions
requestContentType
The default request content type for the service. Used if no requestContentType is present on an OperationSpec.
requestContentType?: string
Property Value
string
Inherited From coreClient.ServiceClientOptions.requestContentType
retryOptions
Options that control how to retry failed requests.
retryOptions?: PipelineRetryOptions
Property Value
Inherited From coreClient.ServiceClientOptions.retryOptions
telemetryOptions
Options for setting common telemetry and tracing info to outgoing requests.
telemetryOptions?: TelemetryOptions
Property Value
Inherited From coreClient.ServiceClientOptions.telemetryOptions
tlsOptions
Options for configuring TLS authentication
tlsOptions?: TlsSettings
Property Value
Inherited From coreClient.ServiceClientOptions.tlsOptions
userAgentOptions
Options for adding user agent details to outgoing requests.
userAgentOptions?: UserAgentPolicyOptions
Property Value
Inherited From coreClient.ServiceClientOptions.userAgentOptions
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for