RouteProperties Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201

Assembly:

Az.Cdn.private.dll

The JSON object that contains the properties of the Routes to create.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.RoutePropertiesTypeConverter))]
public class RouteProperties : Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IRouteProperties, Microsoft.Azure.PowerShell.Cmdlets.Cdn.Runtime.IValidates

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.RoutePropertiesTypeConverter))>]
type RouteProperties = class
    interface IRouteProperties
    interface IJsonSerializable
    interface IRouteUpdatePropertiesParameters
    interface IAfdStateProperties
    interface IValidates

Public Class RouteProperties
Implements IRouteProperties, IValidates

Inheritance

Object

RouteProperties

Attributes

TypeConverterAttribute

Implements

IAfdStateProperties IRouteProperties IRouteUpdatePropertiesParameters IJsonSerializable IValidates

Constructors

RouteProperties()

Creates an new RouteProperties instance.

Properties

CacheConfiguration	The caching configuration for this route. To disable caching, do not provide a cacheConfiguration object.
CacheConfigurationCompressionSetting	compression settings.
CacheConfigurationQueryParameter	query parameters to include or exclude (comma separated).
CacheConfigurationQueryStringCachingBehavior	Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings.
CompressionSettingContentTypesToCompress	List of content types on which compression applies. The value should be a valid MIME type.
CompressionSettingIsCompressionEnabled	Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.
CustomDomain	Domains referenced by this endpoint.
DeploymentStatus
EnabledState	Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
EndpointName	The name of the endpoint which holds the route.
ForwardingProtocol	Protocol this rule will use when forwarding traffic to backends.
HttpsRedirect	Whether to automatically redirect HTTP traffic to HTTPS traffic. Note that this is a easy way to set up this rule and it will be the first rule that gets executed.
LinkToDefaultDomain	whether this route will be linked to the default endpoint domain.
OriginGroup	A reference to the origin group.
OriginGroupId	Resource ID.
OriginPath	A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
PatternsToMatch	The route patterns of the rule.
ProvisioningState	Provisioning status
RuleSet	rule sets referenced by this endpoint.
SupportedProtocol	List of supported protocols for this route.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of RouteProperties.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of RouteProperties.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Cdn.Models.Api20240201.IRouteProperties.
FromJsonString(String)	Creates a new instance of RouteProperties, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of RouteProperties into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
ToString()
Validate(IEventListener)	Validates that this object meets the validation criteria.