Share via


AuthConfig Class

Definition

Configuration settings for the Azure ContainerApp Service Authentication / Authorization feature.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AuthConfigTypeConverter))]
public class AuthConfig : Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAuthConfig, Microsoft.Azure.PowerShell.Cmdlets.App.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AuthConfigTypeConverter))>]
type AuthConfig = class
    interface IAuthConfig
    interface IJsonSerializable
    interface IProxyResource
    interface IResource
    interface IValidates
Public Class AuthConfig
Implements IAuthConfig, IValidates
Inheritance
AuthConfig
Attributes
Implements

Constructors

AuthConfig()

Creates an new AuthConfig instance.

Properties

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.

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

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

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

IdentityProvider

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

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

The name of the resource

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.

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.

ResourceGroupName

Gets the resource group name

RouteApiPrefix

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

RouteLogoutEndpoint

The endpoint at which a logout request should be made.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of AuthConfig.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of AuthConfig.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAuthConfig.

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of AuthConfig into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to