Edit

Share via

Set-AzFrontDoor

Module:
Az.FrontDoor Module

Update a Front Door load balancer

Syntax

ByFieldsParameterSet (Default) 

Set-AzFrontDoor
    -ResourceGroupName <String>
    -Name <String>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByFieldsWithCertificateNameCheckParameterSet 

Set-AzFrontDoor
    -ResourceGroupName <String>
    -Name <String>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DisableCertificateNameCheck]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByFieldsWithBackendPoolsSettingParameterSet 

Set-AzFrontDoor
    -ResourceGroupName <String>
    -Name <String>
    -BackendPoolsSetting <PSBackendPoolsSetting>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectParameterSet 

Set-AzFrontDoor
    -InputObject <PSFrontDoor>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectWithCertificateNameCheckParameterSet 

Set-AzFrontDoor
    -InputObject <PSFrontDoor>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DisableCertificateNameCheck]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByObjectWithBackendPoolsSettingParameterSet 

Set-AzFrontDoor
    -InputObject <PSFrontDoor>
    -BackendPoolsSetting <PSBackendPoolsSetting>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceIdParameterSet 

Set-AzFrontDoor
    -ResourceId <String>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceIdWithCertificateNameCheckParameterSet 

Set-AzFrontDoor
    -ResourceId <String>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DisableCertificateNameCheck]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByResourceIdWithBackendPoolsSettingParameterSet 

Set-AzFrontDoor
    -ResourceId <String>
    -BackendPoolsSetting <PSBackendPoolsSetting>
    [-RoutingRule <PSRoutingRule[]>]
    [-BackendPool <PSBackendPool[]>]
    [-FrontendEndpoint <PSFrontendEndpoint[]>]
    [-LoadBalancingSetting <PSLoadBalancingSetting[]>]
    [-HealthProbeSetting <PSHealthProbeSetting[]>]
    [-Tag <Hashtable>]
    [-EnabledState <PSEnabledState>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-AzFrontDoor cmdlet updates a Front Door load balancer. If input parameters are not provided, old parameters from the existing Front Door will be used.

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

FriendlyName                : frontdoor1
RoutingRules                : {routingrule1}
BackendPools                : {backendpool1}
BackendPoolsSetting         : {backendPoolsSetting1}
EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck}
HealthProbeSettings         : {healthProbeSetting1}
LoadBalancingSettings       : {loadbalancingsetting1}
FrontendEndpoints           : {frontendendpoint1}
EnabledState                : Enabled
ResourceState               : Enabled
ProvisioningState           : Succeeded
Cname                       :
Tags                        : {tag1, tag2}
Id                          : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1
Name                        : frontdoor1
Type                        : Microsoft.Network/frontdoors

update an existing FrontDoor.

Example 2: update an existing Front Door with PSFrontDoor object.

Set-AzFrontDoor -InputObject $frontDoor1 -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1

FriendlyName                : frontdoor1
RoutingRules                : {routingrule1}
BackendPools                : {backendpool1}
BackendPoolsSetting         : {backendPoolsSetting1}
EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck}
HealthProbeSettings         : {healthProbeSetting1}
LoadBalancingSettings       : {loadbalancingsetting1}
FrontendEndpoints           : {frontendendpoint1}
EnabledState                : Enabled
ResourceState               : Enabled
ProvisioningState           : Succeeded
Cname                       :
Tags                        : {tag1, tag2}
Id                          : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1
Name                        : frontdoor1
Type                        : Microsoft.Network/frontdoor1

update an existing FrontDoor.

Example 3: update an existing Front Door with ResourceId

Set-AzFrontDoor -ResourceId $resourceId -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -BackendPoolsSetting $backendPoolsSetting1

