AutomationModels.AutomationClientOptions.yml

### YamlMime:TSType
name: AutomationClientOptions
uid: '@azure/arm-automation.AutomationModels.AutomationClientOptions'
package: '@azure/arm-automation'
summary: An interface representing AutomationClientOptions.
fullName: AutomationClientOptions
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: baseUri
    uid: '@azure/arm-automation.AutomationModels.AutomationClientOptions.baseUri'
    package: '@azure/arm-automation'
    summary: ''
    fullName: baseUri
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'baseUri?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: acceptLanguage
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.acceptLanguage
    package: '@azure/arm-automation'
    summary: >-
      Gets or sets the preferred language for the response. Default value is:
      "en-US".
    fullName: acceptLanguage
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'acceptLanguage?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.acceptLanguage
  - name: agentSettings
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.agentSettings
    package: '@azure/arm-automation'
    summary: >-
      HTTP and HTTPS agents which will be used for every HTTP request (Node.js
      only).
    fullName: agentSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'agentSettings?: AgentSettings'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.AgentSettings" />
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.agentSettings
  - name: clientRequestIdHeaderName
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.clientRequestIdHeaderName
    package: '@azure/arm-automation'
    summary: >-
      If specified, a GenerateRequestIdPolicy will be added to the HTTP pipeline
      that will add a

      header to all outgoing requests with this header name and a random UUID as
      the request ID.
    fullName: clientRequestIdHeaderName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'clientRequestIdHeaderName?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.clientRequestIdHeaderName
  - name: deserializationContentTypes
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.deserializationContentTypes
    package: '@azure/arm-automation'
    summary: The content-types that will be associated with JSON or XML serialization.
    fullName: deserializationContentTypes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'deserializationContentTypes?: DeserializationContentTypes'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.DeserializationContentTypes" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      AzureServiceClientOptions.deserializationContentTypes
  - name: generateClientRequestIdHeader
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.generateClientRequestIdHeader
    package: '@azure/arm-automation'
    summary: >-
      Whether or not to generate a client request ID header for each HTTP
      request.
    fullName: generateClientRequestIdHeader
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'generateClientRequestIdHeader?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      AzureServiceClientOptions.generateClientRequestIdHeader
  - name: httpClient
    uid: '@azure/arm-automation.AutomationModels.AutomationClientOptions.httpClient'
    package: '@azure/arm-automation'
    summary: The HttpClient that will be used to send HTTP requests.
    fullName: httpClient
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'httpClient?: HttpClient'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.HttpClient" />
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.httpClient
  - name: httpPipelineLogger
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.httpPipelineLogger
    package: '@azure/arm-automation'
    summary: >-
      The HttpPipelineLogger that can be used to debug RequestPolicies within
      the HTTP pipeline.
    fullName: httpPipelineLogger
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'httpPipelineLogger?: HttpPipelineLogger'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.HttpPipelineLogger" />
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.httpPipelineLogger
  - name: longRunningOperationRetryTimeout
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.longRunningOperationRetryTimeout
    package: '@azure/arm-automation'
    summary: |-
      Gets or sets the retry timeout in seconds for
      Long Running Operations. Default value is 30.
    fullName: longRunningOperationRetryTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'longRunningOperationRetryTimeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      AzureServiceClientOptions.longRunningOperationRetryTimeout
  - name: noRetryPolicy
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.noRetryPolicy
    package: '@azure/arm-automation'
    summary: If set to true, turn off the default retry policy.
    fullName: noRetryPolicy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'noRetryPolicy?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.noRetryPolicy
  - name: proxySettings
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.proxySettings
    package: '@azure/arm-automation'
    summary: Proxy settings which will be used for every HTTP request (Node.js only).
    fullName: proxySettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'proxySettings?: ProxySettings'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.ProxySettings" />
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.proxySettings
  - name: redirectOptions
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.redirectOptions
    package: '@azure/arm-automation'
    summary: Options for how redirect responses are handled.
    fullName: redirectOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'redirectOptions?: RedirectOptions'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.RedirectOptions" />
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.redirectOptions
  - name: requestPolicyFactories
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.requestPolicyFactories
    package: '@azure/arm-automation'
    summary: >-
      An array of factories which get called to create the RequestPolicy
      pipeline used to send a HTTP

      request on the wire, or a function that takes in the
      defaultRequestPolicyFactories and returns

      the requestPolicyFactories that will be used.
    fullName: requestPolicyFactories
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        requestPolicyFactories?: RequestPolicyFactory[] |
        (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void |
        RequestPolicyFactory[]
      return:
        description: ''
        type: >-
          <xref uid="@azure/ms-rest-js.RequestPolicyFactory" />[] |
          (defaultRequestPolicyFactories: RequestPolicyFactory[]) =&gt; void |
          RequestPolicyFactory[]
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.requestPolicyFactories
  - name: rpRegistrationRetryTimeout
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.rpRegistrationRetryTimeout
    package: '@azure/arm-automation'
    summary: >-
      Gets or sets the retry timeout in seconds for AutomaticRPRegistration.
      Default value is 30.
    fullName: rpRegistrationRetryTimeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'rpRegistrationRetryTimeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.rpRegistrationRetryTimeout
  - name: userAgent
    uid: '@azure/arm-automation.AutomationModels.AutomationClientOptions.userAgent'
    package: '@azure/arm-automation'
    summary: >-
      The string to be set to the telemetry header while sending the request, or
      a function that

      takes in the default user-agent string and returns the user-agent string
      that will be used.
    fullName: userAgent
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userAgent?: string | (defaultUserAgent: string) => string'
      return:
        description: ''
        type: 'string | (defaultUserAgent: string) =&gt; string'
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.userAgent
  - name: userAgentHeaderName
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.userAgentHeaderName
    package: '@azure/arm-automation'
    summary: >-
      The header name to use for the telemetry header while sending the request.
      If this is not

      specified, then "User-Agent" will be used when running on Node.js and
      "x-ms-command-name" will

      be used when running in a browser.
    fullName: userAgentHeaderName
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) =>
        string
      return:
        description: ''
        type: 'string | (defaultUserAgentHeaderName: string) =&gt; string'
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.userAgentHeaderName
  - name: withCredentials
    uid: >-
      @azure/arm-automation.AutomationModels.AutomationClientOptions.withCredentials
    package: '@azure/arm-automation'
    summary: >-
      Whether to include credentials in CORS requests in the browser.

      See
      https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials
      for more information.
    fullName: withCredentials
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'withCredentials?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: <b>Inherited From</b> AzureServiceClientOptions.withCredentials
extends: <xref uid="@azure/ms-rest-azure-js.AzureServiceClientOptions" />