ArmNetworkModelFactory.AuthenticationProviderProperties Method
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 static Azure.ResourceManager.Network.Models.AuthenticationProviderProperties AuthenticationProviderProperties(Uri issuer = default, Uri jwksUri = default, string audience = default, string clientId = default, Uri clientSecret = default, System.Collections.Generic.IEnumerable<string> scope = default, string sessionTimeout = default, string sessionCookieName = default);static member AuthenticationProviderProperties : Uri * Uri * string * string * Uri * seq<string> * string * string -> Azure.ResourceManager.Network.Models.AuthenticationProviderPropertiesPublic Shared Function AuthenticationProviderProperties (Optional issuer As Uri = Nothing, Optional jwksUri As Uri = Nothing, Optional audience As String = Nothing, Optional clientId As String = Nothing, Optional clientSecret As Uri = Nothing, Optional scope As IEnumerable(Of String) = Nothing, Optional sessionTimeout As String = Nothing, Optional sessionCookieName As String = Nothing) As AuthenticationProviderPropertiesParameters
- issuer
- Uri
The absolute HTTPS URL of the Secure Token Service. Include a trailing slash at the end of the value. Example: https://login.microsoftonline.com/{Microsoft Entra Tenant ID}/.
- jwksUri
- Uri
The JSON Web Key Set (JWKS) URI used to retrieve the public keys for JWT validation. Example: https://login.microsoftonline.com/{Microsoft Entra Tenant ID}/discovery/v2.0/keys.
- audience
- String
The intended audience for the JWT. Only a single audience value is supported in this API version. Example: https://audience.com/{application-id}.
- clientId
- String
The Application (client) ID for the related application registered in Microsoft Entra ID, formatted as a GUID.
- clientSecret
- Uri
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: https://myvault.vault.azure.net/secrets/mysecret.
- scope
- IEnumerable<String>
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.
- sessionTimeout
- String
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 86400). The supported range is 1 to 604800 seconds, and the default is 86400 seconds. Applicable to the Application Gateway post-OIDC workflow.
- sessionCookieName
- String
The name of the session cookie used for user authentication. Applicable to the Application Gateway post-OIDC workflow.
Returns
A new AuthenticationProviderProperties instance for mocking.
