EndpointProperties.yml

### YamlMime:TSType
name: EndpointProperties
uid: '@azure/arm-cdn.EndpointProperties'
package: '@azure/arm-cdn'
summary: The JSON object that contains the properties required to create an endpoint.
fullName: EndpointProperties
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: customDomains
    uid: '@azure/arm-cdn.EndpointProperties.customDomains'
    package: '@azure/arm-cdn'
    summary: >-
      The custom domains under the endpoint.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: customDomains
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customDomains?: DeepCreatedCustomDomain[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.DeepCreatedCustomDomain" />[]
  - name: hostName
    uid: '@azure/arm-cdn.EndpointProperties.hostName'
    package: '@azure/arm-cdn'
    summary: >-
      The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g.
      contoso.azureedge.net

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: hostName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'hostName?: string'
      return:
        description: ''
        type: string
  - name: originGroups
    uid: '@azure/arm-cdn.EndpointProperties.originGroups'
    package: '@azure/arm-cdn'
    summary: >-
      The origin groups comprising of origins that are used for load balancing
      the traffic based on availability.
    fullName: originGroups
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'originGroups?: DeepCreatedOriginGroup[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.DeepCreatedOriginGroup" />[]
  - name: origins
    uid: '@azure/arm-cdn.EndpointProperties.origins'
    package: '@azure/arm-cdn'
    summary: The source of the content being delivered via CDN.
    fullName: origins
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'origins: DeepCreatedOrigin[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.DeepCreatedOrigin" />[]
  - name: provisioningState
    uid: '@azure/arm-cdn.EndpointProperties.provisioningState'
    package: '@azure/arm-cdn'
    summary: >-
      Provisioning status of the endpoint.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: provisioningState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provisioningState?: string'
      return:
        description: ''
        type: string
  - name: resourceState
    uid: '@azure/arm-cdn.EndpointProperties.resourceState'
    package: '@azure/arm-cdn'
    summary: >-
      Resource status of the endpoint.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: resourceState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resourceState?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: contentTypesToCompress
    uid: '@azure/arm-cdn.EndpointProperties.contentTypesToCompress'
    package: '@azure/arm-cdn'
    summary: >-
      List of content types on which compression applies. The value should be a
      valid MIME type.
    fullName: contentTypesToCompress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentTypesToCompress?: string[]'
      return:
        description: ''
        type: string[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.contentTypesToCompress](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.contentTypesToCompress)
  - name: defaultOriginGroup
    uid: '@azure/arm-cdn.EndpointProperties.defaultOriginGroup'
    package: '@azure/arm-cdn'
    summary: A reference to the origin group.
    fullName: defaultOriginGroup
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'defaultOriginGroup?: ResourceReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.ResourceReference" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.defaultOriginGroup](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.defaultOriginGroup)
  - name: deliveryPolicy
    uid: '@azure/arm-cdn.EndpointProperties.deliveryPolicy'
    package: '@azure/arm-cdn'
    summary: A policy that specifies the delivery rules to be used for an endpoint.
    fullName: deliveryPolicy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'deliveryPolicy?: EndpointPropertiesUpdateParametersDeliveryPolicy'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-cdn.EndpointPropertiesUpdateParametersDeliveryPolicy"
          />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.deliveryPolicy](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.deliveryPolicy)
  - name: geoFilters
    uid: '@azure/arm-cdn.EndpointProperties.geoFilters'
    package: '@azure/arm-cdn'
    summary: >-
      List of rules defining the user's geo access within a CDN endpoint. Each
      geo filter defines an access rule to a specified path or content, e.g.
      block APAC for path /pictures/
    fullName: geoFilters
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'geoFilters?: GeoFilter[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.GeoFilter" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.geoFilters](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.geoFilters)
  - name: isCompressionEnabled
    uid: '@azure/arm-cdn.EndpointProperties.isCompressionEnabled'
    package: '@azure/arm-cdn'
    summary: >-
      Indicates whether content compression is enabled on CDN. 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 CDN
      when requested content is smaller than 1 byte or larger than 1 MB.
    fullName: isCompressionEnabled
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isCompressionEnabled?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.isCompressionEnabled](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.isCompressionEnabled)
  - name: isHttpAllowed
    uid: '@azure/arm-cdn.EndpointProperties.isHttpAllowed'
    package: '@azure/arm-cdn'
    summary: >-
      Indicates whether HTTP traffic is allowed on the endpoint. Default value
      is true. At least one protocol (HTTP or HTTPS) must be allowed.
    fullName: isHttpAllowed
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isHttpAllowed?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.isHttpAllowed](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.isHttpAllowed)
  - name: isHttpsAllowed
    uid: '@azure/arm-cdn.EndpointProperties.isHttpsAllowed'
    package: '@azure/arm-cdn'
    summary: >-
      Indicates whether HTTPS traffic is allowed on the endpoint. Default value
      is true. At least one protocol (HTTP or HTTPS) must be allowed.
    fullName: isHttpsAllowed
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isHttpsAllowed?: boolean'
      return:
        description: ''
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.isHttpsAllowed](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.isHttpsAllowed)
  - name: optimizationType
    uid: '@azure/arm-cdn.EndpointProperties.optimizationType'
    package: '@azure/arm-cdn'
    summary: >-
      Specifies what scenario the customer wants this CDN endpoint to optimize
      for, e.g. Download, Media services. With this information, CDN can apply
      scenario driven optimization.
    fullName: optimizationType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'optimizationType?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.optimizationType](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.optimizationType)
  - name: originHostHeader
    uid: '@azure/arm-cdn.EndpointProperties.originHostHeader'
    package: '@azure/arm-cdn'
    summary: >-
      The host header value sent to the origin with each request. This property
      at Endpoint is only allowed when endpoint uses single origin and can be
      overridden by the same property specified at origin.If you leave this
      blank, the request hostname determines this value. Azure CDN origins, such
      as Web Apps, Blob Storage, and Cloud Services require this host header
      value to match the origin hostname by default.
    fullName: originHostHeader
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'originHostHeader?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.originHostHeader](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.originHostHeader)
  - name: originPath
    uid: '@azure/arm-cdn.EndpointProperties.originPath'
    package: '@azure/arm-cdn'
    summary: >-
      A directory path on the origin that CDN 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
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.originPath](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.originPath)
  - name: probePath
    uid: '@azure/arm-cdn.EndpointProperties.probePath'
    package: '@azure/arm-cdn'
    summary: >-
      Path to a file hosted on the origin which helps accelerate delivery of the
      dynamic content and calculate the most optimal routes for the CDN. This is
      relative to the origin path. This property is only relevant when using a
      single origin.
    fullName: probePath
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'probePath?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.probePath](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.probePath)
  - name: queryStringCachingBehavior
    uid: '@azure/arm-cdn.EndpointProperties.queryStringCachingBehavior'
    package: '@azure/arm-cdn'
    summary: >-
      Defines how CDN 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.
    fullName: queryStringCachingBehavior
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'queryStringCachingBehavior?: QueryStringCachingBehavior'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.QueryStringCachingBehavior" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.queryStringCachingBehavior](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.queryStringCachingBehavior)
  - name: urlSigningKeys
    uid: '@azure/arm-cdn.EndpointProperties.urlSigningKeys'
    package: '@azure/arm-cdn'
    summary: List of keys used to validate the signed URL hashes.
    fullName: urlSigningKeys
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'urlSigningKeys?: UrlSigningKey[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.UrlSigningKey" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.urlSigningKeys](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.urlSigningKeys)
  - name: webApplicationFirewallPolicyLink
    uid: '@azure/arm-cdn.EndpointProperties.webApplicationFirewallPolicyLink'
    package: '@azure/arm-cdn'
    summary: >-
      Defines the Web Application Firewall policy for the endpoint (if
      applicable)
    fullName: webApplicationFirewallPolicyLink
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        webApplicationFirewallPolicyLink?:
        EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-cdn.EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLink"
          />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [EndpointPropertiesUpdateParameters.webApplicationFirewallPolicyLink](xref:@azure/arm-cdn.EndpointPropertiesUpdateParameters.webApplicationFirewallPolicyLink)
extends: <xref uid="@azure/arm-cdn.EndpointPropertiesUpdateParameters" />