Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-AzureTrafficManagerEndpointConfig

Remove-AzureTrafficManagerEndpointConfig

microsoft.azure.commands.trafficmanager.dll

Synopsis

Removes an endpoint from an Azure Traffic Manager profile.

Syntax

Remove-AzureTrafficManagerEndpointConfig [-Profile] [-EndpointName] [-TrafficManagerProfile] [<CommonParameters>]

Detailed Description

The Remove-AzureTrafficManagerEndpointConfig cmdlet removes an endpoint from a local Azure Traffic Manager profile object. You can get a profile by using the New-AzureTrafficManagerProfile or Get-AzureTrafficManagerProfile cmdlets.

This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the Set-AzureTrafficManagerProfile cmdlet.

Parameters

-EndpointName <String>

Specifies the name of the Traffic Manager endpoint that this cmdlet removes.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Specifies an Azure profile.

Aliases

none

Required?

false

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.

Aliases

none

Required?

true

Position

named

Default value

none

Accept pipeline input?

true(ByValue)

Accept wildcard characters?

false

Input Type

Microsoft.Azure.Commands.Network.TrafficManagerProfile

Return Type

Microsoft.Azure.Commands.Network.TrafficManagerProfile

Notes

None

Examples

Example 1: Remove a profile

The first command gets an Azure Traffic Manager profile by using the Get-AzureTrafficManagerProfile cmdlet. The command stores the local profile in the $TrafficManagerProfile variable.

The second command removes an 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.

PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
PS C:\> Remove-AzureTrafficManagerEndpointConfig -EndpointName "contoso" -TrafficManagerProfile $TrafficManagerProfile 
PS C:\> Set-AzureTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile 

Example 2: Remove a profile by using the pipeline

This command gets a profile, and then passes the local profile to Remove-AzureTrafficManagerEndpointConfig by using the pipeline operator. That cmdlet removes an endpoint named contoso from that profile, and then passes the result to Set-AzureTrafficManagerProfile. The final cmdlet updates the Traffic Manager profile to match the local value.

PS C:\>Get-AzureTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzureTrafficManagerEndpointConfig -EndpointName "contoso" | Set-AzureTrafficManagerProfile

Add-AzureTrafficManagerEndpointConfig
Get-AzureTrafficManagerProfile
Set-AzureTrafficManagerProfile