com.microsoft.identity.client

Enum AzureCloudInstance

java.lang.Object

java.lang.Enum<AzureCloudInstance>

com.microsoft.identity.client.AzureCloudInstance

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AzureCloudInstance>

public enum AzureCloudInstance
extends java.lang.Enum<AzureCloudInstance>

The clouds that can be used for Authority when making token requests in MSAL.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AzureChina Microsoft Chinese national cloud.
AzureGermany Microsoft German national cloud (Black Forest).
AzurePublic Microsoft Azure public cloud.
AzureUsGov US Government cloud.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCloudInstanceUri()
static AzureCloudInstance	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AzureCloudInstance[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AzurePublic

public static final AzureCloudInstance AzurePublic

Microsoft Azure public cloud. Maps to https://login.microsoftonline.com.

AzureChina

public static final AzureCloudInstance AzureChina

Microsoft Chinese national cloud. Maps to https://login.partner.microsoftonline.cn.

AzureGermany

public static final AzureCloudInstance AzureGermany

Microsoft German national cloud (Black Forest). Maps to https://login.microsoftonline.de.

AzureUsGov

public static final AzureCloudInstance AzureUsGov

US Government cloud. Maps to https://login.microsoftonline.us.

Method Detail

values

public static AzureCloudInstance[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AzureCloudInstance c : AzureCloudInstance.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AzureCloudInstance valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCloudInstanceUri

public java.lang.String getCloudInstanceUri()