Enable-AzTrafficManagerEndpoint
Enables an endpoint in a Traffic Manager profile.
Syntax
Fields
Enable-AzTrafficManagerEndpoint
-Name <String>
-Type <String>
-ProfileName <String>
-ResourceGroupName <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Object
Enable-AzTrafficManagerEndpoint
-TrafficManagerEndpoint <TrafficManagerEndpoint>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Enable-AzTrafficManagerEndpoint 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
Enable-AzTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints
This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResourceGroup11.
Example 2: Enable an endpoint by using the pipeline
Get-AzTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzTrafficManagerEndpoint
This command gets the external endpoint named Contoso from the profile named ContosoProfile in ResourceGroup11. The command then passes that endpoint to the Enable-AzTrafficManagerEndpoint cmdlet by using the pipeline operator. That cmdlet enables that endpoint.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of the Traffic Manager endpoint that this cmdlet enables.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Fields
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProfileName
Specifies the name of a Traffic Manager profile in which this cmdlet enables an endpoint. To obtain a profile, use the Get-AzTrafficManagerProfile cmdlet.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Fields
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResourceGroupName
Specifies the name of a resource group. This cmdlet enables a Traffic Manager endpoint in the group that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Fields
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TrafficManagerEndpoint
Specifies the Traffic Manager endpoint that this cmdlet enables. To obtain a TrafficManagerEndpoint object, use the Get-AzTrafficManagerEndpoint cmdlet.
Parameter properties
| Type: | TrafficManagerEndpoint |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Object
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Specifies the type of endpoint that this cmdlet disables in the Traffic Manager profile. Valid values are:
- AzureEndpoints
- ExternalEndpoints
- NestedEndpoints
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | AzureEndpoints, ExternalEndpoints, NestedEndpoints |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Fields
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
