AuthenticationProviderProperties Class
Definition
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.
Properties for authentication provider configuration. A policy must configure either JWT validation fields or user sign-in fields; the two configurations are mutually exclusive and cannot be combined.
public class AuthenticationProviderProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Network.Models.AuthenticationProviderProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Network.Models.AuthenticationProviderProperties>type AuthenticationProviderProperties = class
interface IJsonModel<AuthenticationProviderProperties>
interface IPersistableModel<AuthenticationProviderProperties>Public Class AuthenticationProviderProperties
Implements IJsonModel(Of AuthenticationProviderProperties), IPersistableModel(Of AuthenticationProviderProperties)- Inheritance
-
AuthenticationProviderProperties
- Implements
Constructors
| Name | Description |
|---|---|
| AuthenticationProviderProperties(Uri, String) |
Initializes a new instance of AuthenticationProviderProperties. |
Properties
| Name | Description |
|---|---|
| Audience |
The intended audience for the JWT. Only a single audience value is supported in this API version. Example: https://audience.com/{application-id}. |
| ClientId |
The Application (client) ID for the related application registered in Microsoft Entra ID, formatted as a GUID. |
| ClientSecret |
The absolute HTTPS Key Vault secret URL identifying the client secret used for authentication. This property is required for user sign-in policies. It holds only the Key Vault reference; the secret value itself is never accepted or returned by this API and is read from Key Vault at runtime using the resource's user-assigned identity. The secret value stored in Key Vault can contain up to 4096 characters. Example: |
| Issuer |
The absolute HTTPS URL of the Secure Token Service. Include a trailing slash at the end of the value. Example: |
| JwksUri |
The JSON Web Key Set (JWKS) URI used to retrieve the public keys for JWT validation. Example: |
| Scope |
The scopes used by an application during authentication to authorize access to a user's details. A maximum of 10 scopes is supported, each scope can contain up to 128 characters, and all scopes can contain up to 256 characters combined. |
| SessionCookieName |
The name of the session cookie used for user authentication. Applicable to the Application Gateway post-OIDC workflow. |
| SessionTimeout |
The timeout of the session cookie used for user authentication. The service accepts and returns this value as a string containing a base-10 unsigned integer number of seconds with no sign, decimal point, unit suffix, or whitespace (for example |
