CognitiveServicesManagementClientOptionalParams interface

Package:

@azure/arm-cognitiveservices

Optional parameters.

Extends

ServiceClientOptions

Properties

$host	server parameter
apiVersion	Api Version
endpoint	Overrides client endpoint.

Inherited Properties

additionalPolicies	Additional policies to include in the HTTP pipeline.
allowInsecureConnection	Set to true if the request is sent over HTTP instead of HTTPS
baseUri	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.
credentialScopes	If specified, will be used to build the BearerTokenAuthenticationPolicy.
httpClient	The HttpClient that will be used to send HTTP requests.
pipeline	A customized pipeline to use, otherwise a default one will be created.
proxyOptions	Options to configure a proxy for outgoing requests.
redirectOptions	Options for how redirect responses are handled.
requestContentType	The default request content type for the service. Used if no requestContentType is present on an OperationSpec.
retryOptions	Options that control how to retry failed requests.
telemetryOptions	Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions	Options for configuring TLS authentication
userAgentOptions	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

AdditionalPolicyConfig[]

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

TokenCredential

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

HttpClient

Inherited From coreClient.ServiceClientOptions.httpClient

pipeline

A customized pipeline to use, otherwise a default one will be created.

pipeline?: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClientOptions.pipeline

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From coreClient.ServiceClientOptions.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

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

PipelineRetryOptions

Inherited From coreClient.ServiceClientOptions.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From coreClient.ServiceClientOptions.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From coreClient.ServiceClientOptions.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From coreClient.ServiceClientOptions.userAgentOptions