Update-AzFrontDoorCdnOriginGroup

Reference

Module:: Az.Cdn

Updates an existing origin group within a profile.

Syntax

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

Update-AzFrontDoorCdnOriginGroup
      -InputObject <ICdnIdentity>
      [-HealthProbeSetting <IHealthProbeParameters>]
      [-LoadBalancingSetting <ILoadBalancingSettingsParameters>]
      [-SessionAffinityState <EnabledState>]
      [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute <Int32>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates an existing origin group within a profile.

Examples

Example 1: Update an AzureFrontDoor origin group under the profile

$updateLoadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 3
Update-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -LoadBalancingSetting $updateLoadBalancingSetting

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

Update an AzureFrontDoor origin group under the profile

Example 2: Update an AzureFrontDoor origin group under the profile via identity

$updateLoadBalancingSetting = New-AzFrontDoorCdnOriginGroupLoadBalancingSettingObject -AdditionalLatencyInMillisecond 200 -SampleSize 5 -SuccessfulSamplesRequired 3
Get-AzFrontDoorCdnOriginGroup -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 | Update-AzFrontDoorCdnOriginGroup -LoadBalancingSetting $updateLoadBalancingSetting

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

Update an AzureFrontDoor origin group under the profile via identity

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ICdnIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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 profile.

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

Inputs

ICdnIdentity

Outputs

IAfdOriginGroup