AzureActiveDirectoryRegistration Class

Package:

com.azure.resourcemanager.appservice.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.47.0

• java.lang.Object
• • com.azure.resourcemanager.appservice.models.AzureActiveDirectoryRegistration

Implements

JsonSerializable<AzureActiveDirectoryRegistration>

public final class AzureActiveDirectoryRegistration
implements JsonSerializable<AzureActiveDirectoryRegistration>

The configuration settings of the Azure Active Directory app registration.

Constructor Summary

Constructor	Description
AzureActiveDirectoryRegistration()	Creates an instance of AzureActiveDirectoryRegistration class.

Method Summary

Modifier and Type	Method and Description
String	clientId() Get the clientId property: The Client ID of this relying party application, known as the client_id.
String	clientSecretCertificateIssuer() Get the clientSecretCertificateIssuer property: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes.
String	clientSecretCertificateSubjectAlternativeName() Get the clientSecretCertificateSubjectAlternativeName property: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes.
String	clientSecretCertificateThumbprint() Get the clientSecretCertificateThumbprint property: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes.
String	clientSecretSettingName() Get the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.
static AzureActiveDirectoryRegistration	fromJson(JsonReader jsonReader) Reads an instance of AzureActiveDirectoryRegistration from the JsonReader.
String	openIdIssuer() Get the openIdIssuer property: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
AzureActiveDirectoryRegistration	withClientId(String clientId) Set the clientId property: The Client ID of this relying party application, known as the client_id.
AzureActiveDirectoryRegistration	withClientSecretCertificateIssuer(String clientSecretCertificateIssuer) Set the clientSecretCertificateIssuer property: An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes.
AzureActiveDirectoryRegistration	withClientSecretCertificateSubjectAlternativeName(String clientSecretCertificateSubjectAlternativeName) Set the clientSecretCertificateSubjectAlternativeName property: An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes.
AzureActiveDirectoryRegistration	withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint) Set the clientSecretCertificateThumbprint property: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes.
AzureActiveDirectoryRegistration	withClientSecretSettingName(String clientSecretSettingName) Set the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.
AzureActiveDirectoryRegistration	withOpenIdIssuer(String openIdIssuer) Set the openIdIssuer property: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AzureActiveDirectoryRegistration

public AzureActiveDirectoryRegistration()

Creates an instance of AzureActiveDirectoryRegistration class.

Method Details

clientId

public String clientId()

Get the clientId property: 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.

Returns:

the clientId value.

clientSecretCertificateIssuer

public String clientSecretCertificateIssuer()

Get the clientSecretCertificateIssuer property: 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.

Returns:

the clientSecretCertificateIssuer value.

clientSecretCertificateSubjectAlternativeName

public String clientSecretCertificateSubjectAlternativeName()

Get the clientSecretCertificateSubjectAlternativeName property: 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.

Returns:

the clientSecretCertificateSubjectAlternativeName value.

clientSecretCertificateThumbprint

public String clientSecretCertificateThumbprint()

Get the clientSecretCertificateThumbprint property: 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.

Returns:

the clientSecretCertificateThumbprint value.

clientSecretSettingName

public String clientSecretSettingName()

Get the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.

Returns:

the clientSecretSettingName value.

fromJson

public static AzureActiveDirectoryRegistration fromJson(JsonReader jsonReader)

Reads an instance of AzureActiveDirectoryRegistration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureActiveDirectoryRegistration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the AzureActiveDirectoryRegistration.

openIdIssuer

public String openIdIssuer()

Get the openIdIssuer property: 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.

Returns:

the openIdIssuer value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withClientId

public AzureActiveDirectoryRegistration withClientId(String clientId)

Set the clientId property: 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.

Parameters:

clientId - the clientId value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.

withClientSecretCertificateIssuer

public AzureActiveDirectoryRegistration withClientSecretCertificateIssuer(String clientSecretCertificateIssuer)

Set the clientSecretCertificateIssuer property: 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.

Parameters:

clientSecretCertificateIssuer - the clientSecretCertificateIssuer value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.

withClientSecretCertificateSubjectAlternativeName

public AzureActiveDirectoryRegistration withClientSecretCertificateSubjectAlternativeName(String clientSecretCertificateSubjectAlternativeName)

Set the clientSecretCertificateSubjectAlternativeName property: 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.

Parameters:

clientSecretCertificateSubjectAlternativeName - the clientSecretCertificateSubjectAlternativeName value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.

withClientSecretCertificateThumbprint

public AzureActiveDirectoryRegistration withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint)

Set the clientSecretCertificateThumbprint property: 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.

Parameters:

clientSecretCertificateThumbprint - the clientSecretCertificateThumbprint value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.

withClientSecretSettingName

public AzureActiveDirectoryRegistration withClientSecretSettingName(String clientSecretSettingName)

Set the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.

Parameters:

clientSecretSettingName - the clientSecretSettingName value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.

withOpenIdIssuer

public AzureActiveDirectoryRegistration withOpenIdIssuer(String openIdIssuer)

Set the openIdIssuer property: 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.

Parameters:

openIdIssuer - the openIdIssuer value to set.

Returns:

the AzureActiveDirectoryRegistration object itself.