New-AzFrontDoorCdnOriginGroup

Creates a new origin group within the specified profile.

Syntax

New-AzFrontDoorCdnOriginGroup
   -OriginGroupName <String>
   -ProfileName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-HealthProbeSetting <IHealthProbeParameters>]
   [-LoadBalancingSetting <ILoadBalancingSettingsParameters>]
   [-SessionAffinityState <EnabledState>]
   [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute <Int32>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

Creates a new origin group within the specified profile.

Examples

Example 1: Create an AzureFrontDoor origin group under the AzureFrontDoor profile

$healthProbeSetting = New-AzFrontDoorCdnOriginGroupHealthProbeSettingObject -ProbeIntervalInSecond 1 -ProbePath "/" -ProbeProtocol "Https" -ProbeRequestType "GET"
$loadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200  -SampleSize 5 -SuccessfulSamplesRequired 4
New-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -LoadBalancingSetting $loadBalancingSetting -HealthProbeSetting $healthProbeSetting

Name   ResourceGroupName
----   -----------------
org001 testps-rg-da16jm

Create an AzureFrontDoor origin group under the AzureFrontDoor profile

Parameters

-AsJob

Run the command as a job

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HealthProbeSetting

Health probe settings to the origin that is used to determine the health of the origin. To construct, see NOTES section for HEALTHPROBESETTING properties and create a hash table.

Type:IHealthProbeParameters
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LoadBalancingSetting

Load balancing settings for a backend pool To construct, see NOTES section for LOADBALANCINGSETTING properties and create a hash table.

Type:ILoadBalancingSettingsParameters
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoWait

Run the command asynchronously

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OriginGroupName

Name of the origin group which is unique within the endpoint.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProfileName

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Name of the Resource group within the Azure subscription.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SessionAffinityState

Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'

Type:EnabledState
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Azure Subscription ID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TrafficRestorationTimeToHealedOrNewEndpointsInMinute

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IAfdOriginGroup

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

HEALTHPROBESETTING <IHealthProbeParameters>: Health probe settings to the origin that is used to determine the health of the origin.

  • [ProbeIntervalInSecond <Int32?>]: The number of seconds between health probes.Default is 240sec.
  • [ProbePath <String>]: The path relative to the origin that is used to determine the health of the origin.
  • [ProbeProtocol <ProbeProtocol?>]: Protocol to use for health probe.
  • [ProbeRequestType <HealthProbeRequestType?>]: The type of health probe request that is made.

LOADBALANCINGSETTING <ILoadBalancingSettingsParameters>: Load balancing settings for a backend pool

  • [AdditionalLatencyInMillisecond <Int32?>]: The additional latency in milliseconds for probes to fall into the lowest latency bucket
  • [SampleSize <Int32?>]: The number of samples to consider for load balancing decisions
  • [SuccessfulSamplesRequired <Int32?>]: The number of samples within the sample period that must succeed