Set-AzTrafficManagerProfile
Updates a Traffic Manager profile.
Syntax
Set-AzTrafficManagerProfile
-TrafficManagerProfile <TrafficManagerProfile>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Set-AzTrafficManagerProfile cmdlet updates an Azure Traffic Manager profile. This cmdlet updates the settings of the profile from a local profile object. You can specify the profile object either by using the TrafficManagerProfile parameter or by using the pipeline.
You can obtain a local object that represents a profile by using the Get-AzTrafficManagerProfile cmdlet. Modify the object locally and then use Set-AzTrafficManagerProfile to commit your changes.
Examples
Example 1: Update a profile
$TrafficManagerProfile = Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
$TrafficManagerProfile.ProfileStatus = "Disabled"
Set-AzTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
The first command gets an Azure Traffic Manager profile by using the Get-AzTrafficManagerProfile cmdlet. The command stores the profile locally in the $TrafficManagerProfile variable.
The second command changes that profile locally. This command disables the profile.
The third command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile.
Parameters
-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 |
-TrafficManagerProfile
Specifies a local TrafficManagerProfile object. This cmdlet updates Traffic Manager to match this local object.
Type: | TrafficManagerProfile |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |