< Back
Remove-AzureRmTrafficManagerEndpointConfig
Post
NAME Remove-AzureRmTrafficManagerEndpointConfig
SYNOPSIS
Removes an endpoint from a local Traffic Manager profile object.
SYNTAX
Remove-AzureRmTrafficManagerEndpointConfig [-DefaultProfile <IAzureContextContainer>] -EndpointName <String> -TrafficManagerProfile
<TrafficManagerProfile> [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmTrafficManagerEndpointConfig cmdlet removes an endpoint from a local Azure Traffic Manager profile object. You can get a profile
by using the Get-AzureRmTrafficManagerProfile cmdlet.
This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the
Set-AzureRmTrafficManagerProfile cmdlet. To remove an endpoint and commit changes in a single operation, use the
Remove-AzureRmTrafficManagerEndpoint cmdlet.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointName <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerProfile <TrafficManagerProfile>
Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet accepts a TrafficManagerProfile object to this cmdlet.
OUTPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet returns a modified TrafficManagerProfile object.
NOTES
Example 1: Remove an endpoint
PS C:\\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\\> Remove-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -Type AzureEndpoints -TrafficManagerProfile $TrafficManagerProfile
PS C:\\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile
in the $TrafficManagerProfile variable.
The second command removes an Azure endpoint named contoso from the profile stored in $TrafficManagerProfile. This command changes only the local
object.
The final command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ointconfig
Add-AzureRmTrafficManagerEndpointConfig
Get-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile
SYNOPSIS
Removes an endpoint from a local Traffic Manager profile object.
SYNTAX
Remove-AzureRmTrafficManagerEndpointConfig [-DefaultProfile <IAzureContextContainer>] -EndpointName <String> -TrafficManagerProfile
<TrafficManagerProfile> [<CommonParameters>]
DESCRIPTION
The Remove-AzureRmTrafficManagerEndpointConfig cmdlet removes an endpoint from a local Azure Traffic Manager profile object. You can get a profile
by using the Get-AzureRmTrafficManagerProfile cmdlet.
This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the
Set-AzureRmTrafficManagerProfile cmdlet. To remove an endpoint and commit changes in a single operation, use the
Remove-AzureRmTrafficManagerEndpoint cmdlet.
PARAMETERS
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-EndpointName <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet removes.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerProfile <TrafficManagerProfile>
Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet accepts a TrafficManagerProfile object to this cmdlet.
OUTPUTS
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet returns a modified TrafficManagerProfile object.
NOTES
Example 1: Remove an endpoint
PS C:\\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\\> Remove-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -Type AzureEndpoints -TrafficManagerProfile $TrafficManagerProfile
PS C:\\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile
The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile
in the $TrafficManagerProfile variable.
The second command removes an Azure endpoint named contoso from the profile stored in $TrafficManagerProfile. This command changes only the local
object.
The final command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ointconfig
Add-AzureRmTrafficManagerEndpointConfig
Get-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile