Azure.Identity 1.20.0 - API Reference

<PackageReference Include="Azure.Identity" Version="1.20.0" />

API Differences between 1.20.0 and 1.21.0

314 Additions 0 Removals

Azure.Identity

public class AuthenticationFailedException : Exception
- public AuthenticationFailedException(string message)
- public AuthenticationFailedException(string message, Exception innerException)
- protected AuthenticationFailedException(SerializationInfo info, StreamingContext context)
public class AuthenticationRecord
- public string Authority { get; }
- public string ClientId { get; }
- public string HomeAccountId { get; }
- public string TenantId { get; }
- public string Username { get; }
- public static AuthenticationRecord Deserialize(Stream stream, CancellationToken cancellationToken = default)
- public static Task<AuthenticationRecord> DeserializeAsync(Stream stream, CancellationToken cancellationToken = default)
- public void Serialize(Stream stream, CancellationToken cancellationToken = default)
- public Task SerializeAsync(Stream stream, CancellationToken cancellationToken = default)
public class AuthenticationRequiredException : CredentialUnavailableException
- public TokenRequestContext TokenRequestContext { get; }
- public AuthenticationRequiredException(string message, TokenRequestContext context)
- public AuthenticationRequiredException(string message, TokenRequestContext context, Exception innerException)
- protected AuthenticationRequiredException(SerializationInfo info, StreamingContext context)
public class AuthorizationCodeCredential : TokenCredential
- protected AuthorizationCodeCredential()
- public AuthorizationCodeCredential(string tenantId, string clientId, string clientSecret, string authorizationCode)
- public AuthorizationCodeCredential(string tenantId, string clientId, string clientSecret, string authorizationCode, AuthorizationCodeCredentialOptions options)
- public AuthorizationCodeCredential(string tenantId, string clientId, string clientSecret, string authorizationCode, TokenCredentialOptions options)
public class AuthorizationCodeCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public Uri RedirectUri { get; set; }
- public AuthorizationCodeCredentialOptions()
public static class AzureAuthorityHosts
- public static Uri AzureChina { get; }
- public static Uri AzureGermany { get; }
- public static Uri AzureGovernment { get; }
- public static Uri AzurePublicCloud { get; }
public class AzureCliCredential : TokenCredential
- public AzureCliCredential()
- public AzureCliCredential(AzureCliCredentialOptions options)
public class AzureCliCredentialOptions : TokenCredentialOptions, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public TimeSpan? ProcessTimeout { get; set; }
- public string Subscription { get; set; }
- public string TenantId { get; set; }
- public AzureCliCredentialOptions()
public class AzureDeveloperCliCredential : TokenCredential
- public AzureDeveloperCliCredential()
- public AzureDeveloperCliCredential(AzureDeveloperCliCredentialOptions options)
public class AzureDeveloperCliCredentialOptions : TokenCredentialOptions, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public TimeSpan? ProcessTimeout { get; set; }
- public string TenantId { get; set; }
- public AzureDeveloperCliCredentialOptions()
public class AzurePipelinesCredential : TokenCredential
- protected AzurePipelinesCredential()
- public AzurePipelinesCredential(string tenantId, string clientId, string serviceConnectionId, string systemAccessToken, AzurePipelinesCredentialOptions options = null)
public class AzurePipelinesCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTokenCachePersistenceOptions
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public AzurePipelinesCredentialOptions()
public class AzurePowerShellCredential : TokenCredential
- public AzurePowerShellCredential()
- public AzurePowerShellCredential(AzurePowerShellCredentialOptions options)
public class AzurePowerShellCredentialOptions : TokenCredentialOptions, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public TimeSpan? ProcessTimeout { get; set; }
- public string TenantId { get; set; }
- public AzurePowerShellCredentialOptions()
public class BrowserCustomizationOptions
- public string ErrorMessage { get; set; }
- public string SuccessMessage { get; set; }
- public bool? UseEmbeddedWebView { get; set; }
- public BrowserCustomizationOptions()
public class ChainedTokenCredential : TokenCredential
- protected ChainedTokenCredential()
- public ChainedTokenCredential(TokenCredential[] sources)
public class ClientAssertionCredential : TokenCredential
- protected ClientAssertionCredential()
- public ClientAssertionCredential(string tenantId, string clientId, Func<CancellationToken, Task<string>> assertionCallback, ClientAssertionCredentialOptions options = null)
- public ClientAssertionCredential(string tenantId, string clientId, Func<string> assertionCallback, ClientAssertionCredentialOptions options = null)
public class ClientAssertionCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTokenCachePersistenceOptions
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public ClientAssertionCredentialOptions()
public class ClientCertificateCredential : TokenCredential
- protected ClientCertificateCredential()
- public ClientCertificateCredential(string tenantId, string clientId, string clientCertificatePath)
- public ClientCertificateCredential(string tenantId, string clientId, string clientCertificatePath, TokenCredentialOptions options)
- public ClientCertificateCredential(string tenantId, string clientId, string clientCertificatePath, ClientCertificateCredentialOptions options)
- public ClientCertificateCredential(string tenantId, string clientId, X509Certificate2 clientCertificate)
- public ClientCertificateCredential(string tenantId, string clientId, X509Certificate2 clientCertificate, TokenCredentialOptions options)
- public ClientCertificateCredential(string tenantId, string clientId, X509Certificate2 clientCertificate, ClientCertificateCredentialOptions options)
public class ClientCertificateCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public bool SendCertificateChain { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public ClientCertificateCredentialOptions()
public class ClientSecretCredential : TokenCredential
- protected ClientSecretCredential()
- public ClientSecretCredential(string tenantId, string clientId, string clientSecret)
- public ClientSecretCredential(string tenantId, string clientId, string clientSecret, ClientSecretCredentialOptions options)
- public ClientSecretCredential(string tenantId, string clientId, string clientSecret, TokenCredentialOptions options)
public class ClientSecretCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public ClientSecretCredentialOptions()
public static class ConfigurationExtensions
- public static IClientBuilder AddAzureClient<TClient, TSettings>(this IHostApplicationBuilder host, string sectionName) where TSettings : ClientSettings
- public static IClientBuilder AddAzureClient<TClient, TSettings>(this IHostApplicationBuilder host, string sectionName, Action<TSettings> configureSettings) where TSettings : ClientSettings
- public static IClientBuilder AddKeyedAzureClient<TClient, TSettings>(this IHostApplicationBuilder host, string key, string sectionName) where TSettings : ClientSettings
- public static IClientBuilder AddKeyedAzureClient<TClient, TSettings>(this IHostApplicationBuilder host, string key, string sectionName, Action<TSettings> configureSettings) where TSettings : ClientSettings
- public static T GetAzureClientSettings<T>(this IConfiguration configuration, string sectionName) where T : ClientSettings
- public static T WithAzureCredential<T>(this T settings) where T : ClientSettings
- public static IClientBuilder WithAzureCredential(this IClientBuilder clientBuilder)
public class CredentialUnavailableException : AuthenticationFailedException
- public CredentialUnavailableException(string message)
- public CredentialUnavailableException(string message, Exception innerException)
- protected CredentialUnavailableException(SerializationInfo info, StreamingContext context)
public class DefaultAzureCredential : TokenCredential
- public const string DefaultEnvironmentVariableName = "AZURE_TOKEN_CREDENTIALS"
- protected DefaultAzureCredential()
- public DefaultAzureCredential(bool includeInteractiveCredentials = false)
- public DefaultAzureCredential(DefaultAzureCredentialOptions options)
- public DefaultAzureCredential(string configurationEnvironmentVariableName, DefaultAzureCredentialOptions options = null)
public class DefaultAzureCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public TimeSpan? CredentialProcessTimeout { get; set; }
- public bool DisableInstanceDiscovery { get; set; }
- public bool ExcludeAzureCliCredential { get; set; }
- public bool ExcludeAzureDeveloperCliCredential { get; set; }
- public bool ExcludeAzurePowerShellCredential { get; set; }
- public bool ExcludeBrokerCredential { get; set; }
- public bool ExcludeEnvironmentCredential { get; set; }
- public bool ExcludeInteractiveBrowserCredential { get; set; }
- public bool ExcludeManagedIdentityCredential { get; set; }
- public bool ExcludeSharedTokenCacheCredential { get; set; }
- public bool ExcludeVisualStudioCodeCredential { get; set; }
- public bool ExcludeVisualStudioCredential { get; set; }
- public bool ExcludeWorkloadIdentityCredential { get; set; }
- public string InteractiveBrowserCredentialClientId { get; set; }
- public string InteractiveBrowserTenantId { get; set; }
- public string ManagedIdentityClientId { get; set; }
- public ResourceIdentifier ManagedIdentityResourceId { get; set; }
- public string SharedTokenCacheTenantId { get; set; }
- public string SharedTokenCacheUsername { get; set; }
- public string TenantId { get; set; }
- public string VisualStudioCodeTenantId { get; set; }
- public string VisualStudioTenantId { get; set; }
- public string WorkloadIdentityClientId { get; set; }
- public DefaultAzureCredentialOptions()
public class DeviceCodeCredential : TokenCredential
- public DeviceCodeCredential()
- public DeviceCodeCredential(DeviceCodeCredentialOptions options)
- public DeviceCodeCredential(Func<DeviceCodeInfo, CancellationToken, Task> deviceCodeCallback, string clientId, TokenCredentialOptions options = null)
- public DeviceCodeCredential(Func<DeviceCodeInfo, CancellationToken, Task> deviceCodeCallback, string tenantId, string clientId, TokenCredentialOptions options = null)
- public virtual AuthenticationRecord Authenticate(CancellationToken cancellationToken = default)
- public virtual AuthenticationRecord Authenticate(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
public class DeviceCodeCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public AuthenticationRecord AuthenticationRecord { get; set; }
- public string ClientId { get; set; }
- public Func<DeviceCodeInfo, CancellationToken, Task> DeviceCodeCallback { get; set; }
- public bool DisableAutomaticAuthentication { get; set; }
- public bool DisableInstanceDiscovery { get; set; }
- public string TenantId { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public DeviceCodeCredentialOptions()
public struct DeviceCodeInfo
- public string ClientId { get; }
- public string DeviceCode { get; }
- public DateTimeOffset ExpiresOn { get; }
- public string Message { get; }
- public IReadOnlyCollection<string> Scopes { get; }
- public string UserCode { get; }
- public Uri VerificationUri { get; }
public class EnvironmentCredential : TokenCredential
- public EnvironmentCredential()
- public EnvironmentCredential(TokenCredentialOptions options)
- public EnvironmentCredential(EnvironmentCredentialOptions options)
public class EnvironmentCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public EnvironmentCredentialOptions()
public static class IdentityModelFactory
- public static AuthenticationRecord AuthenticationRecord(string username, string authority, string homeAccountId, string tenantId, string clientId)
- public static DeviceCodeInfo DeviceCodeInfo(string userCode, string deviceCode, Uri verificationUri, DateTimeOffset expiresOn, string message, string clientId, IReadOnlyCollection<string> scopes)
public class InteractiveBrowserCredential : TokenCredential
- public InteractiveBrowserCredential()
- public InteractiveBrowserCredential(InteractiveBrowserCredentialOptions options)
- public InteractiveBrowserCredential(string clientId)
- public InteractiveBrowserCredential(string tenantId, string clientId, TokenCredentialOptions options = null)
- public virtual AuthenticationRecord Authenticate(CancellationToken cancellationToken = default)
- public virtual AuthenticationRecord Authenticate(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
public class InteractiveBrowserCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public AuthenticationRecord AuthenticationRecord { get; set; }
- public BrowserCustomizationOptions BrowserCustomization { get; set; }
- public string ClientId { get; set; }
- public bool DisableAutomaticAuthentication { get; set; }
- public bool DisableInstanceDiscovery { get; set; }
- public string LoginHint { get; set; }
- public Uri RedirectUri { get; set; }
- public string TenantId { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public InteractiveBrowserCredentialOptions()
public class ManagedIdentityCredential : TokenCredential
- protected ManagedIdentityCredential()
- public ManagedIdentityCredential(string clientId = null, TokenCredentialOptions options = null)
- public ManagedIdentityCredential(ResourceIdentifier resourceId, TokenCredentialOptions options = null)
- public ManagedIdentityCredential(ManagedIdentityId id)
- public ManagedIdentityCredential(ManagedIdentityCredentialOptions options)
public class ManagedIdentityCredentialOptions : TokenCredentialOptions
- public ManagedIdentityCredentialOptions(ManagedIdentityId managedIdentityId = null)
public class ManagedIdentityId
- public static ManagedIdentityId SystemAssigned { get; }
- public static ManagedIdentityId FromUserAssignedClientId(string id)
- public static ManagedIdentityId FromUserAssignedObjectId(string id)
- public static ManagedIdentityId FromUserAssignedResourceId(ResourceIdentifier id)
public class OnBehalfOfCredential : TokenCredential
- protected OnBehalfOfCredential()
- public OnBehalfOfCredential(string tenantId, string clientId, X509Certificate2 clientCertificate, string userAssertion)
- public OnBehalfOfCredential(string tenantId, string clientId, X509Certificate2 clientCertificate, string userAssertion, OnBehalfOfCredentialOptions options)
- public OnBehalfOfCredential(string tenantId, string clientId, string clientSecret, string userAssertion)
- public OnBehalfOfCredential(string tenantId, string clientId, string clientSecret, string userAssertion, OnBehalfOfCredentialOptions options)
- public OnBehalfOfCredential(string tenantId, string clientId, Func<CancellationToken, Task<string>> clientAssertionCallback, string userAssertion, OnBehalfOfCredentialOptions options = null)
- public OnBehalfOfCredential(string tenantId, string clientId, Func<string> clientAssertionCallback, string userAssertion, OnBehalfOfCredentialOptions options = null)
public class OnBehalfOfCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public bool SendCertificateChain { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public OnBehalfOfCredentialOptions()
public class SharedTokenCacheCredential : TokenCredential
- public SharedTokenCacheCredential()
- public SharedTokenCacheCredential(SharedTokenCacheCredentialOptions options)
- public SharedTokenCacheCredential(string username, TokenCredentialOptions options = null)
public class SharedTokenCacheCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsTenantId
- public AuthenticationRecord AuthenticationRecord { get; set; }
- public string ClientId { get; set; }
- public bool DisableInstanceDiscovery { get; set; }
- public bool EnableGuestTenantAuthentication { get; set; }
- public string TenantId { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public string Username { get; set; }
- public SharedTokenCacheCredentialOptions()
- public SharedTokenCacheCredentialOptions(TokenCachePersistenceOptions tokenCacheOptions)
public struct TokenCacheData
- public ReadOnlyMemory<byte> CacheBytes { get; }
- public TokenCacheData(ReadOnlyMemory<byte> cacheBytes)
public class TokenCachePersistenceOptions
- public string Name { get; set; }
- public bool UnsafeAllowUnencryptedStorage { get; set; }
- public TokenCachePersistenceOptions()
public class TokenCacheRefreshArgs
- public bool IsCaeEnabled { get; }
- public string SuggestedCacheKey { get; }
public class TokenCacheUpdatedArgs
- public bool IsCaeEnabled { get; }
- public ReadOnlyMemory<byte> UnsafeCacheData { get; }
public class TokenCredentialDiagnosticsOptions : DiagnosticsOptions
- public bool IsAccountIdentifierLoggingEnabled { get; set; }
- public TokenCredentialDiagnosticsOptions()
public class TokenCredentialOptions : ClientOptions
- public Uri AuthorityHost { get; set; }
- public TokenCredentialDiagnosticsOptions Diagnostics { get; }
- public bool IsUnsafeSupportLoggingEnabled { get; set; }
- public TokenCredentialOptions()
public abstract class UnsafeTokenCacheOptions : TokenCachePersistenceOptions
- protected UnsafeTokenCacheOptions()
public class UsernamePasswordCredential : TokenCredential
- protected UsernamePasswordCredential()
- public UsernamePasswordCredential(string username, string password, string tenantId, string clientId)
- public UsernamePasswordCredential(string username, string password, string tenantId, string clientId, TokenCredentialOptions options)
- public UsernamePasswordCredential(string username, string password, string tenantId, string clientId, UsernamePasswordCredentialOptions options)
- public virtual AuthenticationRecord Authenticate(CancellationToken cancellationToken = default)
- public virtual AuthenticationRecord Authenticate(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(CancellationToken cancellationToken = default)
- public virtual Task<AuthenticationRecord> AuthenticateAsync(TokenRequestContext requestContext, CancellationToken cancellationToken = default)
public class UsernamePasswordCredentialOptions : TokenCredentialOptions, ISupportsTokenCachePersistenceOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants
- public IList<string> AdditionallyAllowedTenants { get; }
- public bool DisableInstanceDiscovery { get; set; }
- public TokenCachePersistenceOptions TokenCachePersistenceOptions { get; set; }
- public UsernamePasswordCredentialOptions()
public class VisualStudioCodeCredential : InteractiveBrowserCredential
- public VisualStudioCodeCredential()
- public VisualStudioCodeCredential(VisualStudioCodeCredentialOptions options)
public class VisualStudioCodeCredentialOptions : TokenCredentialOptions, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public string TenantId { get; set; }
- public VisualStudioCodeCredentialOptions()
public class VisualStudioCredential : TokenCredential
- public VisualStudioCredential()
- public VisualStudioCredential(VisualStudioCredentialOptions options)
public class VisualStudioCredentialOptions : TokenCredentialOptions, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public TimeSpan? ProcessTimeout { get; set; }
- public string TenantId { get; set; }
- public VisualStudioCredentialOptions()
public class WorkloadIdentityCredential : TokenCredential
- public WorkloadIdentityCredential()
- public WorkloadIdentityCredential(WorkloadIdentityCredentialOptions options)
public class WorkloadIdentityCredentialOptions : TokenCredentialOptions, ISupportsDisableInstanceDiscovery, ISupportsAdditionallyAllowedTenants, ISupportsTenantId
- public IList<string> AdditionallyAllowedTenants { get; }
- public string ClientId { get; set; }
- public bool DisableInstanceDiscovery { get; set; }
- public string TenantId { get; set; }
- public string TokenFilePath { get; set; }
- public WorkloadIdentityCredentialOptions()