class Azure::CDN::Mgmt::V2020_09_01::Models::Route

Friendly Routes name mapping to the any Routes or secret related information.

Attributes

compression_settings[RW]

@return compression settings.

custom_domains[RW]

@return [Array<ResourceReference>] Domains referenced by this endpoint.

deployment_status[RW]

@return [DeploymentStatus] Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Failed'

enabled_state[RW]

@return [EnabledState] Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'. Possible values include: 'Enabled', 'Disabled'

forwarding_protocol[RW]

@return [ForwardingProtocol] Protocol this rule will use when forwarding traffic to backends. Possible values include: 'HttpOnly', 'HttpsOnly', 'MatchRequest'

https_redirect[RW]

@return [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. Possible values include: 'Enabled', 'Disabled'

optimization_type[RW]

@return [OptimizationType] Specifies what scenario the customer wants this AzureFrontDoor endpoint to optimize for, e.g. Download, Media services. With this information, AzureFrontDoor can apply scenario driven optimization. Possible values include: 'GeneralWebDelivery', 'GeneralMediaStreaming', 'VideoOnDemandMediaStreaming', 'LargeFileDownload', 'DynamicSiteAcceleration'

origin_group[RW]

@return [ResourceReference] A reference to the origin group.

origin_path[RW]

@return [String] A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

patterns_to_match[RW]

@return [Array<String>] The route patterns of the rule.

provisioning_state[RW]

@return [AfdProvisioningState] Provisioning status. Possible values include: 'Succeeded', 'Failed', 'Updating', 'Deleting', 'Creating'

query_string_caching_behavior[RW]

@return [QueryStringCachingBehavior] Defines how AzureFrontDoor caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL. Possible values include: 'IgnoreQueryString', 'BypassCaching', 'UseQueryString', 'NotSet'

rule_sets[RW]

@return [Array<ResourceReference>] rule sets referenced by this endpoint.

supported_protocols[RW]

@return [Array<AFDEndpointProtocols>] List of supported protocols for this route.

Private Class Methods

mapper() click to toggle source

Mapper for Route class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2020-09-01/generated/azure_mgmt_cdn/models/route.rb, line 89
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Route',
    type: {
      name: 'Composite',
      class_name: 'Route',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        system_data: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'systemData',
          type: {
            name: 'Composite',
            class_name: 'SystemData'
          }
        },
        custom_domains: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.customDomains',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ResourceReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ResourceReference'
                }
            }
          }
        },
        origin_group: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.originGroup',
          type: {
            name: 'Composite',
            class_name: 'ResourceReference'
          }
        },
        origin_path: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.originPath',
          type: {
            name: 'String'
          }
        },
        rule_sets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.ruleSets',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ResourceReferenceElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ResourceReference'
                }
            }
          }
        },
        supported_protocols: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.supportedProtocols',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AFDEndpointProtocolsElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        patterns_to_match: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.patternsToMatch',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        compression_settings: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.compressionSettings',
          type: {
            name: 'Object'
          }
        },
        query_string_caching_behavior: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.queryStringCachingBehavior',
          type: {
            name: 'Enum',
            module: 'QueryStringCachingBehavior'
          }
        },
        optimization_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.optimizationType',
          type: {
            name: 'String'
          }
        },
        forwarding_protocol: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.forwardingProtocol',
          type: {
            name: 'String'
          }
        },
        link_to_default_domain: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.linkToDefaultDomain',
          type: {
            name: 'String'
          }
        },
        https_redirect: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.httpsRedirect',
          type: {
            name: 'String'
          }
        },
        enabled_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.enabledState',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        deployment_status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.deploymentStatus',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end