< Back
Disable-AzureRmTrafficManagerEndpoint
Post
NAME Disable-AzureRmTrafficManagerEndpoint
SYNOPSIS
Disables an endpoint in a Traffic Manager profile.
SYNTAX
Disable-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> -ProfileName <String> -ResourceGroupName
<String> -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints} [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-Force] -TrafficManagerEndpoint <TrafficManagerEndpoint>
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-AzureRmTrafficManagerEndpoint cmdlet disables an endpoint in an Azure Traffic Manager profile.
You can use the pipeline operator to pass a TrafficManagerEndpoint object to this cmdlet, or you can pass a TrafficManagerEndpoint object 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.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet disables.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProfileName <String>
Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. To obtain a profile, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerEndpoint <TrafficManagerEndpoint>
Specifies the Traffic Manager endpoint that this cmdlet disables. To obtain a TrafficManagerEndpoint object, use the
Get-AzureRmTrafficManagerEndpoint cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are:
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
TrafficManagerEndpoint
Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Disable an endpoint by name
PS C:\\> Disable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type
ExternalEndpoints
This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The command
prompts you for confirmation.
Example 2: Disable an endpoint by using the pipeline
PS C:\\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" | Disable-AzureRmTrafficManagerEndpoint -Force
This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that
endpoint to the Disable-AzureRmTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet disables that endpoint. The command
specifies the Force parameter. Therefore, it does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... erendpoint
Enable-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerEndpoint
New-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile
SYNOPSIS
Disables an endpoint in a Traffic Manager profile.
SYNTAX
Disable-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-Force] -Name <String> -ProfileName <String> -ResourceGroupName
<String> -Type {AzureEndpoints | ExternalEndpoints | NestedEndpoints} [-Confirm] [-WhatIf] [<CommonParameters>]
Disable-AzureRmTrafficManagerEndpoint [-DefaultProfile <IAzureContextContainer>] [-Force] -TrafficManagerEndpoint <TrafficManagerEndpoint>
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Disable-AzureRmTrafficManagerEndpoint cmdlet disables an endpoint in an Azure Traffic Manager profile.
You can use the pipeline operator to pass a TrafficManagerEndpoint object to this cmdlet, or you can pass a TrafficManagerEndpoint object 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.
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
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the Traffic Manager endpoint that this cmdlet disables.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProfileName <String>
Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. To obtain a profile, use the
Get-AzureRmTrafficManagerProfile cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-TrafficManagerEndpoint <TrafficManagerEndpoint>
Specifies the Traffic Manager endpoint that this cmdlet disables. To obtain a TrafficManagerEndpoint object, use the
Get-AzureRmTrafficManagerEndpoint cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Type <String>
Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are:
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
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
TrafficManagerEndpoint
Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline
OUTPUTS
System.Boolean
NOTES
Example 1: Disable an endpoint by name
PS C:\\> Disable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type
ExternalEndpoints
This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The command
prompts you for confirmation.
Example 2: Disable an endpoint by using the pipeline
PS C:\\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName
"ResourceGroup11" | Disable-AzureRmTrafficManagerEndpoint -Force
This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that
endpoint to the Disable-AzureRmTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet disables that endpoint. The command
specifies the Force parameter. Therefore, it does not prompt you for confirmation.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... erendpoint
Enable-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerEndpoint
Get-AzureRmTrafficManagerProfile
New-AzureRmTrafficManagerEndpoint
New-AzureRmTrafficManagerProfile
Remove-AzureRmTrafficManagerEndpointConfig
Set-AzureRmTrafficManagerProfile