com.microsoft.azure.credentials

Class AzureCliCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

com.microsoft.azure.credentials.AzureTokenCredentials

com.microsoft.azure.credentials.AzureCliCredentials

All Implemented Interfaces:

ServiceClientCredentials

@Beta
public final class AzureCliCredentials
extends AzureTokenCredentials

Token based credentials for use with a REST Service Client.

Method Summary

Modifier and Type	Method and Description
String	clientId()
static AzureCliCredentials	create() Creates an instance of AzureCliCredentials with the default Azure CLI configuration.
static AzureCliCredentials	create(File azureProfile, File accessTokens) Creates an instance of AzureCliCredentials with custom locations of the token files.
String	domain() Override this method to provide the domain or tenant ID the token is valid in.
AzureEnvironment	environment()
String	getToken(String resource) Override this method to provide the mechanism to get a token.

Methods inherited from class com.microsoft.azure.credentials.AzureTokenCredentials

applyCredentialsFilter, defaultSubscriptionId, getToken, proxy, withDefaultSubscriptionId, withProxy

Methods inherited from class com.microsoft.rest.credentials.TokenCredentials

getScheme

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static AzureCliCredentials create()
                                  throws IOException

Creates an instance of AzureCliCredentials with the default Azure CLI configuration.

Returns:

an instance of AzureCliCredentials

Throws:

IOException - if the Azure CLI token files are not accessible

create

public static AzureCliCredentials create(File azureProfile,
                                         File accessTokens)
                                  throws IOException

Creates an instance of AzureCliCredentials with custom locations of the token files.

Parameters:

azureProfile - the azureProfile.json file created by Azure CLI

accessTokens - the accessTokens.json file created by Azure CLI

Returns:

an instance of AzureCliCredentials

Throws:

IOException - if the Azure CLI token files are not accessible

clientId

public String clientId()

Returns:

the active directory application client id

domain

public String domain()

Description copied from class: AzureTokenCredentials

Override this method to provide the domain or tenant ID the token is valid in.

Overrides:

domain in class AzureTokenCredentials

Returns:

the tenant or domain the containing the application

environment

public AzureEnvironment environment()

Overrides:

environment in class AzureTokenCredentials

Returns:

the Azure environment to authenticate with

getToken

public String getToken(String resource)
                throws IOException

Description copied from class: AzureTokenCredentials

Override this method to provide the mechanism to get a token.

Specified by:

getToken in class AzureTokenCredentials

Parameters:

resource - the resource the access token is for

Returns:

the token to access the resource

Throws:

IOException - exceptions from IO