com.pulumi.azure.appservice.inputs.WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.appservice.inputs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args extends com.pulumi.resources.ResourceArgs {
public static final WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args Empty = new WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args();
/**
* The list of allowed Applications for the Default Authorisation Policy.
*
*/
@Import(name="allowedApplications")
private @Nullable Output> allowedApplications;
/**
* @return The list of allowed Applications for the Default Authorisation Policy.
*
*/
public Optional>> allowedApplications() {
return Optional.ofNullable(this.allowedApplications);
}
/**
* Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
*
* > **NOTE:** This is configured on the Authentication Provider side and is Read Only here.
*
*/
@Import(name="allowedAudiences")
private @Nullable Output> allowedAudiences;
/**
* @return Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
*
* > **NOTE:** This is configured on the Authentication Provider side and is Read Only here.
*
*/
public Optional>> allowedAudiences() {
return Optional.ofNullable(this.allowedAudiences);
}
/**
* The list of allowed Group Names for the Default Authorisation Policy.
*
*/
@Import(name="allowedGroups")
private @Nullable Output> allowedGroups;
/**
* @return The list of allowed Group Names for the Default Authorisation Policy.
*
*/
public Optional>> allowedGroups() {
return Optional.ofNullable(this.allowedGroups);
}
/**
* The list of allowed Identities for the Default Authorisation Policy.
*
*/
@Import(name="allowedIdentities")
private @Nullable Output> allowedIdentities;
/**
* @return The list of allowed Identities for the Default Authorisation Policy.
*
*/
public Optional>> allowedIdentities() {
return Optional.ofNullable(this.allowedIdentities);
}
/**
* The ID of the Client to use to authenticate with Azure Active Directory.
*
*/
@Import(name="clientId", required=true)
private Output clientId;
/**
* @return The ID of the Client to use to authenticate with Azure Active Directory.
*
*/
public Output clientId() {
return this.clientId;
}
/**
* The thumbprint of the certificate used for signing purposes.
*
*/
@Import(name="clientSecretCertificateThumbprint")
private @Nullable Output clientSecretCertificateThumbprint;
/**
* @return The thumbprint of the certificate used for signing purposes.
*
*/
public Optional> clientSecretCertificateThumbprint() {
return Optional.ofNullable(this.clientSecretCertificateThumbprint);
}
/**
* The App Setting name that contains the client secret of the Client.
*
* !> **NOTE:** A setting with this name must exist in `app_settings` to function correctly.
*
*/
@Import(name="clientSecretSettingName")
private @Nullable Output clientSecretSettingName;
/**
* @return The App Setting name that contains the client secret of the Client.
*
* !> **NOTE:** A setting with this name must exist in `app_settings` to function correctly.
*
*/
public Optional> clientSecretSettingName() {
return Optional.ofNullable(this.clientSecretSettingName);
}
/**
* A list of Allowed Client Applications in the JWT Claim.
*
*/
@Import(name="jwtAllowedClientApplications")
private @Nullable Output> jwtAllowedClientApplications;
/**
* @return A list of Allowed Client Applications in the JWT Claim.
*
*/
public Optional>> jwtAllowedClientApplications() {
return Optional.ofNullable(this.jwtAllowedClientApplications);
}
/**
* A list of Allowed Groups in the JWT Claim.
*
*/
@Import(name="jwtAllowedGroups")
private @Nullable Output> jwtAllowedGroups;
/**
* @return A list of Allowed Groups in the JWT Claim.
*
*/
public Optional>> jwtAllowedGroups() {
return Optional.ofNullable(this.jwtAllowedGroups);
}
/**
* A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
*
*/
@Import(name="loginParameters")
private @Nullable Output> loginParameters;
/**
* @return A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
*
*/
public Optional>> loginParameters() {
return Optional.ofNullable(this.loginParameters);
}
/**
* The Azure Tenant Endpoint for the Authenticating Tenant. e.g. `https://login.microsoftonline.com/{tenant-guid}/v2.0/`
*
* > **NOTE:** [Here](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud#microsoft-entra-authentication-endpoints) is a list of possible authentication endpoints based on the cloud environment. [Here](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-tenant) is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
*
*/
@Import(name="tenantAuthEndpoint", required=true)
private Output tenantAuthEndpoint;
/**
* @return The Azure Tenant Endpoint for the Authenticating Tenant. e.g. `https://login.microsoftonline.com/{tenant-guid}/v2.0/`
*
* > **NOTE:** [Here](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud#microsoft-entra-authentication-endpoints) is a list of possible authentication endpoints based on the cloud environment. [Here](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-tenant) is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
*
*/
public Output tenantAuthEndpoint() {
return this.tenantAuthEndpoint;
}
/**
* Should the www-authenticate provider should be omitted from the request? Defaults to `false`.
*
*/
@Import(name="wwwAuthenticationDisabled")
private @Nullable Output wwwAuthenticationDisabled;
/**
* @return Should the www-authenticate provider should be omitted from the request? Defaults to `false`.
*
*/
public Optional> wwwAuthenticationDisabled() {
return Optional.ofNullable(this.wwwAuthenticationDisabled);
}
private WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args() {}
private WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args(WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args $) {
this.allowedApplications = $.allowedApplications;
this.allowedAudiences = $.allowedAudiences;
this.allowedGroups = $.allowedGroups;
this.allowedIdentities = $.allowedIdentities;
this.clientId = $.clientId;
this.clientSecretCertificateThumbprint = $.clientSecretCertificateThumbprint;
this.clientSecretSettingName = $.clientSecretSettingName;
this.jwtAllowedClientApplications = $.jwtAllowedClientApplications;
this.jwtAllowedGroups = $.jwtAllowedGroups;
this.loginParameters = $.loginParameters;
this.tenantAuthEndpoint = $.tenantAuthEndpoint;
this.wwwAuthenticationDisabled = $.wwwAuthenticationDisabled;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args defaults) {
return new Builder(defaults);
}
public static final class Builder {
private WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args $;
public Builder() {
$ = new WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args();
}
public Builder(WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args defaults) {
$ = new WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args(Objects.requireNonNull(defaults));
}
/**
* @param allowedApplications The list of allowed Applications for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedApplications(@Nullable Output> allowedApplications) {
$.allowedApplications = allowedApplications;
return this;
}
/**
* @param allowedApplications The list of allowed Applications for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedApplications(List allowedApplications) {
return allowedApplications(Output.of(allowedApplications));
}
/**
* @param allowedApplications The list of allowed Applications for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedApplications(String... allowedApplications) {
return allowedApplications(List.of(allowedApplications));
}
/**
* @param allowedAudiences Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
*
* > **NOTE:** This is configured on the Authentication Provider side and is Read Only here.
*
* @return builder
*
*/
public Builder allowedAudiences(@Nullable Output> allowedAudiences) {
$.allowedAudiences = allowedAudiences;
return this;
}
/**
* @param allowedAudiences Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
*
* > **NOTE:** This is configured on the Authentication Provider side and is Read Only here.
*
* @return builder
*
*/
public Builder allowedAudiences(List allowedAudiences) {
return allowedAudiences(Output.of(allowedAudiences));
}
/**
* @param allowedAudiences Specifies a list of Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
*
* > **NOTE:** This is configured on the Authentication Provider side and is Read Only here.
*
* @return builder
*
*/
public Builder allowedAudiences(String... allowedAudiences) {
return allowedAudiences(List.of(allowedAudiences));
}
/**
* @param allowedGroups The list of allowed Group Names for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedGroups(@Nullable Output> allowedGroups) {
$.allowedGroups = allowedGroups;
return this;
}
/**
* @param allowedGroups The list of allowed Group Names for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedGroups(List allowedGroups) {
return allowedGroups(Output.of(allowedGroups));
}
/**
* @param allowedGroups The list of allowed Group Names for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedGroups(String... allowedGroups) {
return allowedGroups(List.of(allowedGroups));
}
/**
* @param allowedIdentities The list of allowed Identities for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedIdentities(@Nullable Output> allowedIdentities) {
$.allowedIdentities = allowedIdentities;
return this;
}
/**
* @param allowedIdentities The list of allowed Identities for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedIdentities(List allowedIdentities) {
return allowedIdentities(Output.of(allowedIdentities));
}
/**
* @param allowedIdentities The list of allowed Identities for the Default Authorisation Policy.
*
* @return builder
*
*/
public Builder allowedIdentities(String... allowedIdentities) {
return allowedIdentities(List.of(allowedIdentities));
}
/**
* @param clientId The ID of the Client to use to authenticate with Azure Active Directory.
*
* @return builder
*
*/
public Builder clientId(Output clientId) {
$.clientId = clientId;
return this;
}
/**
* @param clientId The ID of the Client to use to authenticate with Azure Active Directory.
*
* @return builder
*
*/
public Builder clientId(String clientId) {
return clientId(Output.of(clientId));
}
/**
* @param clientSecretCertificateThumbprint The thumbprint of the certificate used for signing purposes.
*
* @return builder
*
*/
public Builder clientSecretCertificateThumbprint(@Nullable Output clientSecretCertificateThumbprint) {
$.clientSecretCertificateThumbprint = clientSecretCertificateThumbprint;
return this;
}
/**
* @param clientSecretCertificateThumbprint The thumbprint of the certificate used for signing purposes.
*
* @return builder
*
*/
public Builder clientSecretCertificateThumbprint(String clientSecretCertificateThumbprint) {
return clientSecretCertificateThumbprint(Output.of(clientSecretCertificateThumbprint));
}
/**
* @param clientSecretSettingName The App Setting name that contains the client secret of the Client.
*
* !> **NOTE:** A setting with this name must exist in `app_settings` to function correctly.
*
* @return builder
*
*/
public Builder clientSecretSettingName(@Nullable Output clientSecretSettingName) {
$.clientSecretSettingName = clientSecretSettingName;
return this;
}
/**
* @param clientSecretSettingName The App Setting name that contains the client secret of the Client.
*
* !> **NOTE:** A setting with this name must exist in `app_settings` to function correctly.
*
* @return builder
*
*/
public Builder clientSecretSettingName(String clientSecretSettingName) {
return clientSecretSettingName(Output.of(clientSecretSettingName));
}
/**
* @param jwtAllowedClientApplications A list of Allowed Client Applications in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedClientApplications(@Nullable Output> jwtAllowedClientApplications) {
$.jwtAllowedClientApplications = jwtAllowedClientApplications;
return this;
}
/**
* @param jwtAllowedClientApplications A list of Allowed Client Applications in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedClientApplications(List jwtAllowedClientApplications) {
return jwtAllowedClientApplications(Output.of(jwtAllowedClientApplications));
}
/**
* @param jwtAllowedClientApplications A list of Allowed Client Applications in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedClientApplications(String... jwtAllowedClientApplications) {
return jwtAllowedClientApplications(List.of(jwtAllowedClientApplications));
}
/**
* @param jwtAllowedGroups A list of Allowed Groups in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedGroups(@Nullable Output> jwtAllowedGroups) {
$.jwtAllowedGroups = jwtAllowedGroups;
return this;
}
/**
* @param jwtAllowedGroups A list of Allowed Groups in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedGroups(List jwtAllowedGroups) {
return jwtAllowedGroups(Output.of(jwtAllowedGroups));
}
/**
* @param jwtAllowedGroups A list of Allowed Groups in the JWT Claim.
*
* @return builder
*
*/
public Builder jwtAllowedGroups(String... jwtAllowedGroups) {
return jwtAllowedGroups(List.of(jwtAllowedGroups));
}
/**
* @param loginParameters A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
*
* @return builder
*
*/
public Builder loginParameters(@Nullable Output> loginParameters) {
$.loginParameters = loginParameters;
return this;
}
/**
* @param loginParameters A map of key-value pairs to send to the Authorisation Endpoint when a user logs in.
*
* @return builder
*
*/
public Builder loginParameters(Map loginParameters) {
return loginParameters(Output.of(loginParameters));
}
/**
* @param tenantAuthEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g. `https://login.microsoftonline.com/{tenant-guid}/v2.0/`
*
* > **NOTE:** [Here](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud#microsoft-entra-authentication-endpoints) is a list of possible authentication endpoints based on the cloud environment. [Here](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-tenant) is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
*
* @return builder
*
*/
public Builder tenantAuthEndpoint(Output tenantAuthEndpoint) {
$.tenantAuthEndpoint = tenantAuthEndpoint;
return this;
}
/**
* @param tenantAuthEndpoint The Azure Tenant Endpoint for the Authenticating Tenant. e.g. `https://login.microsoftonline.com/{tenant-guid}/v2.0/`
*
* > **NOTE:** [Here](https://learn.microsoft.com/en-us/entra/identity-platform/authentication-national-cloud#microsoft-entra-authentication-endpoints) is a list of possible authentication endpoints based on the cloud environment. [Here](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-tenant) is more information to better understand how to configure authentication for Azure App Service or Azure Functions.
*
* @return builder
*
*/
public Builder tenantAuthEndpoint(String tenantAuthEndpoint) {
return tenantAuthEndpoint(Output.of(tenantAuthEndpoint));
}
/**
* @param wwwAuthenticationDisabled Should the www-authenticate provider should be omitted from the request? Defaults to `false`.
*
* @return builder
*
*/
public Builder wwwAuthenticationDisabled(@Nullable Output wwwAuthenticationDisabled) {
$.wwwAuthenticationDisabled = wwwAuthenticationDisabled;
return this;
}
/**
* @param wwwAuthenticationDisabled Should the www-authenticate provider should be omitted from the request? Defaults to `false`.
*
* @return builder
*
*/
public Builder wwwAuthenticationDisabled(Boolean wwwAuthenticationDisabled) {
return wwwAuthenticationDisabled(Output.of(wwwAuthenticationDisabled));
}
public WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args build() {
if ($.clientId == null) {
throw new MissingRequiredPropertyException("WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args", "clientId");
}
if ($.tenantAuthEndpoint == null) {
throw new MissingRequiredPropertyException("WindowsWebAppAuthSettingsV2ActiveDirectoryV2Args", "tenantAuthEndpoint");
}
return $;
}
}
}