SiteAuthSettings Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201

Assembly:: Az.Functions.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SiteAuthSettingsTypeConverter))]
public class SiteAuthSettings : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISiteAuthSettings, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SiteAuthSettingsTypeConverter))>]
type SiteAuthSettings = class
    interface ISiteAuthSettings
    interface IJsonSerializable
    interface IProxyOnlyResource
    interface IValidates

Public Class SiteAuthSettings
Implements ISiteAuthSettings, IValidates

Inheritance: Object
SiteAuthSettings

Attributes: TypeConverterAttribute

Implements: IProxyOnlyResource ISiteAuthSettings IJsonSerializable IValidates

Constructors

SiteAuthSettings()

Creates an new SiteAuthSettings instance.

Properties

AadClaimsAuthorization	Gets a JSON string containing the Azure AD Acl settings.
AdditionalLoginParam	Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
AllowedAudience	Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the `ClientID` value is always considered an allowed audience, regardless of this setting.
AllowedExternalRedirectUrl	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.
AuthFilePath	The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
ClientId	The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
ClientSecret	The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
ClientSecretCertificateThumbprint	An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
ClientSecretSettingName	The app setting name that contains the client secret of the relying party application.
ConfigVersion	The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.
DefaultProvider	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".
Enabled	`true` if the Authentication / Authorization feature is enabled for the current app; otherwise, `false`.
FacebookAppId	The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
FacebookAppSecret	The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
FacebookAppSecretSettingName	The app setting name that contains the app secret used for Facebook Login.
FacebookOAuthScope	The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login
GitHubClientId	The Client Id of the GitHub app used for login. This setting is required for enabling Github login
GitHubClientSecret	The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
GitHubClientSecretSettingName	The app setting name that contains the client secret of the Github app used for GitHub Login.
GitHubOAuthScope	The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
GoogleClientId	The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
GoogleClientSecret	The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
GoogleClientSecretSettingName	The app setting name that contains the client secret associated with the Google web application.
GoogleOAuthScope	The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/
Id	Resource Id.
IsAuthFromFile	"true" if the auth config settings should be read from a file, "false" otherwise
Issuer	The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
Kind	Kind of resource.
MicrosoftAccountClientId	The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
MicrosoftAccountClientSecret	The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm
MicrosoftAccountClientSecretSettingName	The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
MicrosoftAccountOAuthScope	The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx
Name	Resource Name.
RuntimeVersion	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.
TokenRefreshExtensionHour	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.
TokenStoreEnabled	`true` to durably store platform-specific security tokens that are obtained during login flows; otherwise, `false`. The default is `false`.
TwitterConsumerKey	The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
TwitterConsumerSecret	The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in
TwitterConsumerSecretSettingName	The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
Type	Resource type.
UnauthenticatedClientAction	The action to take when an unauthenticated client attempts to access the app.
ValidateIssuer	Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of SiteAuthSettings.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of SiteAuthSettings.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISiteAuthSettings.
FromJsonString(String)	Creates a new instance of SiteAuthSettings, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of SiteAuthSettings into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to

Partager via