com.microsoft.azure.credentials

Class MSICredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

com.microsoft.azure.credentials.AzureTokenCredentials

com.microsoft.azure.credentials.MSICredentials

All Implemented Interfaces:

ServiceClientCredentials

@Beta
public class MSICredentials
extends AzureTokenCredentials

Managed Service Identity token based credentials for use with a REST Service Client.

Constructor Summary

Constructors

Constructor and Description
MSICredentials() Initializes a new instance of the MSICredentials.
MSICredentials(AzureEnvironment environment) Initializes a new instance of the MSICredentials.
MSICredentials(AzureEnvironment environment, int msiPort) Initializes a new instance of the MSICredentials.

Method Summary

Modifier and Type	Method and Description
String	getToken(String resource) Override this method to provide the mechanism to get a token.
MSICredentials	withClientId(String clientId) Specifies the application id (client id) associated with a user assigned managed service identity resource that should be used to retrieve the access token.
MSICredentials	withIdentityId(String identityId) Specifies the ARM resource id of the user assigned managed service identity resource that should be used to retrieve the access token.
MSICredentials	withObjectId(String objectId) Specifies the object id associated with a user assigned managed service identity resource that should be used to retrieve the access token.

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

applyCredentialsFilter, defaultSubscriptionId, domain, environment, 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

Constructor Detail

MSICredentials

public MSICredentials()

Initializes a new instance of the MSICredentials.

MSICredentials

public MSICredentials(AzureEnvironment environment)

Initializes a new instance of the MSICredentials.

Parameters:

environment - the Azure environment to use

MSICredentials

public MSICredentials(AzureEnvironment environment,
                      int msiPort)

Initializes a new instance of the MSICredentials.

Parameters:

environment - the Azure environment to use

msiPort - the local port to retrieve token from

Method Detail

withObjectId

@Beta
public MSICredentials withObjectId(String objectId)

Specifies the object id associated with a user assigned managed service identity resource that should be used to retrieve the access token.

Parameters:

objectId - Object ID of the identity to use when authenticating to Azure AD.

Returns:

MSICredentials

withClientId

@Beta
public MSICredentials withClientId(String clientId)

Specifies the application id (client id) associated with a user assigned managed service identity resource that should be used to retrieve the access token.

Parameters:

clientId - application id (client id) of the identity to use when authenticating to Azure AD.

Returns:

MSICredentials

withIdentityId

@Beta
public MSICredentials withIdentityId(String identityId)

Specifies the ARM resource id of the user assigned managed service identity resource that should be used to retrieve the access token.

Parameters:

identityId - the ARM resource id of the user assigned identity resource

Returns:

MSICredentials

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