Disable-AzureRmTrafficManagerEndpoint
Disables an endpoint in a Traffic Manager profile.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Disable-AzureRmTrafficManagerEndpoint
-Name <String>
-Type <String>
-ProfileName <String>
-ResourceGroupName <String>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Disable-AzureRmTrafficManagerEndpoint
-TrafficManagerEndpoint <TrafficManagerEndpoint>
[-Force]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<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.
Examples
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.
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: | 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 disables.
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 in which this cmdlet disables an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile 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 disables a Traffic Manager endpoint 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 disables. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint 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
Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline