Package version:

Interface DefaultAzureCredentialClientIdOptions

Provides options to configure the DefaultAzureCredential class. This variation supports managedIdentityClientId and not managedIdentityResourceId, since only one of both is supported.

interface DefaultAzureCredentialClientIdOptions {
    additionallyAllowedTenants?: {};
    authorityHost?: string;
    disableInstanceDiscovery?: boolean;
    loggingOptions?: any;
    managedIdentityClientId?: string;
    processTimeoutInMs?: number;
    tenantId?: string;
    workloadIdentityClientId?: string;
}

Hierarchy (view full)

Properties

additionallyAllowedTenants? authorityHost? disableInstanceDiscovery? loggingOptions? managedIdentityClientId? processTimeoutInMs? tenantId? workloadIdentityClientId?

Properties

OptionaladditionallyAllowedTenants

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.

OptionalauthorityHost

authorityHost?: string

The authority host to use for authentication requests. Possible values are available through AzureAuthorityHosts. The default is "https://login.microsoftonline.com".

OptionaldisableInstanceDiscovery

disableInstanceDiscovery?: boolean

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.

OptionalloggingOptions

loggingOptions?: any

Allows users to configure settings for logging policy options, allow logging account information and personally identifiable information for customer support.

OptionalmanagedIdentityClientId

managedIdentityClientId?: string

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.

OptionalprocessTimeoutInMs

processTimeoutInMs?: number

Timeout configurable for making token requests for developer credentials, namely, AzurePowershellCredential, AzureDeveloperCliCredential and AzureCliCredential. Process timeout for credentials should be provided in milliseconds.

OptionaltenantId

tenantId?: string

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.

OptionalworkloadIdentityClientId

workloadIdentityClientId?: string

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.

Settings

Member Visibility