FriendlyName                : frontdoor1
RoutingRules                : {routingrule1}
BackendPools                : {backendpool1}
BackendPoolsSetting         : {backendPoolsSetting1}
EnforceCertificateNameCheck : {backendPoolsSetting1.EnforceCertificateNameCheck}
HealthProbeSettings         : {healthProbeSetting1}
LoadBalancingSettings       : {loadbalancingsetting1}
FrontendEndpoints           : {frontendendpoint1}
EnabledState                : Enabled
ResourceState               : Enabled
ProvisioningState           : Succeeded
Cname                       :
Tags                        : {tag1, tag2}
Id                          : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1
Name                        : frontdoor1
Type                        : Microsoft.Network/frontdoor1

update an existing FrontDoor.

Example 4: update BackendPoolSetting property EnforceCertificateNameCheck of an existing Front Door with -DisableCertificateNameCheck switch parameter

Front Door to be updated can be identified using FrontDoorName and ResourceGroupName, PSFrontDoor object, or ResourceId. (See above 3 examples for example) The below example uses PSFrontDoor object.

Set-AzFrontDoor -InputObject $frontDoor1 -RoutingRule $routingrule1 -BackendPool $backendpool1 -FrontendEndpoint $frontendEndpoint1 -LoadBalancingSetting $loadBalancingSetting1 -HealthProbeSetting $healthProbeSetting1 -DisableCertificateNameCheck

FriendlyName                : frontdoor1
RoutingRules                : {routingrule1}
BackendPools                : {backendpool1}
BackendPoolsSetting         : {PSBackendPoolsSetting object with EnforceCertificateNameCheck is set to Disabled}
EnforceCertificateNameCheck : Disabled
HealthProbeSettings         : {healthProbeSetting1}
LoadBalancingSettings       : {loadbalancingsetting1}
FrontendEndpoints           : {frontendendpoint1}
EnabledState                : Enabled
ResourceState               : Enabled
ProvisioningState           : Succeeded
Cname                       :
Tags                        : {tag1, tag2}
Id                          : /subscriptions/{guid}/resourcegroups/{guid}/providers/Microsoft.Network/frontdoors/frontdoor1
Name                        : frontdoor1
Type                        : Microsoft.Network/frontdoor1

update an existing FrontDoor.

Parameters

-BackendPool

Backendpools available to routing rule.

Parameter properties

Type:

PSBackendPool[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BackendPoolsSetting

Settings for all backendPools.

Parameter properties

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

Parameter sets

ByFieldsWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByResourceIdWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:IAzureContextContainer
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableCertificateNameCheck

Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.

Parameter properties

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

Parameter sets

ByFieldsWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByResourceIdWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnabledState

Operational status of the Front Door load balancer.

Parameter properties

Type:PSEnabledState
Default value:None
Accepted values:Enabled, Disabled
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FrontendEndpoint

Frontend endpoints available to routing rule.

Parameter properties

Type:

PSFrontendEndpoint[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HealthProbeSetting

Health probe settings associated with this Front Door instance.

Parameter properties

Type:

PSHealthProbeSetting[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

The Front Door object to update.

Parameter properties

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

Parameter sets

ByObjectParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByObjectWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LoadBalancingSetting

Load balancing settings associated with this Front Door instance.

Parameter properties

Type:

PSLoadBalancingSetting[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the Front Door to update.

Parameter properties

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

Parameter sets

ByFieldsParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByFieldsWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByFieldsWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

The resource group to which the Front Door belongs.

Parameter properties

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

Parameter sets

ByFieldsParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByFieldsWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByFieldsWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceId

Resource Id of the Front Door to update

Parameter properties

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

Parameter sets

ByResourceIdParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByResourceIdWithCertificateNameCheckParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False
ByResourceIdWithBackendPoolsSettingParameterSet
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-RoutingRule

Routing rules associated with this FrontDoor

Parameter properties

Type:

PSRoutingRule[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Tag

The tags associate with the FrontDoor.

Parameter properties

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

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

PSFrontDoor

String

Outputs

PSFrontDoor