Package version:

Interface WorkloadIdentityCredentialOptions

Options for the WorkloadIdentityCredential

interface WorkloadIdentityCredentialOptions {
    additionallyAllowedTenants?: {};
    authorityHost?: string;
    clientId?: string;
    disableInstanceDiscovery?: boolean;
    loggingOptions?: any;
    tenantId?: string;
    tokenFilePath?: string;
}

Hierarchy (view full)

Properties

additionallyAllowedTenants? authorityHost? clientId? disableInstanceDiscovery? loggingOptions? tenantId? tokenFilePath?

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".

OptionalclientId

clientId?: string

The client ID of a Microsoft Entra app registration.

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.

OptionaltenantId

tenantId?: string

ID of the application's Microsoft Entra tenant. Also called its directory ID.

OptionaltokenFilePath

tokenFilePath?: string

The path to a file containing a Kubernetes service account token that authenticates the identity.

Settings

Member Visibility