EnvironmentCredentialOptions Class

Reference

Definition

Namespace:: Azure.Identity

Assembly:: Azure.Identity.dll

Package:: Azure.Identity v1.9.0

Package:: Azure.Identity v1.9.0-beta.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Options used to configure the EnvironmentCredential.

public class EnvironmentCredentialOptions : Azure.Identity.TokenCredentialOptions

type EnvironmentCredentialOptions = class
    inherit TokenCredentialOptions

Public Class EnvironmentCredentialOptions
Inherits TokenCredentialOptions

Inheritance: Object

ClientOptions

TokenCredentialOptions
EnvironmentCredentialOptions

Constructors

EnvironmentCredentialOptions()

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 on that authentication method, and the credential will acquire tokens for any requested tenant when using that method. This value defaults to the value of the environment variable AZURE_ADDITIONALLY_ALLOWED_TENANTS.
AuthorityHost	The host of the Azure Active Directory authority. The default is https://login.microsoftonline.com/. For well known authority hosts for Azure cloud instances see AzureAuthorityHosts. (Inherited from TokenCredentialOptions)
ClientCertificatePassword	The password of the client certificate used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_CERTIFICATE_PASSWORD.
ClientCertificatePath	The path to the client certificate used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_CERTIFICATE_PATH.
ClientId	The client ID (app ID) of the service pricipal the credential will authenticate. This value defaults to the value of the environment variable AZURE_CLIENT_ID.
ClientSecret	The client secret used to authenticate the service pricipal. This value defaults to the value of the environment variable AZURE_CLIENT_SECRET.
Diagnostics	Gets the credential diagnostic options. (Inherited from TokenCredentialOptions)
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."
Password	The password of used to authenticate the user. This value defaults to the value of the environment variable AZURE_PASSWORD.
Retry	Gets the client retry options. (Inherited from ClientOptions)
RetryPolicy	Gets or sets the policy to use for retries. If a policy is specified, it will be used in place of the Retry property. The RetryPolicy type can be derived from to modify the default behavior without needing to fully implement the retry logic. If Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) is overriden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values. (Inherited from ClientOptions)
SendCertificateChain	Will include x5c header in client claims when acquiring a token to enable certificate subject name / issuer based authentication. This value defaults to the value of the environment variable AZURE_CLIENT_SEND_CERTIFICATE_CHAIN.
TenantId	The ID of the tenant to which the credential will authenticate by default. This value defaults to the value of the environment variable AZURE_TENANT_ID.
Transport	The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport. (Inherited from ClientOptions)
Username	The username of the user account the credeential will authenticate. This value defaults to the value of the environment variable AZURE_USERNAME.

Methods

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adds an HttpPipeline policy into the client pipeline. The position of policy in the pipeline is controlled by the position parameter. If you want the policy to execute once per client request use PerCall otherwise use PerRetry to run the policy for every retry. Note that the same instance of policy would be added to all pipelines of client constructed using this ClientOptions object.

(Inherited from ClientOptions)

Applies to