VisualStudioCodeCredentialBuilder Class

  • Reference
Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.12.0

public class VisualStudioCodeCredentialBuilder
extends CredentialBuilderBase<VisualStudioCodeCredentialBuilder>

Fluent credential builder for instantiating a VisualStudioCodeCredential.

It's a known issue that this credential doesn't work with Azure Account extension versions newer than 0.9.11. A long-term fix to this problem is in progress. In the meantime, consider authenticating with AzureCliCredential.

Constructor Summary

Constructor Description
VisualStudioCodeCredentialBuilder()

Constructs an instance of VisualStudioCodeCredentialBuilder.

Method Summary

Modifier and Type Method and Description
VisualStudioCodeCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
VisualStudioCodeCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Specifies tenants in addition to the specified tenantId for which the credential may acquire tokens.
VisualStudioCodeCredential build()

Creates a new VisualStudioCodeCredential with the current configurations.
VisualStudioCodeCredentialBuilder tenantId(String tenantId)

Sets the tenant id of the user to authenticate through the VisualStudioCodeCredential.

Methods inherited from CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

VisualStudioCodeCredentialBuilder

public VisualStudioCodeCredentialBuilder()

Constructs an instance of VisualStudioCodeCredentialBuilder.

Method Details

additionallyAllowedTenants

public VisualStudioCodeCredentialBuilder additionallyAllowedTenants(String[] 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.

Parameters:

additionallyAllowedTenants - the additionally allowed tenants.

Returns:

An updated instance of this builder with the additional tenants configured.

additionallyAllowedTenants

public VisualStudioCodeCredentialBuilder additionallyAllowedTenants(List 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.

Parameters:

additionallyAllowedTenants - the additionally allowed tenants.

Returns:

An updated instance of this builder with the additional tenants configured.

build

public VisualStudioCodeCredential build()

Creates a new VisualStudioCodeCredential with the current configurations.

Returns:

a VisualStudioCodeCredential with the current configurations.

tenantId

public VisualStudioCodeCredentialBuilder tenantId(String tenantId)

Sets the tenant id of the user to authenticate through the VisualStudioCodeCredential. The default is the tenant the user originally authenticated to via via the Visual Studio Code Azure Account plugin.

Parameters:

tenantId - the tenant ID to set.

Returns:

An updated instance of this builder with the tenant id set as specified.

Applies to