Set-AzFrontDoor
Update a Front Door load balancer
Syntax
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>]
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>]
Set-AzFrontDoor
-ResourceGroupName <String>
-Name <String>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
-BackendPoolsSetting <PSBackendPoolsSetting>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-InputObject <PSFrontDoor>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-InputObject <PSFrontDoor>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
[-DisableCertificateNameCheck]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-InputObject <PSFrontDoor>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
-BackendPoolsSetting <PSBackendPoolsSetting>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-ResourceId <String>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-ResourceId <String>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
[-DisableCertificateNameCheck]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzFrontDoor
-ResourceId <String>
[-RoutingRule <PSRoutingRule[]>]
[-BackendPool <PSBackendPool[]>]
[-FrontendEndpoint <PSFrontendEndpoint[]>]
[-LoadBalancingSetting <PSLoadBalancingSetting[]>]
[-HealthProbeSetting <PSHealthProbeSetting[]>]
[-Tag <Hashtable>]
[-EnabledState <PSEnabledState>]
-BackendPoolsSetting <PSBackendPoolsSetting>
[-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 FrontoorName 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.
Type: | PSBackendPool[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-BackendPoolsSetting
Settings for all backendPools.
Type: | PSBackendPoolsSetting |
Position: | Named |
Default value: | None |
Required: | True |
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 credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisableCertificateNameCheck
Whether to disable certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EnabledState
Operational status of the Front Door load balancer.
Type: | PSEnabledState |
Accepted values: | Enabled, Disabled |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-FrontendEndpoint
Frontend endpoints available to routing rule.
Type: | PSFrontendEndpoint[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HealthProbeSetting
Health probe settings associated with this Front Door instance.
Type: | PSHealthProbeSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
The Front Door object to update.
Type: | PSFrontDoor |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LoadBalancingSetting
Load balancing settings associated with this Front Door instance.
Type: | PSLoadBalancingSetting[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the Front Door to update.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group to which the Front Door belongs.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceId
Resource Id of the Front Door to update
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RoutingRule
Routing rules associated with this FrontDoor
Type: | PSRoutingRule[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Tag
The tags associate with the FrontDoor.
Type: | Hashtable |
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
Outputs
Related Links
Azure PowerShell