Origin.yml

### YamlMime:TSType
name: Origin
uid: '@azure/arm-cdn.Origin'
package: '@azure/arm-cdn'
summary: >-
  CDN origin is the source of the content being delivered via CDN. When the edge
  nodes represented by an endpoint do not have the requested content cached,
  they attempt to fetch it from one or more of the configured origins.
fullName: Origin
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: enabled
    uid: '@azure/arm-cdn.Origin.enabled'
    package: '@azure/arm-cdn'
    summary: Origin is enabled for load balancing or not
    fullName: enabled
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'enabled?: boolean'
      return:
        description: ''
        type: boolean
  - name: hostName
    uid: '@azure/arm-cdn.Origin.hostName'
    package: '@azure/arm-cdn'
    summary: >-
      The address of the origin. Domain names, IPv4 addresses, and IPv6
      addresses are supported.This should be unique across all origins in an
      endpoint.
    fullName: hostName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'hostName?: string'
      return:
        description: ''
        type: string
  - name: httpPort
    uid: '@azure/arm-cdn.Origin.httpPort'
    package: '@azure/arm-cdn'
    summary: The value of the HTTP port. Must be between 1 and 65535.
    fullName: httpPort
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'httpPort?: number'
      return:
        description: ''
        type: number
  - name: httpsPort
    uid: '@azure/arm-cdn.Origin.httpsPort'
    package: '@azure/arm-cdn'
    summary: The value of the HTTPS port. Must be between 1 and 65535.
    fullName: httpsPort
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'httpsPort?: number'
      return:
        description: ''
        type: number
  - name: originHostHeader
    uid: '@azure/arm-cdn.Origin.originHostHeader'
    package: '@azure/arm-cdn'
    summary: >-
      The host header value sent to the origin with each request. 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. This overrides the
      host header defined at Endpoint
    fullName: originHostHeader
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'originHostHeader?: string'
      return:
        description: ''
        type: string
  - name: priority
    uid: '@azure/arm-cdn.Origin.priority'
    package: '@azure/arm-cdn'
    summary: >-
      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
    fullName: priority
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'priority?: number'
      return:
        description: ''
        type: number
  - name: privateEndpointStatus
    uid: '@azure/arm-cdn.Origin.privateEndpointStatus'
    package: '@azure/arm-cdn'
    summary: >-
      The approval status for the connection to the Private Link

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: privateEndpointStatus
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateEndpointStatus?: string'
      return:
        description: ''
        type: string
  - name: privateLinkAlias
    uid: '@azure/arm-cdn.Origin.privateLinkAlias'
    package: '@azure/arm-cdn'
    summary: >-
      The Alias of the Private Link resource. Populating this optional field
      indicates that this origin is 'Private'
    fullName: privateLinkAlias
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateLinkAlias?: string'
      return:
        description: ''
        type: string
  - name: privateLinkApprovalMessage
    uid: '@azure/arm-cdn.Origin.privateLinkApprovalMessage'
    package: '@azure/arm-cdn'
    summary: >-
      A custom message to be included in the approval request to connect to the
      Private Link.
    fullName: privateLinkApprovalMessage
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateLinkApprovalMessage?: string'
      return:
        description: ''
        type: string
  - name: privateLinkLocation
    uid: '@azure/arm-cdn.Origin.privateLinkLocation'
    package: '@azure/arm-cdn'
    summary: >-
      The location of the Private Link resource. Required only if
      'privateLinkResourceId' is populated
    fullName: privateLinkLocation
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateLinkLocation?: string'
      return:
        description: ''
        type: string
  - name: privateLinkResourceId
    uid: '@azure/arm-cdn.Origin.privateLinkResourceId'
    package: '@azure/arm-cdn'
    summary: >-
      The Resource Id of the Private Link resource. Populating this optional
      field indicates that this backend is 'Private'
    fullName: privateLinkResourceId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'privateLinkResourceId?: string'
      return:
        description: ''
        type: string
  - name: provisioningState
    uid: '@azure/arm-cdn.Origin.provisioningState'
    package: '@azure/arm-cdn'
    summary: >-
      Provisioning status of the origin.

      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.Origin.resourceState'
    package: '@azure/arm-cdn'
    summary: >-
      Resource status of the origin.

      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
  - name: weight
    uid: '@azure/arm-cdn.Origin.weight'
    package: '@azure/arm-cdn'
    summary: >-
      Weight of the origin in given origin group for load balancing. Must be
      between 1 and 1000
    fullName: weight
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'weight?: number'
      return:
        description: ''
        type: number
inheritedProperties:
  - name: id
    uid: '@azure/arm-cdn.Origin.id'
    package: '@azure/arm-cdn'
    summary: >-
      Resource ID.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ProxyResource.id](xref:@azure/arm-cdn.ProxyResource.id)
  - name: name
    uid: '@azure/arm-cdn.Origin.name'
    package: '@azure/arm-cdn'
    summary: >-
      Resource name.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ProxyResource.name](xref:@azure/arm-cdn.ProxyResource.name)
  - name: systemData
    uid: '@azure/arm-cdn.Origin.systemData'
    package: '@azure/arm-cdn'
    summary: >-
      Read only system data

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: systemData
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'systemData?: SystemData'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.SystemData" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ProxyResource.systemData](xref:@azure/arm-cdn.ProxyResource.systemData)
  - name: type
    uid: '@azure/arm-cdn.Origin.type'
    package: '@azure/arm-cdn'
    summary: >-
      Resource type.

      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ProxyResource.type](xref:@azure/arm-cdn.ProxyResource.type)
extends: <xref uid="@azure/arm-cdn.ProxyResource" />