Share via


AzureActiveDirectory Class

Definition

The configuration settings of the Azure Active directory provider.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AzureActiveDirectoryTypeConverter))]
public class AzureActiveDirectory : Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAzureActiveDirectory
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AzureActiveDirectoryTypeConverter))>]
type AzureActiveDirectory = class
    interface IAzureActiveDirectory
    interface IJsonSerializable
Public Class AzureActiveDirectory
Implements IAzureActiveDirectory
Inheritance
AzureActiveDirectory
Attributes
Implements

Constructors

AzureActiveDirectory()

Creates an new AzureActiveDirectory instance.

Properties

AllowedPrincipalGroup

The list of the allowed groups.

AllowedPrincipalIdentity

The list of the allowed identities.

DefaultAuthorizationPolicyAllowedApplication

The configuration settings of the Azure Active Directory allowed applications.

Enabled

false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true.

IsAutoProvisioned

Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. This is an internal flag primarily intended to support the Azure Management Portal. Users should not read or write to this property.

JwtClaimCheckAllowedClientApplication

The list of the allowed client applications.

JwtClaimCheckAllowedGroup

The list of the allowed groups.

LoginDisableWwwAuthenticate

true if the www-authenticate provider should be omitted from the request; otherwise, false.

LoginParameter

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

RegistrationClientId

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

RegistrationClientSecretCertificateIssuer

An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

RegistrationClientSecretCertificateSubjectAlternativeName

An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.

RegistrationClientSecretCertificateThumbprint

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.

RegistrationClientSecretSettingName

The app setting name that contains the client secret of the relying party application.

RegistrationOpenIdIssuer

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://login.microsoftonline.com/v2.0/{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

ValidationAllowedAudience

The list of audiences that can make successful authentication/authorization requests.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of AzureActiveDirectory.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of AzureActiveDirectory.

FromJson(JsonNode)

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

FromJsonString(String)

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

ToJson(JsonObject, SerializationMode)

Serializes this instance of AzureActiveDirectory into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to