AfdOriginProperties Class

public final class AfdOriginProperties
extends AfdOriginUpdatePropertiesParameters

The JSON object that contains the properties of the origin.

Constructor Summary

Constructor Description
AfdOriginProperties()

Creates an instance of AfdOriginProperties class.

Method Summary

Modifier and Type Method and Description
DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

static AfdOriginProperties fromJson(JsonReader jsonReader)

Reads an instance of AfdOriginProperties from the JsonReader.

String originGroupName()

Get the originGroupName property: The name of the origin group which contains this origin.

AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

AfdOriginProperties withAzureOrigin(ResourceReference azureOrigin)

Set the azureOrigin property: Resource reference to the Azure origin resource.

AfdOriginProperties withEnabledState(EnabledState enabledState)

Set the enabledState property: Whether to enable health probes to be made against backends defined under backendPools.

AfdOriginProperties withEnforceCertificateNameCheck(Boolean enforceCertificateNameCheck)

Set the enforceCertificateNameCheck property: Whether to enable certificate name check at origin level.

AfdOriginProperties withHostname(String hostname)

Set the hostname property: The address of the origin.

AfdOriginProperties withHttpPort(Integer httpPort)

Set the httpPort property: The value of the HTTP port.

AfdOriginProperties withHttpsPort(Integer httpsPort)

Set the httpsPort property: The value of the HTTPS port.

AfdOriginProperties withOriginHostHeader(String originHostHeader)

Set the originHostHeader property: The host header value sent to the origin with each request.

AfdOriginProperties withPriority(Integer priority)

Set the priority property: Priority of origin in given origin group for load balancing.

AfdOriginProperties withSharedPrivateLinkResource(SharedPrivateLinkResourceProperties sharedPrivateLinkResource)

Set the sharedPrivateLinkResource property: The properties of the private link resource for private origin.

AfdOriginProperties withWeight(Integer weight)

Set the weight property: Weight of the origin in given origin group for load balancing.

Methods inherited from AfdOriginUpdatePropertiesParameters

Methods inherited from java.lang.Object

Constructor Details

AfdOriginProperties

public AfdOriginProperties()

Creates an instance of AfdOriginProperties class.

Method Details

deploymentStatus

public DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

Returns:

the deploymentStatus value.

fromJson

public static AfdOriginProperties fromJson(JsonReader jsonReader)

Reads an instance of AfdOriginProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AfdOriginProperties 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 AfdOriginProperties.

originGroupName

public String originGroupName()

Get the originGroupName property: The name of the origin group which contains this origin.

Overrides:

AfdOriginProperties.originGroupName()

Returns:

the originGroupName value.

provisioningState

public AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AfdOriginProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

AfdOriginProperties.validate()

withAzureOrigin

public AfdOriginProperties withAzureOrigin(ResourceReference azureOrigin)

Set the azureOrigin property: Resource reference to the Azure origin resource.

Overrides:

AfdOriginProperties.withAzureOrigin(ResourceReference azureOrigin)

Parameters:

azureOrigin

withEnabledState

public AfdOriginProperties withEnabledState(EnabledState enabledState)

Set the enabledState property: Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.

Overrides:

AfdOriginProperties.withEnabledState(EnabledState enabledState)

Parameters:

enabledState

withEnforceCertificateNameCheck

public AfdOriginProperties withEnforceCertificateNameCheck(Boolean enforceCertificateNameCheck)

Set the enforceCertificateNameCheck property: Whether to enable certificate name check at origin level.

Overrides:

AfdOriginProperties.withEnforceCertificateNameCheck(Boolean enforceCertificateNameCheck)

Parameters:

enforceCertificateNameCheck

withHostname

public AfdOriginProperties withHostname(String hostname)

Set the hostname property: The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.

Overrides:

AfdOriginProperties.withHostname(String hostname)

Parameters:

hostname

withHttpPort

public AfdOriginProperties withHttpPort(Integer httpPort)

Set the httpPort property: The value of the HTTP port. Must be between 1 and 65535.

Overrides:

AfdOriginProperties.withHttpPort(Integer httpPort)

Parameters:

httpPort

withHttpsPort

public AfdOriginProperties withHttpsPort(Integer httpsPort)

Set the httpsPort property: The value of the HTTPS port. Must be between 1 and 65535.

Overrides:

AfdOriginProperties.withHttpsPort(Integer httpsPort)

Parameters:

httpsPort

withOriginHostHeader

public AfdOriginProperties withOriginHostHeader(String originHostHeader)

Set the originHostHeader property: The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint.

Overrides:

AfdOriginProperties.withOriginHostHeader(String originHostHeader)

Parameters:

originHostHeader

withPriority

public AfdOriginProperties withPriority(Integer priority)

Set the priority property: Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5.

Overrides:

AfdOriginProperties.withPriority(Integer priority)

Parameters:

priority

withSharedPrivateLinkResource

public AfdOriginProperties withSharedPrivateLinkResource(SharedPrivateLinkResourceProperties sharedPrivateLinkResource)

Set the sharedPrivateLinkResource property: The properties of the private link resource for private origin.

Overrides:

AfdOriginProperties.withSharedPrivateLinkResource(SharedPrivateLinkResourceProperties sharedPrivateLinkResource)

Parameters:

sharedPrivateLinkResource

withWeight

public AfdOriginProperties withWeight(Integer weight)

Set the weight property: Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.

Overrides:

AfdOriginProperties.withWeight(Integer weight)

Parameters:

weight

Applies to