Edit

Share via

Remove-AzTrafficManagerEndpoint

  • Reference
Module:
Az.TrafficManager

Removes an endpoint from Traffic Manager.

Syntax

Remove-AzTrafficManagerEndpoint
      -Name <String>
      -Type <String>
      -ProfileName <String>
      -ResourceGroupName <String>
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzTrafficManagerEndpoint
      -TrafficManagerEndpoint <TrafficManagerEndpoint>
      [-Force]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-AzTrafficManagerEndpoint cmdlet removes an endpoint from Azure Traffic Manager.

This cmdlet commits each change to the Traffic Manager service. To remove multiple endpoints from a local Traffic Manager profile object and commit changes in a single operation, use the Remove-AzTrafficManagerEndpointConfig cmdlet.

You can use the pipeline operator to pass a TrafficManagerEndpoint object to this cmdlet, or you can specify a TrafficManagerEndpoint object by using the TrafficManagerEndpoint parameter.

Alternatively, you can specify the endpoint name and type by using the Name and Type parameters, together with the ProfileName and ResourceGroupName parameters.

Examples

Example 1: Remove an endpoint from a profile

Remove-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints

This command removes the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ProfileName

Specifies the name of a Traffic Manager profile from which this cmdlet removes an endpoint. To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Specifies the name of a resource group. This cmdlet removes a Traffic Manager endpoint from a Traffic Manager profile in the group that this parameter specifies.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TrafficManagerEndpoint

Specifies the Traffic Manager endpoint that this cmdlet removes. To obtain a TrafficManagerEndpoint object, use the Get-AzTrafficManagerEndpoint cmdlet.

Type:TrafficManagerEndpoint
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Type

Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are:

  • AzureEndpoints
  • ExternalEndpoints
  • NestedEndpoints
Type:String
Accepted values:AzureEndpoints, ExternalEndpoints, NestedEndpoints
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

TrafficManagerEndpoint

Outputs

Boolean