Set-AzureRmTrafficManagerEndpoint
Updates a Traffic Manager endpoint.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Set-AzureRmTrafficManagerEndpoint
-TrafficManagerEndpoint <TrafficManagerEndpoint>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzureRmTrafficManagerEndpoint cmdlet updates an endpoint in Azure Traffic Manager. This cmdlet updates the settings from a local endpoint object. You can specify the endpoint object either by using the TrafficManagerEndpoint parameter or by using the pipeline.
You can obtain a local object that represents an endpoint by using the Get-AzureRmTrafficManagerEndpoint cmdlet. Modify the object locally and then use Set-AzureRmTrafficManagerEndpoint to commit your changes.
Examples
Example 1: Update an endpoint
PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\> $TrafficManagerEndpoint.Weight = 20
PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint
The first command gets an Azure Traffic Manager endpoint by using the Get-AzureRmTrafficManagerEndpoint cmdlet. The command stores the endpoint locally in the $TrafficManagerEndpoint variable.
The second command changes that endpoint locally. This command changes the endpoint weight to 20.
The third command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TrafficManagerEndpoint
Specifies a local TrafficManagerEndpoint object. This cmdlet updates Traffic Manager to match this local object.
Type: | TrafficManagerEndpoint |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
Microsoft.Azure.Commands.Network.TrafficManagerEndpoint
This cmdlet accepts a TrafficManagerEndpoint object.
Outputs
Microsoft.Azure.Commands.Network.TrafficManagerEndpoint
This cmdlet returns a TrafficManagerEndpoint object.