Note

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

Access to this page requires authorization. You can try .

Set-AzFrontDoor

Update a new Front Door with a Front Door name under the specified subscription and resource group.

Syntax

UpdateExpanded (Default)

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-BackendPool <IBackendPool[]>]
 [-BackendPoolsSetting <IBackendPoolsSettings>]
 [-EnabledState <String>]
 [-FriendlyName <String>]
 [-FrontendEndpoint <IFrontendEndpoint[]>]
 [-HealthProbeSetting <IHealthProbeSettingsModel[]>]
 [-LoadBalancingSetting <ILoadBalancingSettingsModel[]>]
 [-RoutingRule <IRoutingRule[]>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

ByResourceIdParameterSet

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-BackendPool <IBackendPool[]>]
 [-EnabledState <String>]
 [-FrontendEndpoint <IFrontendEndpoint[]>]
 [-HealthProbeSetting <IHealthProbeSettingsModel[]>]
 [-LoadBalancingSetting <ILoadBalancingSettingsModel[]>]
 [-RoutingRule <IRoutingRule[]>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

ByResourceIdWithCertificateNameCheckParameterSet

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-BackendPool <IBackendPool[]>]
 [-EnabledState <String>]
 [-FrontendEndpoint <IFrontendEndpoint[]>]
 [-HealthProbeSetting <IHealthProbeSettingsModel[]>]
 [-LoadBalancingSetting <ILoadBalancingSettingsModel[]>]
 [-RoutingRule <IRoutingRule[]>]
 [-Tag <Hashtable>]
 [-DisableCertificateNameCheck]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

ByResourceIdWithBackendPoolsSettingParameterSet

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 [-SubscriptionId <String>]
 [-BackendPool <IBackendPool[]>]
 [-BackendPoolsSetting <IBackendPoolsSettings>]
 [-EnabledState <String>]
 [-FrontendEndpoint <IFrontendEndpoint[]>]
 [-HealthProbeSetting <IHealthProbeSettingsModel[]>]
 [-LoadBalancingSetting <ILoadBalancingSettingsModel[]>]
 [-RoutingRule <IRoutingRule[]>]
 [-Tag <Hashtable>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaJsonFilePath

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 -JsonFilePath <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

UpdateViaJsonString

Set-AzFrontDoor
 -Name <String>
 -ResourceGroupName <String>
 -JsonString <String>
 [-SubscriptionId <String>]
 [-DefaultProfile <PSObject>]
 [-AsJob]
 [-NoWait]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

Description

Update a new Front Door with a Front Door name under the specified subscription and resource group.

Examples

Example 1: update an existing Front Door with FrontDoorName and ResourceGroupName.

Set-AzFrontDoor -Name "frontDoor1" -ResourceGroupName "resourceGroup1" -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1
BackendPool : {backendpool1}
BackendPoolsSetting : {backendPoolsSetting1}
Cname :
EnabledState : Disabled
ExtendedProperty : {
 "MigratedTo": {link0}
 }
FriendlyName : frontDoor1
FrontdoorId : {guid0}
FrontendEndpoint : {frontendEndpoint1}
HealthProbeSetting : {HealthProbeSetting1}
Id : /subscriptions/{guid}/resourcegroups/rg1/providers/M
 icrosoft.Network/frontdoors/frontdoor1
LoadBalancingSetting : {LoadBalancingSetting1}
Location : Global
Name : frontDoor1
ProvisioningState : Succeeded
ResourceGroupName : {rg1}
ResourceState : Migrated
RoutingRule : {RoutingRule1}
RulesEngine : {RulesEngine0,RulesEngine1}
Tag : {
 }
Type : Microsoft.Network/frontdoors

update an existing FrontDoor.

Parameters

-AsJob

Run the command as a job

Parameter properties

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

Parameter sets

-BackendPool

Backend pools available to routing rules.

Parameter properties

Type:

IBackendPool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-BackendPoolsSetting

Settings for all backendPools

Parameter properties

Type:IBackendPoolsSettings
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

-DisableCertificateNameCheck

Update a new Front Door with a Front Door name under the specified subscription and resource group.

Parameter properties

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

Parameter sets

-EnabledState

Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'

Parameter properties

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

Parameter sets

-FriendlyName

A friendly name for the frontDoor

Parameter properties

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

Parameter sets

-FrontendEndpoint

Frontend endpoints available to routing rules.

Parameter properties

Type:

IFrontendEndpoint[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-HealthProbeSetting

Health probe settings associated with this Front Door instance.

Parameter properties

Type:

IHealthProbeSettingsModel[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-JsonFilePath

Path of Json file supplied to the Update operation

Parameter properties

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

Parameter sets

-JsonString

Json string supplied to the Update operation

Parameter properties

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

Parameter sets

-LoadBalancingSetting

Load balancing settings associated with this Front Door instance.

Parameter properties

Type:

ILoadBalancingSettingsModel[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-Name

Name of the Front Door which is globally unique.

Parameter properties

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

Parameter sets

-NoWait

Run the command asynchronously

Parameter properties

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

Parameter sets

-ResourceGroupName

Name of the Resource group within the Azure subscription.

Parameter properties

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

Parameter sets

-RoutingRule

Routing rules associated with this Front Door.

Parameter properties

Type:

IRoutingRule[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

-SubscriptionId

The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Parameter properties

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

Parameter sets

-Tag

Resource tags.

Parameter properties

Type:Hashtable
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.

Outputs

IFrontDoor


Feedback

Was this page helpful?