Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

New-AzFrontDoorCdnOriginGroup

Module:
Az.Cdn Module

Create a new origin group within the specified profile.

Syntax

CreateExpanded (Default)

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

CreateViaJsonString

New-AzFrontDoorCdnOriginGroup
 -OriginGroupName <String>
 -ProfileName <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaJsonFilePath

New-AzFrontDoorCdnOriginGroup
 -OriginGroupName <String>
 -ProfileName <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaIdentityProfileExpanded

New-AzFrontDoorCdnOriginGroup
 -OriginGroupName <String>
 -ProfileInputObject <ICdnIdentity>
 [-AuthenticationScope <String>]
 [-AuthenticationType <String>]
 [-HealthProbeSetting <IHealthProbeParameters>]
 [-LoadBalancingSetting <ILoadBalancingSettingsParameters>]
 [-SessionAffinityState <String>]
 [-TrafficRestorationTimeToHealedOrNewEndpointsInMinute <Int32>]
 [-UserAssignedIdentityId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

CreateViaIdentityProfile

New-AzFrontDoorCdnOriginGroup
 -OriginGroupName <String>
 -ProfileInputObject <ICdnIdentity>
 -OriginGroup <IAfdOriginGroup>
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Create 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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-AuthenticationScope

The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default".

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-AuthenticationType

The type of the authentication for the origin.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

-HealthProbeSetting

Health probe settings to the origin that is used to determine the health of the origin.

Parameter properties

Type:IHealthProbeParameters
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-JsonFilePath

Path of Json file supplied to the Create operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-JsonString

Json string supplied to the Create operation

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-LoadBalancingSetting

Load balancing settings for a backend pool

Parameter properties

Type:ILoadBalancingSettingsParameters
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-OriginGroup

AFDOrigin group comprising of origins is used for load balancing to origins when the content cannot be served from Azure Front Door.

Parameter properties

Type:IAfdOriginGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-OriginGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ProfileInputObject

Identity Parameter

Parameter properties

Type:ICdnIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ProfileName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SessionAffinityState

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

-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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-UserAssignedIdentityId

Resource ID.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IAfdOriginGroup

ICdnIdentity

Outputs

IAfdOriginGroup


Feedback

Was this page helpful?