Share via

AzureCliCredentialBuilder Class

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

public class AzureCliCredentialBuilder
extends CredentialBuilderBase<AzureCliCredentialBuilder>

Fluent credential builder for instantiating a AzureCliCredential.

The Azure CLI is a command-line tool that allows users to manage Azure resources from their local machine or terminal. It allows users to authenticate interactively as a user and/or a service principal against Microsoft Entra ID. The AzureCliCredential authenticates in a development environment and acquires a token on behalf of the logged-in user or service principal in Azure CLI. It acts as the Azure CLI logged in user or service principal and executes an Azure CLI command underneath to authenticate the application against Microsoft Entra ID.

Sample: Construct IntelliJCredential

The following code sample demonstrates the creation of a AzureCliCredential, using the AzureCliCredentialBuilder to configure it. Once this credential is created, it may be passed into the builder of many of the Azure SDK for Java client builders as the 'credential' parameter.

TokenCredential azureCliCredential = new AzureCliCredentialBuilder().build();

Constructor Summary

Constructor Description
AzureCliCredentialBuilder()

Constructs an instance of AzureCliCredentialBuilder.

Method Summary

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

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

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

Creates a new AzureCliCredential with the current configurations.
AzureCliCredentialBuilder processTimeout(Duration processTimeout)

Specifies a Duration timeout for calling the Azure CLI.
AzureCliCredentialBuilder tenantId(String tenantId)

Sets the tenant ID of the application.

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

AzureCliCredentialBuilder

public AzureCliCredentialBuilder()

Constructs an instance of AzureCliCredentialBuilder.

Method Details

additionallyAllowedTenants

public AzureCliCredentialBuilder 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 AzureCliCredentialBuilder 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 AzureCliCredential build()

Creates a new AzureCliCredential with the current configurations.

Returns:

a AzureCliCredential with the current configurations.

processTimeout

public AzureCliCredentialBuilder processTimeout(Duration processTimeout)

Specifies a Duration timeout for calling the Azure CLI. The timeout period is applied on the Azure CLI command execution process invoked by the credential

Parameters:

processTimeout - The Duration to wait.

Returns:

An updated instance of this builder with the timeout specified.

tenantId

public AzureCliCredentialBuilder tenantId(String tenantId)

Sets the tenant ID of the application.

Parameters:

tenantId - the tenant ID of the application.

Returns:

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

Applies to