Partager via


GlobalValidation Class

  • java.lang.Object
    • com.azure.resourcemanager.appservice.models.GlobalValidation

Implements

public final class GlobalValidation
implements JsonSerializable<GlobalValidation>

The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.

Constructor Summary

Constructor Description
GlobalValidation()

Creates an instance of GlobalValidation class.

Method Summary

Modifier and Type Method and Description
List<String> excludedPaths()

Get the excludedPaths property: The paths for which unauthenticated flow would not be redirected to the login page.

static GlobalValidation fromJson(JsonReader jsonReader)

Reads an instance of GlobalValidation from the JsonReader.

String redirectToProvider()

Get the redirectToProvider property: The default authentication provider to use when multiple providers are configured.

Boolean requireAuthentication()

Get the requireAuthentication property: true if the authentication flow is required any request is made; otherwise, false.

JsonWriter toJson(JsonWriter jsonWriter)
UnauthenticatedClientActionV2 unauthenticatedClientAction()

Get the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

void validate()

Validates the instance.

GlobalValidation withExcludedPaths(List<String> excludedPaths)

Set the excludedPaths property: The paths for which unauthenticated flow would not be redirected to the login page.

GlobalValidation withRedirectToProvider(String redirectToProvider)

Set the redirectToProvider property: The default authentication provider to use when multiple providers are configured.

GlobalValidation withRequireAuthentication(Boolean requireAuthentication)

Set the requireAuthentication property: true if the authentication flow is required any request is made; otherwise, false.

GlobalValidation withUnauthenticatedClientAction(UnauthenticatedClientActionV2 unauthenticatedClientAction)

Set the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

Methods inherited from java.lang.Object

Constructor Details

GlobalValidation

public GlobalValidation()

Creates an instance of GlobalValidation class.

Method Details

excludedPaths

public List excludedPaths()

Get the excludedPaths property: The paths for which unauthenticated flow would not be redirected to the login page.

Returns:

the excludedPaths value.

fromJson

public static GlobalValidation fromJson(JsonReader jsonReader)

Reads an instance of GlobalValidation from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GlobalValidation if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the GlobalValidation.

redirectToProvider

public String redirectToProvider()

Get the redirectToProvider property: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage".

Returns:

the redirectToProvider value.

requireAuthentication

public Boolean requireAuthentication()

Get the requireAuthentication property: true if the authentication flow is required any request is made; otherwise, false.

Returns:

the requireAuthentication value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

unauthenticatedClientAction

public UnauthenticatedClientActionV2 unauthenticatedClientAction()

Get the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

Returns:

the unauthenticatedClientAction value.

validate

public void validate()

Validates the instance.

withExcludedPaths

public GlobalValidation withExcludedPaths(List excludedPaths)

Set the excludedPaths property: The paths for which unauthenticated flow would not be redirected to the login page.

Parameters:

excludedPaths - the excludedPaths value to set.

Returns:

the GlobalValidation object itself.

withRedirectToProvider

public GlobalValidation withRedirectToProvider(String redirectToProvider)

Set the redirectToProvider property: The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage".

Parameters:

redirectToProvider - the redirectToProvider value to set.

Returns:

the GlobalValidation object itself.

withRequireAuthentication

public GlobalValidation withRequireAuthentication(Boolean requireAuthentication)

Set the requireAuthentication property: true if the authentication flow is required any request is made; otherwise, false.

Parameters:

requireAuthentication - the requireAuthentication value to set.

Returns:

the GlobalValidation object itself.

withUnauthenticatedClientAction

public GlobalValidation withUnauthenticatedClientAction(UnauthenticatedClientActionV2 unauthenticatedClientAction)

Set the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

Parameters:

unauthenticatedClientAction - the unauthenticatedClientAction value to set.

Returns:

the GlobalValidation object itself.

Applies to