Table of Contents

Class WorkloadIdentityCredentialOptions

Namespace
Azure.Identity
Assembly
Azure.Identity.dll

Options used to configure the WorkloadIdentityCredential.

public class WorkloadIdentityCredentialOptions : TokenCredentialOptions
Inheritance
WorkloadIdentityCredentialOptions
Inherited Members

Constructors

WorkloadIdentityCredentialOptions()

public WorkloadIdentityCredentialOptions()

Properties

AdditionallyAllowedTenants

Specifies tenants in addition to the specified TenantId for which the credential may acquire tokens. Add the wildcard value "*" to allow the credential to acquire tokens for any tenant the logged in account can access. If no value is specified for TenantId, this option will have no effect, and the credential will acquire tokens for any requested tenant. Defaults to the value of the environment variable AZURE_ADDITIONALLY_ALLOWED_TENANTS.

public IList<string> AdditionallyAllowedTenants { get; }

Property Value

IList<string>

ClientId

The client (application) ID of the service principal. Defaults to the value of the environment variable AZURE_CLIENT_ID.

public string ClientId { get; set; }

Property Value

string

DisableInstanceDiscovery

Gets or sets the setting which determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. 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. By setting this to true, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy."

public bool DisableInstanceDiscovery { get; set; }

Property Value

bool

TenantId

The tenant ID of the service principal. Defaults to the value of the environment variable AZURE_TENANT_ID.

public string TenantId { get; set; }

Property Value

string

TokenFilePath

The path to a file containing the workload identity token. Defaults to the value of the environment variable AZURE_FEDERATED_TOKEN_FILE.

public string TokenFilePath { get; set; }

Property Value

string