com.microsoft.azure.functions.annotation

Enum AuthorizationLevel

java.lang.Object

java.lang.Enum<AuthorizationLevel>

com.microsoft.azure.functions.annotation.AuthorizationLevel

All Implemented Interfaces:

Serializable, Comparable<AuthorizationLevel>

public enum AuthorizationLevel
extends Enum<AuthorizationLevel>

Azure HTTP authorization level, Determines what keys, if any, need to be present on the request in order to invoke the function.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN The master key is required.
ANONYMOUS No API key is required.
FUNCTION A function-specific API key is required.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANONYMOUS

public static final AuthorizationLevel ANONYMOUS

No API key is required.

FUNCTION

public static final AuthorizationLevel FUNCTION

A function-specific API key is required. This is the default value if none is provided.

ADMIN

public static final AuthorizationLevel ADMIN

The master key is required.

Method Detail

values

public static AuthorizationLevel[] 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 (AuthorizationLevel c : AuthorizationLevel.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuthorizationLevel valueOf(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:

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

NullPointerException - if the argument is null