DefaultAzureCredentialClientIdOptions interface
Provides options to configure the DefaultAzureCredential class.
This variation supports managedIdentityClientId
and not managedIdentityResourceId
, since only one of both is supported.
- Extends
Properties
managed |
Optionally pass in a user assigned client ID to be used by the ManagedIdentityCredential. This client ID can also be passed through to the ManagedIdentityCredential through the environment variable: AZURE_CLIENT_ID. |
workload |
Optionally pass in a user assigned client ID to be used by the WorkloadIdentityCredential. This client ID can also be passed through to the WorkloadIdentityCredential through the environment variable: AZURE_CLIENT_ID. |
Inherited Properties
additionally |
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. |
additional |
Additional policies to include in the HTTP pipeline. |
allow |
Set to true if the request is sent over HTTP instead of HTTPS |
authority |
The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com". |
disable |
The field determines whether instance discovery is performed when attempting to authenticate.
Setting this to |
http |
The HttpClient that will be used to send HTTP requests. |
logging |
Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support. |
process |
Timeout configurable for making token requests for developer credentials, namely, <xref:AzurePowershellCredential>, AzureDeveloperCliCredential and AzureCliCredential. Process timeout for credentials should be provided in milliseconds. |
proxy |
Options to configure a proxy for outgoing requests. |
redirect |
Options for how redirect responses are handled. |
retry |
Options that control how to retry failed requests. |
telemetry |
Options for setting common telemetry and tracing info to outgoing requests. |
tenant |
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. |
tls |
Options for configuring TLS authentication |
user |
Options for adding user agent details to outgoing requests. |
Property Details
managedIdentityClientId
Optionally pass in a user assigned client ID to be used by the ManagedIdentityCredential. This client ID can also be passed through to the ManagedIdentityCredential through the environment variable: AZURE_CLIENT_ID.
managedIdentityClientId?: string
Property Value
string
workloadIdentityClientId
Optionally pass in a user assigned client ID to be used by the WorkloadIdentityCredential. This client ID can also be passed through to the WorkloadIdentityCredential through the environment variable: AZURE_CLIENT_ID.
workloadIdentityClientId?: string
Property Value
string
Inherited Property Details
additionallyAllowedTenants
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.
additionallyAllowedTenants?: string[]
Property Value
string[]
Inherited From DefaultAzureCredentialOptions.additionallyAllowedTenants
additionalPolicies
Additional policies to include in the HTTP pipeline.
additionalPolicies?: AdditionalPolicyConfig[]
Property Value
Inherited From DefaultAzureCredentialOptions.additionalPolicies
allowInsecureConnection
Set to true if the request is sent over HTTP instead of HTTPS
allowInsecureConnection?: boolean
Property Value
boolean
Inherited From DefaultAzureCredentialOptions.allowInsecureConnection
authorityHost
The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".
authorityHost?: string
Property Value
string
Inherited From DefaultAzureCredentialOptions.authorityHost
disableInstanceDiscovery
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.
disableInstanceDiscovery?: boolean
Property Value
boolean
Inherited From DefaultAzureCredentialOptions.disableInstanceDiscovery
httpClient
The HttpClient that will be used to send HTTP requests.
httpClient?: HttpClient
Property Value
Inherited From DefaultAzureCredentialOptions.httpClient
loggingOptions
Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support.
loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Property Value
LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }
Inherited From DefaultAzureCredentialOptions.loggingOptions
processTimeoutInMs
Timeout configurable for making token requests for developer credentials, namely, <xref:AzurePowershellCredential>, AzureDeveloperCliCredential and AzureCliCredential. Process timeout for credentials should be provided in milliseconds.
processTimeoutInMs?: number
Property Value
number
Inherited From DefaultAzureCredentialOptions.processTimeoutInMs
proxyOptions
Options to configure a proxy for outgoing requests.
proxyOptions?: ProxySettings
Property Value
Inherited From DefaultAzureCredentialOptions.proxyOptions
redirectOptions
Options for how redirect responses are handled.
redirectOptions?: RedirectPolicyOptions
Property Value
Inherited From DefaultAzureCredentialOptions.redirectOptions
retryOptions
Options that control how to retry failed requests.
retryOptions?: PipelineRetryOptions
Property Value
Inherited From DefaultAzureCredentialOptions.retryOptions
telemetryOptions
Options for setting common telemetry and tracing info to outgoing requests.
telemetryOptions?: TelemetryOptions
Property Value
Inherited From DefaultAzureCredentialOptions.telemetryOptions
tenantId
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.
tenantId?: string
Property Value
string
Inherited From DefaultAzureCredentialOptions.tenantId
tlsOptions
Options for configuring TLS authentication
tlsOptions?: TlsSettings
Property Value
Inherited From DefaultAzureCredentialOptions.tlsOptions
userAgentOptions
Options for adding user agent details to outgoing requests.
userAgentOptions?: UserAgentPolicyOptions
Property Value
Inherited From DefaultAzureCredentialOptions.userAgentOptions