Partager via


SiteAuthSettingsV2 Class

Definition

Configuration settings for the Azure App Service Authentication / Authorization V2 feature.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.SiteAuthSettingsV2TypeConverter))]
public class SiteAuthSettingsV2 : Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ISiteAuthSettingsV2, Microsoft.Azure.PowerShell.Cmdlets.Websites.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.SiteAuthSettingsV2TypeConverter))>]
type SiteAuthSettingsV2 = class
    interface ISiteAuthSettingsV2
    interface IJsonSerializable
    interface IProxyOnlyResource
    interface IValidates
Public Class SiteAuthSettingsV2
Implements ISiteAuthSettingsV2, IValidates
Inheritance
SiteAuthSettingsV2
Attributes
Implements

Constructors

SiteAuthSettingsV2()

Creates an new SiteAuthSettingsV2 instance.

Properties

AzureBlobStorageSasUrlSettingName

The name of the app setting containing the SAS URL of the blob storage containing the tokens.

CookieExpirationConvention

The convention used when determining the session cookie's expiration.

CookieExpirationTimeToExpiration

The time after the request is made when the session cookie should expire.

FileSystemDirectory

The directory in which the tokens will be stored.

ForwardProxyConvention

The convention used to determine the url of the request made.

ForwardProxyCustomHostHeaderName

The name of the header containing the host of the request.

ForwardProxyCustomProtoHeaderName

The name of the header containing the scheme of the request.

GlobalValidationExcludedPath

The paths for which unauthenticated flow would not be redirected to the login page.

GlobalValidationRedirectToProvider

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".

GlobalValidationRequireAuthentication

true if the authentication flow is required any request is made; otherwise, false.

GlobalValidationUnauthenticatedClientAction

The action to take when an unauthenticated client attempts to access the app.

HttpSettingRequireHttps

false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.

Id

Resource Id.

IdentityProvider

The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.

Kind

Kind of resource.

LoginAllowedExternalRedirectUrl

External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

LoginPreserveUrlFragmentsForLogin

true if the fragments from the request are preserved after the login request is made; otherwise, false.

Name

Resource Name.

NonceExpirationInterval

The time after the request is made when the nonce should expire.

NonceValidateNonce

false if the nonce should not be validated while completing the login flow; otherwise, true.

PlatformConfigFilePath

The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory.

PlatformEnabled

true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.

PlatformRuntimeVersion

The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

RouteApiPrefix

The prefix that should precede all the authentication/authorization paths.

RouteLogoutEndpoint

The endpoint at which a logout request should be made.

TokenStoreEnabled

true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.

TokenStoreTokenRefreshExtensionHour

The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.

Type

Resource type.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SiteAuthSettingsV2.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SiteAuthSettingsV2.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Websites.Models.Api20210201.ISiteAuthSettingsV2.

FromJsonString(String)

Creates a new instance of SiteAuthSettingsV2, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SiteAuthSettingsV2 into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to