Enable-AzureRmTrafficManagerEndpoint
Enables 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
Enable-AzureRmTrafficManagerEndpoint
-Name <String>
-Type <String>
-ProfileName <String>
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Enable-AzureRmTrafficManagerEndpoint
-TrafficManagerEndpoint <TrafficManagerEndpoint>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Enable-AzureRmTrafficManagerEndpoint cmdlet enables 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 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: Enable an endpoint from a profile
PS C:\>Enable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints
This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11.
Example 2: Enable an endpoint by using the pipeline
PS C:\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerEndpoint
This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that endpoint to the Enable-AzureRmTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet enables that endpoint.
Parameters
-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 |
-Name
Specifies the name of the Traffic Manager endpoint that this cmdlet enables.
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 enables 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 enables 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 enables. 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 disables in 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 |
Inputs
TrafficManagerEndpoint
Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline