Microsoft.Azure.Commands.TrafficManager.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureRmTrafficManagerEndpointConfig</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmTrafficManagerEndpointConfig</command:noun> <maml:description> <maml:para>Adds an endpoint to a local Traffic Manager profile object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Add-AzureRmTrafficManagerEndpointConfig cmdlet adds an endpoint to a local Azure Traffic Manager profile object. You can get a profile by using the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.</maml:para> <maml:para>This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. To create an endpoint and commit the change in a single operation, use the New-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureRmTrafficManagerEndpointConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointLocation</maml:name> <maml:Description> <maml:para>Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the ExternalEndpoints or the NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.</maml:para> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet adds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the endpoint. Valid values are: </maml:para> <maml:para>- Enabled </maml:para> <maml:para>- Disabled</maml:para> <maml:para></maml:para> <maml:para>If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoMapping</maml:name> <maml:Description> <maml:para>The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values (https://docs.microsoft.com/en-us/azure/traffic-manager/traffic-manager-geographic-regions).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinChildEndpoints</maml:name> <maml:Description> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.</maml:para> <maml:para>If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetResourceId</maml:name> <maml:Description> <maml:para>Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the ExternalEndpoints endpoint type, specify the Target parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one (1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointLocation</maml:name> <maml:Description> <maml:para>Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the ExternalEndpoints or the NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.</maml:para> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet adds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the endpoint. Valid values are: </maml:para> <maml:para>- Enabled </maml:para> <maml:para>- Disabled</maml:para> <maml:para></maml:para> <maml:para>If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoMapping</maml:name> <maml:Description> <maml:para>The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values (https://docs.microsoft.com/en-us/azure/traffic-manager/traffic-manager-geographic-regions).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinChildEndpoints</maml:name> <maml:Description> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.</maml:para> <maml:para>If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetResourceId</maml:name> <maml:Description> <maml:para>Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the ExternalEndpoints endpoint type, specify the Target parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Azure Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one (1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a modified TrafficManagerProfile object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Add an endpoint to a profile</maml:title> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" PS C:\> Add-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -EndpointStatus Enabled -Target "www.contoso.com" -TrafficManagerProfile $TrafficManagerProfile -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Weight 10 PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile in the $TrafficManagerProfile variable.</maml:para> <maml:para>The second command adds an endpoint named contoso to the profile stored in $TrafficManagerProfile. The command includes configuration data for the endpoint. This command changes only the local object.</maml:para> <maml:para>The final command updates the Traffic Manager profile in Azure to match the local value in $TrafficManagerProfile.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/add-azurermtrafficmanagerendpointconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AzureRmTrafficManagerEndpoint</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Disables an endpoint in a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AzureRmTrafficManagerEndpoint cmdlet disables an endpoint in an Azure Traffic Manager profile.</maml:para> <maml:para>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.</maml:para> <maml:para>Alternatively, you can specify the endpoint name and type by using the Name and Type parameters, together with the ProfileName and ResourceGroupName parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet disables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet disables. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet disables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile in which this cmdlet disables an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet disables a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet disables. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Disable an endpoint by name</maml:title> <dev:code>PS C:\> Disable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints</dev:code> <dev:remarks> <maml:para>This command disables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The command prompts you for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Disable an endpoint by using the pipeline</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzureRmTrafficManagerEndpoint -Force</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/disable-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-AzureRmTrafficManagerProfile</command:name> <command:verb>Disable</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Disables a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disable-AzureRmTrafficManagerProfile cmdlet disables an Azure Traffic Manager profile. You can specify the profile object by using the pipeline or as a parameter value. Alternatively, you can specify the profile by using the Name and ResourceGroupName parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet disables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet disables a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Disable-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to disable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet disables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet disables a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to disable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Disable a profile specified by name</maml:title> <dev:code>PS C:\>Disable-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"</dev:code> <dev:remarks> <maml:para>This command disables the profile named ContosoProfile in ResourceGroup11. The command prompts you for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Disable a profile by using the pipeline</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Disable-AzureRmTrafficManagerProfile -Force</dev:code> <dev:remarks> <maml:para>This command gets the profile named ContosoProfile in ResourceGroup11. The command then passes that profile to the Disable-AzureRmTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet disables that profile. The command specifies the Force parameter. Therefore, it does not prompt you for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/disable-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AzureRmTrafficManagerEndpoint</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Enables an endpoint in a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AzureRmTrafficManagerEndpoint cmdlet enables an endpoint in an Azure Traffic Manager profile.</maml:para> <maml:para>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.</maml:para> <maml:para>Alternatively, you can specify the endpoint name and type by using the Name and Type parameters, together with the ProfileName and ResourceGroupName parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet enables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile in which this cmdlet enables an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet enables a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet disables in the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet enables. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet enables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile in which this cmdlet enables an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet enables a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet enables. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet disables in the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Enable an endpoint from a profile</maml:title> <dev:code>PS C:\>Enable-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName ResourceGroup11 -Type ExternalEndpoints</dev:code> <dev:remarks> <maml:para>This command enables the external endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Enable an endpoint by using the pipeline</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerEndpoint -Name "contoso" -Type ExternalEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerEndpoint</dev:code> <dev:remarks> <maml:para>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.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/enable-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-AzureRmTrafficManagerProfile</command:name> <command:verb>Enable</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Enables a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Enable-AzureRmTrafficManagerProfile cmdlet enables an Azure Traffic Manager profile. You can specify the profile object by using the pipeline or as a parameter value. Alternatively, you can specify the profile by using the Name and ResourceGroupName parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet enables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet enables a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Enable-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to enable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet enables.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet enables a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to enable. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Enable a profile specified by name</maml:title> <dev:code>PS C:\>Enable-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"</dev:code> <dev:remarks> <maml:para>This command enables the profile named ContosoProfile in ResourceGroup11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Enable a profile by using the pipeline</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Enable-AzureRmTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This command gets the profile named ContosoProfile in ResourceGroup11. The command then passes that profile to the Enable-AzureRmTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet enables that profile.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/enable-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmTrafficManagerEndpoint</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Gets an endpoint for a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AzureRmTrafficManagerEndpoint cmdlet gets an endpoint for an Azure Traffic Manager profile.</maml:para> <maml:para>You can modify this object locally, and then apply changes to the profile by using the Set-AzureRmTrafficManagerEndpoint cmdlet. Specify the endpoint by using the Name and Type parameters. You can specify the Traffic Manager profile either by using the ProfileName and ResourceGroupName parameter, or by specifying a TrafficManagerProfile object. Alternatively, you can pass that value by using the pipeline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet gets a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet gets a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get an endpoint</maml:title> <dev:code>PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints</dev:code> <dev:remarks> <maml:para>This command gets the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11, and then stores that object in the $TrafficManagerEndpoint variable.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/get-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmTrafficManagerProfile</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Gets a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-AzureRmTrafficManagerProfile cmdlet gets an Azure Traffic Manager profile, and returns an object that represents that profile. Specify a profile by its name and resource group name.</maml:para> <maml:para>You can modify this object locally, and then apply changes to the profile by using the Set-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet does not accept any input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a TrafficManagerProfile object. You can modify this object, and then apply changes to Traffic Manager by using Set-AzureRmTrafficManagerProfile .</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Get a profile</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"</dev:code> <dev:remarks> <maml:para>This command gets the profile named ContosoProfile in ResourceGroup11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/get-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmTrafficManagerEndpoint</command:name> <command:verb>New</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Creates an endpoint in a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-AzureRmTrafficManagerEndpoint cmdlet creates an endpoint in an Azure Traffic Manager profile.</maml:para> <maml:para>This cmdlet commits each new endpoint to the Traffic Manager service. To add multiple endpoints to a local Traffic Manager profile object and commit changes in a single operation, use the Add-AzureRmTrafficManagerEndpointConfig cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointLocation</maml:name> <maml:Description> <maml:para>Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the ExternalEndpoints or NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.</maml:para> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the endpoint. Valid values are: </maml:para> <maml:para>- Enabled </maml:para> <maml:para>- Disabled</maml:para> <maml:para></maml:para> <maml:para>If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoMapping</maml:name> <maml:Description> <maml:para>The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinChildEndpoints</maml:name> <maml:Description> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet creates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.</maml:para> <maml:para>If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. To obtain a profile, use the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetResourceId</maml:name> <maml:Description> <maml:para>Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the ExternalEndpoints endpoint type, specify the Target parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one (1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointLocation</maml:name> <maml:Description> <maml:para>Specifies the location of the endpoint to use in the Performance traffic-routing method. This parameter is only applicable to endpoints of the ExternalEndpoints or NestedEndpoints type. You must specify this parameter when the Performance traffic-routing method is used.</maml:para> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the endpoint. Valid values are: </maml:para> <maml:para>- Enabled </maml:para> <maml:para>- Disabled</maml:para> <maml:para></maml:para> <maml:para>If the status is Enabled, the endpoint is probed for endpoint health and is included in the traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GeoMapping</maml:name> <maml:Description> <maml:para>The list of regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager documentation for a full list of accepted values.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">System.Collections.Generic.List`1[System.String]</command:parameterValue> <dev:type> <maml:name>System.Collections.Generic.List`1[System.String]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MinChildEndpoints</maml:name> <maml:Description> <maml:para>Specify an Azure region name. For a full list of Azure regions, see Azure Regionshttp://azure.microsoft.com/regions/ (http://azure.microsoft.com/regions/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet creates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority that Traffic Manager assigns to the endpoint. This parameter is used only if the Traffic Manager profile is configured with the for Priority traffic-routing method. Valid values are integers from 1 through 1000. Lower values represent higher priority.</maml:para> <maml:para>If you specify a priority, you must specify priorities on all endpoints in the profile, and no two endpoints can share the same priority value. If you do not specify priorities, Traffic Manager assigns default priority values to the endpoints, starting with one (1), in the order the profile lists the endpoints.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile to which this cmdlet adds an endpoint. To obtain a profile, use the New-AzureRmTrafficManagerProfile or Get-AzureRmTrafficManagerProfile cmdlets.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet creates a Traffic Manager endpoint in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the fully qualified DNS name of the endpoint. Traffic Manager returns this value in DNS responses when it directs traffic to this endpoint. Specify this parameter only for the ExternalEndpoints endpoint type. For other endpoint types, specify the TargetResourceId parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetResourceId</maml:name> <maml:Description> <maml:para>Specifies resource ID of the target. Specify this parameter only for the AzureEndpoints and NestedEndpoints endpoint types. For the ExternalEndpoints endpoint type, specify the Target parameter instead.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the weight that Traffic Manager assigns to the endpoint. Valid values are integers from 1 through 1000. The default value is one (1). This parameter is used only if the Traffic Manager profile is configured with the Weighted traffic-routing method.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet does not accept any input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create an external endpoint for a profile</maml:title> <dev:code>PS C:\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type ExternalEndpoints -EndpointLocation "North Europe" -Priority 1 -Target "www.contoso.com" -Weight 10</dev:code> <dev:remarks> <maml:para>This command creates an external endpoint named contoso in the profile named ContosoProfile in the resource group named ResourceGroup11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Create an Azure endpoint for a profile</maml:title> <dev:code>PS C:\>New-AzureRmTrafficManagerEndpoint -EndpointStatus Enabled -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints -Priority 1 -TargetResourceId "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-CentralUS/providers/Microsoft.Web/sites/contoso-web-app" -Weight 10</dev:code> <dev:remarks> <maml:para>This command creates an Azure endpoint named contoso in the profile named ContosoProfile in resource group ResouceGroup11. The Azure endpoint points to the Azure Web App whose Azure Resource Manager ID is given by the URI path in TargetResourceId . The command does not specify the EndpointLocation parameter because the Web App resource supplies the location.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/new-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmTrafficManagerProfile</command:name> <command:verb>New</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Creates a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-AzureRmTrafficManagerProfile cmdlet creates an Azure Traffic Manager profile. Specify the Name parameter and required settings. This cmdlet returns a local object that represents the new profile.</maml:para> <maml:para>This cmdlet does not configure Traffic Manager endpoints. You can update the local profile object by using the Add-AzureRmTrafficManagerEndpointConfig cmdlet. Then upload changes to Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. Alternatively, you can add endpoints by using the New-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IntervalInSecondsForMonitor"> <maml:name>MonitorIntervalInSeconds</maml:name> <maml:Description> <maml:para>The interval (in seconds) at which Traffic Manager will check the health of each endpoint in this profile. The default is 30.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PathForMonitor"> <maml:name>MonitorPath</maml:name> <maml:Description> <maml:para>Specifies the path that is used to monitor endpoint health. Specify a value relative to the endpoint domain name. This value must begin with a slash (/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PortForMonitor"> <maml:name>MonitorPort</maml:name> <maml:Description> <maml:para>Specifies the TCP port that is used to monitor endpoint health. Valid values are integers from 1 through 65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ProtocolForMonitor"> <maml:name>MonitorProtocol</maml:name> <maml:Description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are:</maml:para> <maml:para>- HTTP</maml:para> <maml:para>- HTTPS</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">HTTP</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HTTPS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TCP</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="TimeoutInSecondsForMonitor"> <maml:name>MonitorTimeoutInSeconds</maml:name> <maml:Description> <maml:para>The time (in seconds) that Traffic Manager allows endpoints in this profile to respond to the health check. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ToleratedNumberOfFailuresForMonitor"> <maml:name>MonitorToleratedNumberOfFailures</maml:name> <maml:Description> <maml:para>The number of consecutive failed health checks that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next consecutive failed health check. The default is 3.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies a name for the Traffic Manager profile that this cmdlet creates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the profile. Valid values are: Enabled and Disabled.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Enabled</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Disabled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelativeDnsName</maml:name> <maml:Description> <maml:para>Specifies the relative DNS name that this Traffic Manager profile provides. Traffic Manager combines this value and the DNS domain name that Azure Traffic Manager uses to form the fully qualified domain name (FQDN) of the profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet creates a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>Key-value pairs in the form of a hash table set as tags on the server. For example:</maml:para> <maml:para>@{key0="value0";key1=$null;key2="value2"}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrafficRoutingMethod</maml:name> <maml:Description> <maml:para>Specifies the traffic routing method. This method determines which endpoint Traffic Manager returns in response to incoming DNS queries. Valid values are:</maml:para> <maml:para>- Performance</maml:para> <maml:para>- Weighted</maml:para> <maml:para>- Priority</maml:para> <maml:para>- Geographic</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Performance</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weighted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Priority</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Geographic</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ttl</maml:name> <maml:Description> <maml:para>Specifies the DNS Time to Live (TTL) value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IntervalInSecondsForMonitor"> <maml:name>MonitorIntervalInSeconds</maml:name> <maml:Description> <maml:para>The interval (in seconds) at which Traffic Manager will check the health of each endpoint in this profile. The default is 30.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PathForMonitor"> <maml:name>MonitorPath</maml:name> <maml:Description> <maml:para>Specifies the path that is used to monitor endpoint health. Specify a value relative to the endpoint domain name. This value must begin with a slash (/).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="PortForMonitor"> <maml:name>MonitorPort</maml:name> <maml:Description> <maml:para>Specifies the TCP port that is used to monitor endpoint health. Valid values are integers from 1 through 65535.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ProtocolForMonitor"> <maml:name>MonitorProtocol</maml:name> <maml:Description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are:</maml:para> <maml:para>- HTTP</maml:para> <maml:para>- HTTPS</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="TimeoutInSecondsForMonitor"> <maml:name>MonitorTimeoutInSeconds</maml:name> <maml:Description> <maml:para>The time (in seconds) that Traffic Manager allows endpoints in this profile to respond to the health check. The default is 10.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ToleratedNumberOfFailuresForMonitor"> <maml:name>MonitorToleratedNumberOfFailures</maml:name> <maml:Description> <maml:para>The number of consecutive failed health checks that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next consecutive failed health check. The default is 3.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies a name for the Traffic Manager profile that this cmdlet creates.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileStatus</maml:name> <maml:Description> <maml:para>Specifies the status of the profile. Valid values are: Enabled and Disabled.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RelativeDnsName</maml:name> <maml:Description> <maml:para>Specifies the relative DNS name that this Traffic Manager profile provides. Traffic Manager combines this value and the DNS domain name that Azure Traffic Manager uses to form the fully qualified domain name (FQDN) of the profile.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet creates a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:Description> <maml:para>Key-value pairs in the form of a hash table set as tags on the server. For example:</maml:para> <maml:para>@{key0="value0";key1=$null;key2="value2"}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TrafficRoutingMethod</maml:name> <maml:Description> <maml:para>Specifies the traffic routing method. This method determines which endpoint Traffic Manager returns in response to incoming DNS queries. Valid values are:</maml:para> <maml:para>- Performance</maml:para> <maml:para>- Weighted</maml:para> <maml:para>- Priority</maml:para> <maml:para>- Geographic</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Ttl</maml:name> <maml:Description> <maml:para>Specifies the DNS Time to Live (TTL) value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet does not accept any input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a new TrafficManagerProfile object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a profile</maml:title> <dev:code>PS C:\>New-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" -ProfileStatus Enabled -TrafficRoutingMethod Performance -RelativeDnsName "contosoapp" -TTL 30 -MonitorProtocol HTTP -MonitorPort 80 -MonitorPath "/default.aspx"</dev:code> <dev:remarks> <maml:para>This command creates an Azure Traffic Manager profile named ContosoProfile in resource group ResourceGroup11. The DNS FQDN is contosoapp.trafficmanager.net.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/new-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmTrafficManagerEndpoint</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Removes an endpoint from Traffic Manager.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AzureRmTrafficManagerEndpoint cmdlet removes an endpoint from Azure Traffic Manager.</maml:para> <maml:para>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-AzureRmTrafficManagerEndpointConfig cmdlet.</maml:para> <maml:para>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.</maml:para> <maml:para>Alternatively, you can specify the endpoint name and type by using the Name and Type parameters, together with the ProfileName and ResourceGroupName parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet removes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile from which this cmdlet removes an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">AzureEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExternalEndpoints</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NestedEndpoints</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet removes. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet removes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProfileName</maml:name> <maml:Description> <maml:para>Specifies the name of a Traffic Manager profile from which this cmdlet removes an endpoint. To obtain a profile, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>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.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies the Traffic Manager endpoint that this cmdlet removes. To obtain a TrafficManagerEndpoint object, use the Get-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:Description> <maml:para>Specifies the type of endpoint that this cmdlet adds to the Traffic Manager profile. Valid values are: </maml:para> <maml:para>- AzureEndpoints</maml:para> <maml:para>- ExternalEndpoints</maml:para> <maml:para>- NestedEndpoints</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>Parameter 'TrafficManagerEndpoint' accepts value of type 'TrafficManagerEndpoint' from the pipeline</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove an endpoint from a profile</maml:title> <dev:code>PS C:\>Remove-AzureRmTrafficManagerEndpoint -Name "contoso" -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" -Type AzureEndpoints</dev:code> <dev:remarks> <maml:para>This command removes the Azure endpoint named contoso from the profile named ContosoProfile in the resource group named ResourceGroup11.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmTrafficManagerEndpointConfig</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmTrafficManagerEndpointConfig</command:noun> <maml:description> <maml:para>Removes an endpoint from a local Traffic Manager profile object.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AzureRmTrafficManagerEndpointConfig cmdlet removes an endpoint from a local Azure Traffic Manager profile object. You can get a profile by using the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> <maml:para>This cmdlet operates on the local profile object. Commit your changes to the profile for Traffic Manager by using the Set-AzureRmTrafficManagerProfile cmdlet. To remove an endpoint and commit changes in a single operation, use the Remove-AzureRmTrafficManagerEndpoint cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmTrafficManagerEndpointConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet removes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager endpoint that this cmdlet removes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet modifies this local object. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a modified TrafficManagerProfile object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove an endpoint</maml:title> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" PS C:\> Remove-AzureRmTrafficManagerEndpointConfig -EndpointName "contoso" -Type AzureEndpoints -TrafficManagerProfile $TrafficManagerProfile PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the local profile in the $TrafficManagerProfile variable.</maml:para> <maml:para>The second command removes an Azure endpoint named contoso from the profile stored in $TrafficManagerProfile. This command changes only the local object.</maml:para> <maml:para>The final command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerendpointconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpoint</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmTrafficManagerProfile</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Deletes a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-AzureRmTrafficManagerProfile cmdlet deletes an Azure Traffic Manager profile. Specify the profile to delete by using the Name and ResourceGroupName parameters. Alternatively, you can specify a TrafficManagerProfile object using the TrafficManagerProfile parameter, or you can use the pipeline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet deletes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet deletes a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to delete. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Forces the command to run without asking for user confirmation.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>Specifies the name of the Traffic Manager profile that this cmdlet deletes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:Description> <maml:para>Specifies the name of a resource group. This cmdlet deletes a Traffic Manager profile in the group that this parameter specifies.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a TrafficManagerProfile object to delete. To obtain a TrafficManagerProfile object, use the Get-AzureRmTrafficManagerProfile cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a value of $True, if it succeeds or, if the deletion fails, a value of $False.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Delete a profile specified by name</maml:title> <dev:code>PS C:\>Remove-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"</dev:code> <dev:remarks> <maml:para>This command deletes the profile named ContosoProfile in ResourceGroup11. The command prompts you for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Delete a profile by using the pipeline</maml:title> <dev:code>PS C:\>Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" | Remove-AzureRmTrafficManagerProfile -Force</dev:code> <dev:remarks> <maml:para>This command gets the profile named ContosoProfile in ResourceGroup11. The command then passes that profile to the Remove-AzureRmTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet deletes that profile. The command specifies the Force parameter. Therefore, it does not prompt you for confirmation.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/remove-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmTrafficManagerEndpoint</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmTrafficManagerEndpoint</command:noun> <maml:description> <maml:para>Updates a Traffic Manager endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AzureRmTrafficManagerEndpoint cmdlet updates an endpoint in Azure Traffic Manager. This cmdlet updates the settings from a local endpoint object. You can specify the endpoint object either by using the TrafficManagerEndpoint parameter or by using the pipeline.</maml:para> <maml:para>You can obtain a local object that represents an endpoint by using the Get-AzureRmTrafficManagerEndpoint cmdlet. Modify the object locally and then use Set-AzureRmTrafficManagerEndpoint to commit your changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmTrafficManagerEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerEndpoint object. This cmdlet updates Traffic Manager to match this local object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerEndpoint</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerEndpoint object. This cmdlet updates Traffic Manager to match this local object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerEndpoint</command:parameterValue> <dev:type> <maml:name>TrafficManagerEndpoint</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerEndpoint object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerEndpoint</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a TrafficManagerEndpoint object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update an endpoint</maml:title> <dev:code>PS C:\>$TrafficManagerEndpoint = Get-AzureRmTrafficManagerEndpoint -Name "endpoint1" -Type AzureEndpoints -ProfileName "ContosoProfile" -ResourceGroupName "ResourceGroup11" PS C:\> $TrafficManagerEndpoint.Weight = 20 PS C:\> Set-AzureRmTrafficManagerEndpoint -TrafficManagerEndpoint $TrafficManagerEndpoint</dev:code> <dev:remarks> <maml:para>The first command gets an Azure Traffic Manager endpoint by using the Get-AzureRmTrafficManagerEndpoint cmdlet. The command stores the endpoint locally in the $TrafficManagerEndpoint variable.</maml:para> <maml:para>The second command changes that endpoint locally. This command changes the endpoint weight to 20.</maml:para> <maml:para>The third command updates the endpoint in Traffic Manager to match the local value in $TrafficManagerEndpoint.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/set-azurermtrafficmanagerendpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmTrafficManagerProfile</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmTrafficManagerProfile</command:noun> <maml:description> <maml:para>Updates a Traffic Manager profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-AzureRmTrafficManagerProfile cmdlet updates an Azure Traffic Manager profile. This cmdlet updates the settings of the profile from a local profile object. You can specify the profile object either by using the TrafficManagerProfile parameter or by using the pipeline.</maml:para> <maml:para>You can obtain a local object that represents a profile by using the Get-AzureRmTrafficManagerProfile cmdlet. Modify the object locally and then use Set-AzureRmTrafficManagerProfile to commit your changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet updates Traffic Manager to match this local object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"> <maml:name>DefaultProfile</maml:name> <maml:Description> <maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type> <maml:name>IAzureContextContainer</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TrafficManagerProfile</maml:name> <maml:Description> <maml:para>Specifies a local TrafficManagerProfile object. This cmdlet updates Traffic Manager to match this local object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TrafficManagerProfile</command:parameterValue> <dev:type> <maml:name>TrafficManagerProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet accepts a TrafficManagerProfile object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Network.TrafficManagerProfile</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a TrafficManagerProfile object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update a profile</maml:title> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureRmTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11" PS C:\> $TrafficManagerProfile.ProfileStatus = Disabled PS C:\> Set-AzureRmTrafficManagerProfile -TrafficManagerProfile $TrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command gets an Azure Traffic Manager profile by using the Get-AzureRmTrafficManagerProfile cmdlet. The command stores the profile locally in the $TrafficManagerProfile variable.</maml:para> <maml:para>The second command changes that profile locally. This command disables the profile.</maml:para> <maml:para>The third command updates the Traffic Manager profile named ContosoProfile to match the local value in $TrafficManagerProfile.</maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.trafficmanager/set-azurermtrafficmanagerprofile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerEndpointConfig</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmTrafficManagerProfile</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |