Set-AzTrafficManagerEndpoint
Updates a Traffic Manager endpoint.
Syntax
Default (Default)
Set-AzTrafficManagerEndpoint
-TrafficManagerEndpoint <TrafficManagerEndpoint>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzTrafficManagerEndpoint 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-AzTrafficManagerEndpoint cmdlet. Modify the object locally and then use Set-AzTrafficManagerEndpoint to commit your changes.
Examples
Example 1: Update an endpoint
$TrafficManagerEndpoint = Get-AzTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11"
$TrafficManagerEndpoint.Weight = 20
Set-AzTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint
The first command gets an Azure Traffic Manager endpoint by using the Get-AzTrafficManagerEndpoint 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.
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 |
-TrafficManagerEndpoint
Specifies a local TrafficManagerEndpoint object. This cmdlet updates Traffic Manager to match this local object.
Parameter properties
| Type: | TrafficManagerEndpoint |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| 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.
