AzureAPICenterOptionalParams.yml

### YamlMime:TSType
name: AzureAPICenterOptionalParams
uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams'
package: '@azure/arm-apicenter'
summary: Optional parameters.
fullName: AzureAPICenterOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: $host
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.$host'
    package: '@azure/arm-apicenter'
    summary: server parameter
    fullName: $host
    remarks: ''
    isDeprecated: false
    syntax:
      content: '$host?: string'
      return:
        description: ''
        type: string
  - name: apiVersion
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.apiVersion'
    package: '@azure/arm-apicenter'
    summary: Api Version
    fullName: apiVersion
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'apiVersion?: string'
      return:
        description: ''
        type: string
  - name: endpoint
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.endpoint'
    package: '@azure/arm-apicenter'
    summary: Overrides client endpoint.
    fullName: endpoint
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'endpoint?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: additionalPolicies
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.additionalPolicies'
    package: '@azure/arm-apicenter'
    summary: Additional policies to include in the HTTP pipeline.
    fullName: additionalPolicies
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'additionalPolicies?: AdditionalPolicyConfig[]'
      return:
        description: ''
        type: <xref uid="@azure/core-client.AdditionalPolicyConfig" />[]
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.additionalPolicies
  - name: allowInsecureConnection
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.allowInsecureConnection'
    package: '@azure/arm-apicenter'
    summary: Set to true if the request is sent over HTTP instead of HTTPS
    fullName: allowInsecureConnection
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'allowInsecureConnection?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      coreClient.ServiceClientOptions.allowInsecureConnection
  - name: baseUri
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.baseUri'
    package: '@azure/arm-apicenter'
    summary: >-
      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.
    fullName: baseUri
    remarks: ''
    isDeprecated: true
    customDeprecatedMessage: >-
      This property is deprecated and will be removed soon, please use endpoint
      instead
    syntax:
      content: 'baseUri?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.baseUri
  - name: credential
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.credential'
    package: '@azure/arm-apicenter'
    summary: Credential used to authenticate the request.
    fullName: credential
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credential?: TokenCredential'
      return:
        description: ''
        type: <xref uid="@azure/core-auth.TokenCredential" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.credential
  - name: credentialScopes
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.credentialScopes'
    package: '@azure/arm-apicenter'
    summary: If specified, will be used to build the BearerTokenAuthenticationPolicy.
    fullName: credentialScopes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'credentialScopes?: string | string[]'
      return:
        description: ''
        type: string | string[]
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.credentialScopes
  - name: httpClient
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.httpClient'
    package: '@azure/arm-apicenter'
    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/core-rest-pipeline.HttpClient" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.httpClient
  - name: pipeline
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.pipeline'
    package: '@azure/arm-apicenter'
    summary: A customized pipeline to use, otherwise a default one will be created.
    fullName: pipeline
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'pipeline?: Pipeline'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.Pipeline" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.pipeline
  - name: proxyOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.proxyOptions'
    package: '@azure/arm-apicenter'
    summary: Options to configure a proxy for outgoing requests.
    fullName: proxyOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'proxyOptions?: ProxySettings'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.ProxySettings" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.proxyOptions
  - name: redirectOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.redirectOptions'
    package: '@azure/arm-apicenter'
    summary: Options for how redirect responses are handled.
    fullName: redirectOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'redirectOptions?: RedirectPolicyOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.RedirectPolicyOptions" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.redirectOptions
  - name: requestContentType
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.requestContentType'
    package: '@azure/arm-apicenter'
    summary: |-
      The default request content type for the service.
      Used if no requestContentType is present on an OperationSpec.
    fullName: requestContentType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'requestContentType?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.requestContentType
  - name: retryOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.retryOptions'
    package: '@azure/arm-apicenter'
    summary: Options that control how to retry failed requests.
    fullName: retryOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'retryOptions?: PipelineRetryOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.PipelineRetryOptions" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.retryOptions
  - name: telemetryOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.telemetryOptions'
    package: '@azure/arm-apicenter'
    summary: >-
      Options for setting common telemetry and tracing info to outgoing
      requests.
    fullName: telemetryOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'telemetryOptions?: TelemetryOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.TelemetryOptions" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.telemetryOptions
  - name: tlsOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.tlsOptions'
    package: '@azure/arm-apicenter'
    summary: Options for configuring TLS authentication
    fullName: tlsOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tlsOptions?: TlsSettings'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.TlsSettings" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.tlsOptions
  - name: userAgentOptions
    uid: '@azure/arm-apicenter.AzureAPICenterOptionalParams.userAgentOptions'
    package: '@azure/arm-apicenter'
    summary: Options for adding user agent details to outgoing requests.
    fullName: userAgentOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userAgentOptions?: UserAgentPolicyOptions'
      return:
        description: ''
        type: <xref uid="@azure/core-rest-pipeline.UserAgentPolicyOptions" />
    inheritanceDescription: <b>Inherited From</b> coreClient.ServiceClientOptions.userAgentOptions
extends: <xref uid="@azure/core-client.ServiceClientOptions" />