RouteUpdatePropertiesParameters.yml

### YamlMime:TSType
name: RouteUpdatePropertiesParameters
uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters'
package: '@azure/arm-cdn'
summary: The JSON object that contains the properties of the domain to create.
fullName: RouteUpdatePropertiesParameters
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: cacheConfiguration
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.cacheConfiguration'
    package: '@azure/arm-cdn'
    summary: >-
      The caching configuration for this route. To disable caching, do not
      provide a cacheConfiguration object.
    fullName: cacheConfiguration
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'cacheConfiguration?: AfdRouteCacheConfiguration'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.AfdRouteCacheConfiguration" />
  - name: customDomains
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.customDomains'
    package: '@azure/arm-cdn'
    summary: Domains referenced by this endpoint.
    fullName: customDomains
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customDomains?: ActivatedResourceReference[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.ActivatedResourceReference" />[]
  - name: enabledState
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.enabledState'
    package: '@azure/arm-cdn'
    summary: >-
      Whether to enable use of this rule. Permitted values are 'Enabled' or
      'Disabled'
    fullName: enabledState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enabledState?: string'
      return:
        description: ''
        type: string
  - name: endpointName
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.endpointName'
    package: '@azure/arm-cdn'
    summary: >-
      The name of the endpoint which holds the route.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: endpointName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'endpointName?: string'
      return:
        description: ''
        type: string
  - name: forwardingProtocol
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.forwardingProtocol'
    package: '@azure/arm-cdn'
    summary: Protocol this rule will use when forwarding traffic to backends.
    fullName: forwardingProtocol
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'forwardingProtocol?: string'
      return:
        description: ''
        type: string
  - name: httpsRedirect
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.httpsRedirect'
    package: '@azure/arm-cdn'
    summary: >-
      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.
    fullName: httpsRedirect
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'httpsRedirect?: string'
      return:
        description: ''
        type: string
  - name: linkToDefaultDomain
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.linkToDefaultDomain'
    package: '@azure/arm-cdn'
    summary: whether this route will be linked to the default endpoint domain.
    fullName: linkToDefaultDomain
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'linkToDefaultDomain?: string'
      return:
        description: ''
        type: string
  - name: originGroup
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.originGroup'
    package: '@azure/arm-cdn'
    summary: A reference to the origin group.
    fullName: originGroup
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'originGroup?: ResourceReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.ResourceReference" />
  - name: originPath
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.originPath'
    package: '@azure/arm-cdn'
    summary: >-
      A directory path on the origin that AzureFrontDoor can use to retrieve
      content from, e.g. contoso.cloudapp.net/originpath.
    fullName: originPath
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'originPath?: string'
      return:
        description: ''
        type: string
  - name: patternsToMatch
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.patternsToMatch'
    package: '@azure/arm-cdn'
    summary: The route patterns of the rule.
    fullName: patternsToMatch
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'patternsToMatch?: string[]'
      return:
        description: ''
        type: string[]
  - name: ruleSets
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.ruleSets'
    package: '@azure/arm-cdn'
    summary: rule sets referenced by this endpoint.
    fullName: ruleSets
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'ruleSets?: ResourceReference[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.ResourceReference" />[]
  - name: supportedProtocols
    uid: '@azure/arm-cdn.RouteUpdatePropertiesParameters.supportedProtocols'
    package: '@azure/arm-cdn'
    summary: List of supported protocols for this route.
    fullName: supportedProtocols
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'supportedProtocols?: string[]'
      return:
        description: ''
        type: string[]