AFDOriginGroupProperties.yml

### YamlMime:TSType
name: AFDOriginGroupProperties
uid: '@azure/arm-cdn.AFDOriginGroupProperties'
package: '@azure/arm-cdn'
summary: The JSON object that contains the properties of the origin group.
fullName: AFDOriginGroupProperties
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
  - name: deploymentStatus
    uid: '@azure/arm-cdn.AFDOriginGroupProperties.deploymentStatus'
    package: '@azure/arm-cdn'
    summary: >-
      NOTE: This property will not be serialized. It can only be populated by
      the server.
    fullName: deploymentStatus
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'deploymentStatus?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDStateProperties.deploymentStatus](xref:@azure/arm-cdn.AFDStateProperties.deploymentStatus)
  - name: healthProbeSettings
    uid: '@azure/arm-cdn.AFDOriginGroupProperties.healthProbeSettings'
    package: '@azure/arm-cdn'
    summary: >-
      Health probe settings to the origin that is used to determine the health
      of the origin.
    fullName: healthProbeSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'healthProbeSettings?: HealthProbeParameters'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.HealthProbeParameters" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDOriginGroupUpdatePropertiesParameters.healthProbeSettings](xref:@azure/arm-cdn.AFDOriginGroupUpdatePropertiesParameters.healthProbeSettings)
  - name: loadBalancingSettings
    uid: '@azure/arm-cdn.AFDOriginGroupProperties.loadBalancingSettings'
    package: '@azure/arm-cdn'
    summary: Load balancing settings for a backend pool
    fullName: loadBalancingSettings
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'loadBalancingSettings?: LoadBalancingSettingsParameters'
      return:
        description: ''
        type: <xref uid="@azure/arm-cdn.LoadBalancingSettingsParameters" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDOriginGroupUpdatePropertiesParameters.loadBalancingSettings](xref:@azure/arm-cdn.AFDOriginGroupUpdatePropertiesParameters.loadBalancingSettings)
  - name: profileName
    uid: '@azure/arm-cdn.AFDOriginGroupProperties.profileName'
    package: '@azure/arm-cdn'
    summary: >-
      The name of the profile which holds the origin group.

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

      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
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDStateProperties.provisioningState](xref:@azure/arm-cdn.AFDStateProperties.provisioningState)
  - name: sessionAffinityState
    uid: '@azure/arm-cdn.AFDOriginGroupProperties.sessionAffinityState'
    package: '@azure/arm-cdn'
    summary: >-
      Whether to allow session affinity on this host. Valid options are
      'Enabled' or 'Disabled'
    fullName: sessionAffinityState
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sessionAffinityState?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDOriginGroupUpdatePropertiesParameters.sessionAffinityState](xref:@azure/arm-cdn.AFDOriginGroupUpdatePropertiesParameters.sessionAffinityState)
  - name: trafficRestorationTimeToHealedOrNewEndpointsInMinutes
    uid: >-
      @azure/arm-cdn.AFDOriginGroupProperties.trafficRestorationTimeToHealedOrNewEndpointsInMinutes
    package: '@azure/arm-cdn'
    summary: >-
      Time in minutes to shift the traffic to the endpoint gradually when an
      unhealthy endpoint comes healthy or a new endpoint is added. Default is 10
      mins. This property is currently not supported.
    fullName: trafficRestorationTimeToHealedOrNewEndpointsInMinutes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'trafficRestorationTimeToHealedOrNewEndpointsInMinutes?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: >-
      <b>Inherited From</b>
      [AFDOriginGroupUpdatePropertiesParameters.trafficRestorationTimeToHealedOrNewEndpointsInMinutes](xref:@azure/arm-cdn.AFDOriginGroupUpdatePropertiesParameters.trafficRestorationTimeToHealedOrNewEndpointsInMinutes)
extends: >-
  <xref uid="@azure/arm-cdn.AFDOriginGroupUpdatePropertiesParameters" />,<xref
  uid="@azure/arm-cdn.AFDStateProperties" />