AuthenticationPolicyPropertiesFormat Class

Package:

com.azure.resourcemanager.network.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.61.0

• java.lang.Object
• • com.azure.resourcemanager.network.models.AuthenticationPolicyPropertiesFormat

Implements

JsonSerializable<AuthenticationPolicyPropertiesFormat>

public final class AuthenticationPolicyPropertiesFormat
implements JsonSerializable<AuthenticationPolicyPropertiesFormat>

Properties of the authentication policy.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
List<String>	associatedResources() Get the associatedResources property: A collection of resource IDs that reference this authentication policy.
AuthenticationProviderProperties	authenticationProperties() Get the authenticationProperties property: The authentication provider configuration for the policy.
static AuthenticationPolicyPropertiesFormat	fromJson(JsonReader jsonReader) Reads an instance of AuthenticationPolicyPropertiesFormat from the JsonReader.
OnUnauthenticatedRequest	onUnauthenticatedRequest() Get the onUnauthenticatedRequest property: The action to take when a request is unauthenticated.
CommonProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the authentication policy resource.
String	resourceGuid() Get the resourceGuid property: The resource GUID property of the authentication policy resource.
JsonWriter	toJson(JsonWriter jsonWriter)
UserTrustProviderType	userTrustProviderType() Get the userTrustProviderType property: The type of the user trust provider.
void	validate() Validates the instance.
AuthenticationPolicyPropertiesFormat	withAuthenticationProperties(AuthenticationProviderProperties authenticationProperties) Set the authenticationProperties property: The authentication provider configuration for the policy.
AuthenticationPolicyPropertiesFormat	withOnUnauthenticatedRequest(OnUnauthenticatedRequest onUnauthenticatedRequest) Set the onUnauthenticatedRequest property: The action to take when a request is unauthenticated.
AuthenticationPolicyPropertiesFormat	withUserTrustProviderType(UserTrustProviderType userTrustProviderType) Set the userTrustProviderType property: The type of the user trust provider.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AuthenticationPolicyPropertiesFormat

public AuthenticationPolicyPropertiesFormat()

Creates an instance of AuthenticationPolicyPropertiesFormat class.

Method Details

associatedResources

public List<String> associatedResources()

Get the associatedResources property: A collection of resource IDs that reference this authentication policy.

Returns:

the associatedResources value.

authenticationProperties

public AuthenticationProviderProperties authenticationProperties()

Get the authenticationProperties property: The authentication provider configuration for the policy.

Returns:

the authenticationProperties value.

fromJson

public static AuthenticationPolicyPropertiesFormat fromJson(JsonReader jsonReader)

Reads an instance of AuthenticationPolicyPropertiesFormat from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

onUnauthenticatedRequest

public OnUnauthenticatedRequest onUnauthenticatedRequest()

Get the onUnauthenticatedRequest property: The action to take when a request is unauthenticated. When omitted, user sign-in policies default to `authenticate` and JWT validation policies default to `deny`.

Returns:

the onUnauthenticatedRequest value.

provisioningState

public CommonProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the authentication policy resource.

Returns:

the provisioningState value.

resourceGuid

public String resourceGuid()

Get the resourceGuid property: The resource GUID property of the authentication policy resource.

Returns:

the resourceGuid value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

userTrustProviderType

public UserTrustProviderType userTrustProviderType()

Get the userTrustProviderType property: The type of the user trust provider. Only Microsoft Entra is supported, using the serialized value `entra`.

Returns:

the userTrustProviderType value.

validate

public void validate()

Validates the instance.

withAuthenticationProperties

public AuthenticationPolicyPropertiesFormat withAuthenticationProperties(AuthenticationProviderProperties authenticationProperties)

Set the authenticationProperties property: The authentication provider configuration for the policy.

Parameters:

authenticationProperties - the authenticationProperties value to set.

Returns:

the AuthenticationPolicyPropertiesFormat object itself.

withOnUnauthenticatedRequest

public AuthenticationPolicyPropertiesFormat withOnUnauthenticatedRequest(OnUnauthenticatedRequest onUnauthenticatedRequest)

Set the onUnauthenticatedRequest property: The action to take when a request is unauthenticated. When omitted, user sign-in policies default to `authenticate` and JWT validation policies default to `deny`.

Parameters:

onUnauthenticatedRequest - the onUnauthenticatedRequest value to set.

Returns:

the AuthenticationPolicyPropertiesFormat object itself.

withUserTrustProviderType

public AuthenticationPolicyPropertiesFormat withUserTrustProviderType(UserTrustProviderType userTrustProviderType)

Set the userTrustProviderType property: The type of the user trust provider. Only Microsoft Entra is supported, using the serialized value `entra`.

Parameters:

userTrustProviderType - the userTrustProviderType value to set.

Returns:

the AuthenticationPolicyPropertiesFormat object itself.