DefaultAzureCredentialClientIdOptions.yml

### YamlMime:TSType
name: DefaultAzureCredentialClientIdOptions
uid: '@azure/identity.DefaultAzureCredentialClientIdOptions'
package: '@azure/identity'
summary: >-
  Provides options to configure the
  [DefaultAzureCredential](xref:@azure/identity.DefaultAzureCredential) class.

  This variation supports `managedIdentityClientId` and not
  `managedIdentityResourceId`, since only one of both is supported.
fullName: DefaultAzureCredentialClientIdOptions
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: managedIdentityClientId
    uid: >-
      @azure/identity.DefaultAzureCredentialClientIdOptions.managedIdentityClientId
    package: '@azure/identity'
    summary: >-
      Optionally pass in a user assigned client ID to be used by the
      [ManagedIdentityCredential](xref:@azure/identity.ManagedIdentityCredential).

      This client ID can also be passed through to the
      [ManagedIdentityCredential](xref:@azure/identity.ManagedIdentityCredential)
      through the environment variable: AZURE_CLIENT_ID.
    fullName: managedIdentityClientId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'managedIdentityClientId?: string'
      return:
        description: ''
        type: string
  - name: workloadIdentityClientId
    uid: >-
      @azure/identity.DefaultAzureCredentialClientIdOptions.workloadIdentityClientId
    package: '@azure/identity'
    summary: >-
      Optionally pass in a user assigned client ID to be used by the
      [WorkloadIdentityCredential](xref:@azure/identity.WorkloadIdentityCredential).

      This client ID can also be passed through to the
      [WorkloadIdentityCredential](xref:@azure/identity.WorkloadIdentityCredential)
      through the environment variable: AZURE_CLIENT_ID.
    fullName: workloadIdentityClientId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'workloadIdentityClientId?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: additionallyAllowedTenants
    uid: >-
      @azure/identity.DefaultAzureCredentialClientIdOptions.additionallyAllowedTenants
    package: '@azure/identity'
    summary: >-
      For multi-tenant applications, specifies additional tenants for which the
      credential may acquire tokens.

      Add the wildcard value "*" to allow the credential to acquire tokens for
      any tenant the application is installed.
    fullName: additionallyAllowedTenants
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'additionallyAllowedTenants?: string[]'
      return:
        description: ''
        type: string[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.additionallyAllowedTenants](xref:@azure/identity.DefaultAzureCredentialOptions.additionallyAllowedTenants)
  - name: additionalPolicies
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.additionalPolicies'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.additionalPolicies](xref:@azure/identity.DefaultAzureCredentialOptions.additionalPolicies)
  - name: allowInsecureConnection
    uid: >-
      @azure/identity.DefaultAzureCredentialClientIdOptions.allowInsecureConnection
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.allowInsecureConnection](xref:@azure/identity.DefaultAzureCredentialOptions.allowInsecureConnection)
  - name: authorityHost
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.authorityHost'
    package: '@azure/identity'
    summary: >-
      The authority host to use for authentication requests.

      Possible values are available through
      [AzureAuthorityHosts](xref:@azure/identity.AzureAuthorityHosts).

      The default is "https://login.microsoftonline.com".
    fullName: authorityHost
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'authorityHost?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.authorityHost](xref:@azure/identity.DefaultAzureCredentialOptions.authorityHost)
  - name: disableInstanceDiscovery
    uid: >-
      @azure/identity.DefaultAzureCredentialClientIdOptions.disableInstanceDiscovery
    package: '@azure/identity'
    summary: >-
      The field determines whether instance discovery is performed when
      attempting to authenticate.

      Setting this to `true` will completely disable both instance discovery and
      authority validation.

      As a result, it's crucial to ensure that the configured authority host is
      valid and trustworthy.

      This functionality is intended for use in scenarios where the metadata
      endpoint cannot be reached, such as in private clouds or Azure Stack.

      The process of instance discovery entails retrieving authority metadata
      from https://login.microsoft.com/ to validate the authority.
    fullName: disableInstanceDiscovery
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'disableInstanceDiscovery?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.disableInstanceDiscovery](xref:@azure/identity.DefaultAzureCredentialOptions.disableInstanceDiscovery)
  - name: httpClient
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.httpClient'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.httpClient](xref:@azure/identity.DefaultAzureCredentialOptions.httpClient)
  - name: loggingOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.loggingOptions'
    package: '@azure/identity'
    summary: >-
      Allows users to configure settings for logging policy options, allow
      logging account information and personally identifiable information for
      customer support.
    fullName: loggingOptions
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?:
        boolean, enableUnsafeSupportLogging?: boolean }
      return:
        description: ''
        type: >-
          <xref uid="@azure/core-rest-pipeline.LogPolicyOptions" /> & {
          allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?:
          boolean }
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.loggingOptions](xref:@azure/identity.DefaultAzureCredentialOptions.loggingOptions)
  - name: processTimeoutInMs
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.processTimeoutInMs'
    package: '@azure/identity'
    summary: >-
      Timeout configurable for making token requests for developer credentials,
      namely, <xref:AzurePowershellCredential>,

      [AzureDeveloperCliCredential](xref:@azure/identity.AzureDeveloperCliCredential)
      and [AzureCliCredential](xref:@azure/identity.AzureCliCredential).

      Process timeout for credentials should be provided in milliseconds.
    fullName: processTimeoutInMs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'processTimeoutInMs?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.processTimeoutInMs](xref:@azure/identity.DefaultAzureCredentialOptions.processTimeoutInMs)
  - name: proxyOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.proxyOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.proxyOptions](xref:@azure/identity.DefaultAzureCredentialOptions.proxyOptions)
  - name: redirectOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.redirectOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.redirectOptions](xref:@azure/identity.DefaultAzureCredentialOptions.redirectOptions)
  - name: retryOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.retryOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.retryOptions](xref:@azure/identity.DefaultAzureCredentialOptions.retryOptions)
  - name: telemetryOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.telemetryOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.telemetryOptions](xref:@azure/identity.DefaultAzureCredentialOptions.telemetryOptions)
  - name: tenantId
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.tenantId'
    package: '@azure/identity'
    summary: >-
      Optionally pass in a Tenant ID to be used as part of the credential.

      By default it may use a generic tenant ID depending on the underlying
      credential.
    fullName: tenantId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'tenantId?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [DefaultAzureCredentialOptions.tenantId](xref:@azure/identity.DefaultAzureCredentialOptions.tenantId)
  - name: tlsOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.tlsOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.tlsOptions](xref:@azure/identity.DefaultAzureCredentialOptions.tlsOptions)
  - name: userAgentOptions
    uid: '@azure/identity.DefaultAzureCredentialClientIdOptions.userAgentOptions'
    package: '@azure/identity'
    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>
      [DefaultAzureCredentialOptions.userAgentOptions](xref:@azure/identity.DefaultAzureCredentialOptions.userAgentOptions)
extends: <xref uid="@azure/identity.DefaultAzureCredentialOptions" />