VisualStudioCredentialOptions Class

  • Reference

Definition

Namespace:
Azure.Identity
Assembly:
Azure.Identity.dll
Package:
Azure.Identity v1.13.1
Package:
Azure.Identity v1.13.0-beta.2
Source:
VisualStudioCredentialOptions.cs
Source:
VisualStudioCredentialOptions.cs

Options for configuring the VisualStudioCredential.

public class VisualStudioCredentialOptions : Azure.Identity.TokenCredentialOptions
type VisualStudioCredentialOptions = class
    inherit TokenCredentialOptions
Public Class VisualStudioCredentialOptions
Inherits TokenCredentialOptions
Inheritance
Object
ClientOptions
TokenCredentialOptions
VisualStudioCredentialOptions

Constructors

VisualStudioCredentialOptions()

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

The host of the Microsoft Entra authority. The default is https://login.microsoftonline.com/. For well known authority hosts for Azure cloud instances see AzureAuthorityHosts.

(Inherited from TokenCredentialOptions)
Diagnostics

Gets the credential diagnostic options.

(Inherited from TokenCredentialOptions)
IsUnsafeSupportLoggingEnabled

Gets or sets value indicating if ETW logging that contains potentially sensitive content should be logged. Setting this property to true will not disable redaction of Request Content. To enable logging of sensitive Content the IsLoggingContentEnabled property must be set to true. Setting this property to true equates to passing 'true' for the enablePiiLogging parameter to the 'WithLogging' method on the MSAL client builder.

(Inherited from TokenCredentialOptions)
ProcessTimeout

The VisualStudio process timeout.
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 overridden or a custom HttpPipelinePolicy is specified, it is the implementer's responsibility to update the ProcessingContext values.

(Inherited from ClientOptions)
TenantId

The tenant ID the credential will be authenticated to by default. If not specified, the credential will authenticate to any requested tenant, and will default to the tenant the user originally authenticated to via the Visual Studio Azure Service Account dialog.
Transport

The HttpPipelineTransport to be used for this client. Defaults to an instance of HttpClientTransport.

(Inherited from ClientOptions)

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