Update-AzFrontDoorCdnOrigin
Updates an existing origin within an origin group.
Syntax
Update-AzFrontDoorCdnOrigin
-OriginGroupName <String>
-OriginName <String>
-ProfileName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-AzureOriginId <String>]
[-EnabledState <EnabledState>]
[-EnforceCertificateNameCheck]
[-HostName <String>]
[-HttpPort <Int32>]
[-HttpsPort <Int32>]
[-OriginHostHeader <String>]
[-Priority <Int32>]
[-PrivateLinkId <String>]
[-SharedPrivateLinkResourceGroupId <String>]
[-SharedPrivateLinkResourcePrivateLinkLocation <String>]
[-SharedPrivateLinkResourceRequestMessage <String>]
[-SharedPrivateLinkResourceStatus <SharedPrivateLinkResourceStatus>]
[-Weight <Int32>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzFrontDoorCdnOrigin
-InputObject <ICdnIdentity>
[-AzureOriginId <String>]
[-EnabledState <EnabledState>]
[-EnforceCertificateNameCheck]
[-HostName <String>]
[-HttpPort <Int32>]
[-HttpsPort <Int32>]
[-OriginHostHeader <String>]
[-Priority <Int32>]
[-PrivateLinkId <String>]
[-SharedPrivateLinkResourceGroupId <String>]
[-SharedPrivateLinkResourcePrivateLinkLocation <String>]
[-SharedPrivateLinkResourceRequestMessage <String>]
[-SharedPrivateLinkResourceStatus <SharedPrivateLinkResourceStatus>]
[-Weight <Int32>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Updates an existing origin within an origin group.
Examples
Example 1: Update an AzureFrontDoor origin group under the profile
Update-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 -Weight 999
Name ResourceGroupName
---- -----------------
ori001 testps-rg-da16jmUpdate an AzureFrontDoor origin group under the profile
Example 2: Update an AzureFrontDoor origin group under the profile via identity
Get-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 | Update-AzFrontDoorCdnOrigin -Weight 999
Name ResourceGroupName
---- -----------------
ori001 testps-rg-da16jmUpdate an AzureFrontDoor origin group under the profile via identity
Example 3: Update an AzureFrontDoor origin group under the profile, disable the EnforceCertificateNameCheck
Update-AzFrontDoorCdnOrigin -ResourceGroupName testps-rg-da16jm -ProfileName fdp-v542q6 -OriginGroupName org001 -OriginName ori001 -EnforceCertificateNameCheck:$false
Name ResourceGroupName
---- -----------------
ori001 testps-rg-da16jmUpdate an AzureFrontDoor origin group under the profile, disable the EnforceCertificateNameCheck
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 |
-AzureOriginId
Resource ID.
| Type: | String |
| 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 |
-EnabledState
Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
| Type: | EnabledState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnforceCertificateNameCheck
Whether to enable certificate name check at origin level
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostName
The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HttpPort
The value of the HTTP port. Must be between 1 and 65535.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HttpsPort
The value of the HTTPS port. Must be between 1 and 65535.
| Type: | Int32 |
| 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 |
-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 |
-OriginHostHeader
The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure Front Door origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OriginName
Name of the origin which is unique within the profile.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Priority
Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrivateLinkId
Resource ID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-SharedPrivateLinkResourceGroupId
The group id from the provider of resource the shared private link resource is for.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SharedPrivateLinkResourcePrivateLinkLocation
The location of the shared private link resource
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SharedPrivateLinkResourceRequestMessage
The request message for requesting approval of the shared private link resource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SharedPrivateLinkResourceStatus
Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout.
| Type: | SharedPrivateLinkResourceStatus |
| 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 |
-Weight
Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
| 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
Outputs
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for