TrafficManager/Microsoft.WindowsAzure.Commands.TrafficManager.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureTrafficManagerEndpoint</command:name> <maml:description> <maml:para>Adds an endpoint to a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureTrafficManagerEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Add-AzureTrafficManagerEndpoint cmdlet adds an endpoint to a Microsoft Azure Traffic Manager profile. After you add an endpoint, pass the result to the Set-AzureTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet connects to Azure to save your changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureTrafficManagerEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the endpoint the cmdlet adds. This must be an Azure location.This parameter must contain a value for endpoints of the type "Any" in a profile that has the load balancing method set to "Performance". You can find a list of possible values for this parameter under Name by calling List Locations. For more information, see List Locations at http://msdn.microsoft.com/en-us/library/gg441293.aspx.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of endpoint. Valid values are: -- CloudService -- AzureWebsite -- Any -- TrafficManager If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the monitoring endpoint. Valid values are: -- Enabled -- Disabled If you specify a value of Enabled, Traffic Manager monitors the endpoint and the load-balancing method considers it when managing traffic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight of the endpoint the cmdlet adds. The valid value range for this parameter is [1,1000].This parameter is only used for RoundRobin load balancing policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinChildEndpoints</maml:name> <maml:description> <maml:para>Specifies the minimum amount of endpoints the nested profile has to have online for this endpoint to be considered online. The valid value for this parameter should be bigger than 0.This parameter is only used for TrafficManager endpoint types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object to which to add the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to add.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the endpoint the cmdlet adds. This must be an Azure location.This parameter must contain a value for endpoints of the type "Any" in a profile that has the load balancing method set to "Performance". You can find a list of possible values for this parameter under Name by calling List Locations. For more information, see List Locations at http://msdn.microsoft.com/en-us/library/gg441293.aspx.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of endpoint. Valid values are: -- CloudService -- AzureWebsite -- Any -- TrafficManager If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the monitoring endpoint. Valid values are: -- Enabled -- Disabled If you specify a value of Enabled, Traffic Manager monitors the endpoint and the load-balancing method considers it when managing traffic.</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"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight of the endpoint the cmdlet adds. The valid value range for this parameter is [1,1000].This parameter is only used for RoundRobin load balancing policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinChildEndpoints</maml:name> <maml:description> <maml:para>Specifies the minimum amount of endpoints the nested profile has to have online for this endpoint to be considered online. The valid value for this parameter should be bigger than 0.This parameter is only used for TrafficManager endpoint types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object to which to add the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> <dev:type> <maml:name>IProfileWithDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Add an endpoint to a profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile" PS C:\> Add-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "Contoso02App.cloudapp.net" -Status "Enabled" -Type "CloudService" | Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureTrafficManagerProfile cmdlet to get the profile named ContosoProfile, and then stores it in the $TrafficManagerProfile variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The second command adds an endpoint to Traffic Manager profile that is stored in $TrafficManagerProfile. The endpoint has the domain name Contoso02App.couldapp.net. The command also specifies whether it is enabled and its type. The command passes the profile object to the Set-AzureTrafficManagerProfile cmdlet to connect to Azure to save your changes.</command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Add an endpoint that has a specified location and weight --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Add-AzureTrafficManagerEndpoint -TrafficManagerProfile ContosoTrafficManagerProfile -DomainName " Contoso02App.cloudapp.net" -Status Enabled -Type CloudService -Weight 2 -Location myLocation | Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This command adds an endpoint to a Traffic Manager profile. The endpoint has the domain name Contoso02App.couldapp.net. The command also specifies whether it is enabled and its type. The command also specifies the weight and location for the endpoint. The command passes the profile object to Set-AzureTrafficManagerProfile to connect to Azure to save your changes.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398281</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Disable-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Disables a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Disable</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Disable-AzureTrafficManagerProfile cmdlet disables a Microsoft Azure Traffic Manager profile. You can use the PassThru parameter to display whether the operation succeeds.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-AzureTrafficManagerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to disable.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</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>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Disable a Traffic Manager profile and display the results --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Disable-AzureTrafficManagerProfile -Name "MyProfile" -PassThru True</dev:code> <dev:remarks> <maml:para>This command disables the Traffic Manager profile named MyProfile. The command specifies the PassThru parameter to display whether the command succeeded.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Disable a Traffic Manager profile and display no results --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Disable-AzureTrafficManagerProfile -Name "MyProfile"</dev:code> <dev:remarks> <maml:para>This command disables the Traffic Manager profile named MyProfile but does not display whether the command succeeded.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398282</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Enable-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Enables a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Enable</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Enable-AzureTrafficManagerProfile cmdlet enables a Microsoft Azure Traffic Manager profile. Specify the PassThru parameter to display whether the operation succeeds.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-AzureTrafficManagerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to enable.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</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>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Enable a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Enable-AzureTrafficManagerProfile -Name "MyProfile"</dev:code> <dev:remarks> <maml:para>This command enables the Traffic Manager profile named MyProfile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Enable a Traffic Manager profile and display the results --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Enable-AzureTrafficManagerProfile -Name "MyProfile" -PassThru True</dev:code> <dev:remarks> <maml:para>This command enables the Traffic Manager profile named MyProfile and displays whether the command succeeded.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398283</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Gets the details of a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Get-AzureTrafficManagerProfile cmdlet gets the details of a Microsoft Azure Traffic Manager profile. If you do not specify the Name parameter, the cmdlet lists the Traffic Manager profiles in the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to get.</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> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Get the list of Traffic Manager profiles in a subscription --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This command gets the list of Traffic Manager profiles in your subscription.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Get a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureTrafficManagerProfile -Name "MyProfile"</dev:code> <dev:remarks> <maml:para>This command gets the Traffic Manager profile named MyProfile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Add an endpoint to a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureTrafficManagerProfile -Name "MyProfile" | Add-AzureTrafficManagerEndpoint -DomainName "Myapp2.cloudapp.net" -TrafficManagerProfile $MyTrafficManagerProfile -Type "CloudService" -Status "Enabled" | Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This command adds an endpoint to a Traffic Manager profile, and then saves the profile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398284</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Creates a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The New-AzureTrafficManagerProfile cmdlet creates a Microsoft Azure Traffic Manager profile.After you create a profile where you set the LoadBalancingMethod value to "Failover", you can determine the failover order of the endpoints you add to your profile with the Add-AzureTrafficManagerEndpoint cmdlet. For more information, see Example 2 below.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureTrafficManagerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the Traffic Manager profile. This must be a subdomain of trafficmanager.net.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancingMethod</maml:name> <maml:description> <maml:para>Specifies the load balancing method to use to distribute the connection. Valid values are: -- Performance -- Failover -- RoundRobin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorPort</maml:name> <maml:description> <maml:para>Specifies the port used to monitor endpoint health. Valid values are integer values greater than 0 and less than or equal to 65,535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorProtocol</maml:name> <maml:description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are: -- Http -- Https</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorRelativePath</maml:name> <maml:description> <maml:para>Specifies the path relative to the endpoint domain name to probe for health state. The path must meet the following restrictions: -- The path must be from 1 through 1000 characters. -- It must start with a forward slash, /. -- It must contain no XML elements, <>. -- It must contain no double slashes, //. -- It must contain no invalid HTML escape characters. For example, %XY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries. Valid values are integers from 30 through 999,999.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to create.</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="false" globbing="false" pipelineInput="false" position="1"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the Traffic Manager profile. This must be a subdomain of trafficmanager.net.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancingMethod</maml:name> <maml:description> <maml:para>Specifies the load balancing method to use to distribute the connection. Valid values are: -- Performance -- Failover -- RoundRobin</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorPort</maml:name> <maml:description> <maml:para>Specifies the port used to monitor endpoint health. Valid values are integer values greater than 0 and less than or equal to 65,535.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorProtocol</maml:name> <maml:description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are: -- Http -- 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="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorRelativePath</maml:name> <maml:description> <maml:para>Specifies the path relative to the endpoint domain name to probe for health state. The path must meet the following restrictions: -- The path must be from 1 through 1000 characters. -- It must start with a forward slash, /. -- It must contain no XML elements, <>. -- It must contain no double slashes, //. -- It must contain no invalid HTML escape characters. For example, %XY.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries. Valid values are integers from 30 through 999,999.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Create a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>New-AzureTrafficManagerProfile -Name "MyProfile" -DomainName "My.profile.trafficmanager.net" -LoadBalancingMethod "RoundRobin" -Ttl 30 -MonitorProtocol "Http" -MonitorPort 80 -MonitorRelativePath "/"</dev:code> <dev:remarks> <maml:para>This command creates a Traffic Manager profile named MyProfile in the specified Traffic Manager domain with a Round Robin load balancing method, a TTL of 30 seconds, HTTP monitoring protocol, monitoring port 80, and with the specified path.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Reorder endpoints to desired failover order --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Profile = Get-AzureTrafficManagerProfile -Name "MyProfile" PS C:\> $Profile.Endpoints[0],$Profile.Endpoints[1] = $Profile.Endpoints[1],$Profile.Endpoints[0] PS C:\> $Profile = Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This example reorders the endpoints added to MyProfile to the desired failover order.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The first command gets the Traffic Manager profile object named MyProfile and stores the object in the $Profile variable.The second command re-orders the endpoints from the endpoints array to the order in which failover should occur.The last command updates the Traffic Manager profile stored in $Profile with the new endpoint order.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398285</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureTrafficManagerEndpoint</command:name> <maml:description> <maml:para>Removes an endpoint from a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureTrafficManagerEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureTrafficManagerEndpoint cmdlet removes an endpoint from a Microsoft Azure Traffic Manager profile. After you remove an endpoint, pass the result to the Set-AzureTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet connects to Azure to save your changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureTrafficManagerEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object from which to remove the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to remove.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para> </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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object from which to remove the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> <dev:type> <maml:name>IProfileWithDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove an endpoint from a profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile" PS C:\> Remove-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "Contoso02App.cloudapp.net" | Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureTrafficManagerProfile cmdlet to get the profile named ContosoProfile, and then stores it in the $TrafficManagerProfile variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The second command removes an endpoint that has the domain name Contoso02App.cloudapp.net from the Traffic Manager profile that is stored in $TrafficManagerProfile. The command passes the profile object to the Set-AzureTrafficManagerProfile cmdlet to connect to Azure to save your changes.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398286</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Removes a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Remove-AzureTrafficManagerProfile cmdlet removes a Microsoft Azure Traffic Manager profile from the current subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureTrafficManagerProfile</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to delete.</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="false" globbing="false" pipelineInput="false" position="named"> <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>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns $True if the operation succeeded; otherwise, $False. By default, this cmdlet does not generate any output.</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>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Remove a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureTrafficManagerProfile -Name "MyProfile"</dev:code> <dev:remarks> <maml:para>This command removes the Traffic Manager profile named MyProfile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Remove a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Remove-AzureTrafficManagerProfile -Name "MyProfile" -Force -PassThru</dev:code> <dev:remarks> <maml:para>This command removes the Traffic Manager profile named MyProfile without prompting you for confirmation, and returns the results.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398286</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureTrafficManagerEndpoint</command:name> <maml:description> <maml:para>Updates the properties of an endpoint in a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureTrafficManagerEndpoint</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureTrafficManagerEndpoint cmdlet updates the properties of an endpoint in a Microsoft Azure Traffic Manager profile. If the endpoint does not exist in the current profile, this cmdlet creates it. After you add an endpoint, pass the result to the Set-AzureTrafficManagerProfile cmdlet by using the pipeline operator. That cmdlet connects to Azure to save your changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureTrafficManagerEndpoint</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the endpoint the cmdlet adds. This must be an Azure location.This parameter must contain a value for endpoints of the type "Any" in a profile that has the load balancing method set to "Performance". You can find a list of possible values for this parameter under Name by calling List Locations. For more information, see List Locations at http://msdn.microsoft.com/en-us/library/gg441293.aspx.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of endpoint. Valid values are: -- CloudService -- AzureWebsite -- Any -- TrafficManager If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the monitoring endpoint. Valid values are: -- Enabled -- Disabled If you specify a value of Enabled, Traffic Manager monitors the endpoint and the load-balancing method considers it when managing traffic.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight of the endpoint the cmdlet adds. The valid value range for this parameter is [1,1000].This parameter is only used for RoundRobin load balancing policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinChildEndpoints</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object for which to modify the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name of the endpoint to modify.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location of the endpoint the cmdlet adds. This must be an Azure location.This parameter must contain a value for endpoints of the type "Any" in a profile that has the load balancing method set to "Performance". You can find a list of possible values for this parameter under Name by calling List Locations. For more information, see List Locations at http://msdn.microsoft.com/en-us/library/gg441293.aspx.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the type of endpoint. Valid values are: -- CloudService -- AzureWebsite -- Any -- TrafficManager If there is more than one AzureWebsite endpoint, the endpoints must be in different datacenters.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status of the monitoring endpoint. Valid values are: -- Enabled -- Disabled If you specify a value of Enabled, Traffic Manager monitors the endpoint and the load-balancing method considers it when managing traffic.</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"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight of the endpoint the cmdlet adds. The valid value range for this parameter is [1,1000].This parameter is only used for RoundRobin load balancing policies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MinChildEndpoints</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object for which to modify the endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> <dev:type> <maml:name>IProfileWithDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Update an endpoint for a profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$TrafficManagerProfile = Get-AzureTrafficManagerProfile -Name "ContosoProfile" PS C:\> Set-AzureTrafficManagerEndpoint -TrafficManagerProfile $TrafficManagerProfile -DomainName "ContosoApp02.cloudapp.net" -Status "Enabled" -Type "CloudService" -Weight 2 -Location myLocation | Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureTrafficManagerProfile cmdlet to get the profile named ContosoProfile, and then stores it in the $TrafficManagerProfile variable.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The second command updates the endpoint in the Traffic Manager profile that is stored in $TrafficManagerProfile. The endpoint has the domain name ContosoApp02.cloudapp.net. The command also specifies the status, type, weight, and location of the endpoint. The command passes the modified profile to the Set-AzureTrafficManagerProfile cmdlet to connect to Azure to save your changes.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398288</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerEndpoint</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureTrafficManagerProfile</command:name> <maml:description> <maml:para>Updates the properties of a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureTrafficManagerProfile</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Set-AzureTrafficManagerProfile cmdlet updates the properties of a Microsoft Azure Traffic Manager profile.For profiles for which you have set the LoadBalancingMethod value to "Failover", you can determine the failover order of the endpoints you have added to your profile with the Add-AzureTrafficManagerEndpoint cmdlet. For more information, see Example 3 below.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureTrafficManagerProfile</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancingMethod</maml:name> <maml:description> <maml:para>Specifies the load balancing method to use to distribute the connection. Valid values are: -- Performance -- Failover -- RoundRobin</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorPort</maml:name> <maml:description> <maml:para>Specifies the port used to monitor endpoint health. Valid values are integer values greater than 0 and less than or equal to 65,535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorProtocol</maml:name> <maml:description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are: -- Http -- Https</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorRelativePath</maml:name> <maml:description> <maml:para>Specifies the path relative to the endpoint domain name to probe for health state. The path must meet the following restrictions: -- The path must be from 1 through 1000 characters. -- It must start with a forward slash, /. -- It must contain no XML elements, <>. -- It must contain no double slashes, //. -- It must contain no invalid HTML escape characters. For example, %XY.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries. Valid values are an integer from 30 through 999,999.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object you use to set the profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the Traffic Manager profile to update.</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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>LoadBalancingMethod</maml:name> <maml:description> <maml:para>Specifies the load balancing method to use to distribute the connection. Valid values are: -- Performance -- Failover -- RoundRobin</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"> <maml:name>MonitorPort</maml:name> <maml:description> <maml:para>Specifies the port used to monitor endpoint health. Valid values are integer values greater than 0 and less than or equal to 65,535.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorProtocol</maml:name> <maml:description> <maml:para>Specifies the protocol to use to monitor endpoint health. Valid values are: -- Http -- 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="false" globbing="false" pipelineInput="false" position="named"> <maml:name>MonitorRelativePath</maml:name> <maml:description> <maml:para>Specifies the path relative to the endpoint domain name to probe for health state. The path must meet the following restrictions: -- The path must be from 1 through 1000 characters. -- It must start with a forward slash, /. -- It must contain no XML elements, <>. -- It must contain no double slashes, //. -- It must contain no invalid HTML escape characters. For example, %XY.</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"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the DNS Time-to-Live (TTL) that informs the Local DNS resolvers how long to cache DNS entries. Valid values are an integer from 30 through 999,999.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0"> <maml:name>TrafficManagerProfile</maml:name> <maml:description> <maml:para>Specifies the Traffic Manager profile object you use to set the profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IProfileWithDefinition</command:parameterValue> <dev:type> <maml:name>IProfileWithDefinition</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.TrafficManager.Models.IProfileWithDefinition</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Set the TTL for a Traffic Manager profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Set-AzureTrafficManagerProfile -TrafficManagerProfile $MyTrafficManagerProfile -Ttl 60</dev:code> <dev:remarks> <maml:para>This command sets the TTL to 60 seconds for the Traffic Manager profile object MyTrafficManagerProfile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2: Set several values for a profile --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Get-AzureTrafficManagerProfile -Name "MyProfile" | Set-AzureTrafficManagerProfile -LoadBalancingMethod "RoundRobin" -Ttl 30 -MonitorProtocol "Http" -MonitorPort 80 -MonitorRelativePath "/"</dev:code> <dev:remarks> <maml:para>This command gets a Traffic Manager profile named MyProfile by using the Get-AzureTrafficManagerProfile cmdlet. The profile uses the RoundRobin load balancing method, a TTL of 30 seconds, the monitor protocol HTTP, the monitor port, and the relative path for a Traffic Manager profile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3: Reorder endpoints to desired failover order --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>$Profile = Get-AzureTrafficManagerProfile -Name "MyProfile" PS C:\> $Profile.Endpoints[0],$Profile.Endpoints[1] = $Profile.Endpoints[1],$Profile.Endpoints[0] PS C:\> $Profile = Set-AzureTrafficManagerProfile</dev:code> <dev:remarks> <maml:para>This example reorders the endpoints added to MyProfile to the desired failover order.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText>The first command gets the Traffic Manager profile object named MyProfile and stores the object in the $Profile variable.The second command re-orders the endpoints from the endpoints array to the order in which failover should occur.The last command updates the Traffic Manager profile stored in $Profile with the new endpoint order.</command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398289</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Enable-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureTrafficManagerProfile</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Test-AzureTrafficManagerDomainName</command:name> <maml:description> <maml:para>Checks whether a domain name is available as a Traffic Manager profile.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>AzureTrafficManagerDomainName</command:noun> <dev:version /> </command:details> <maml:description> <!--This is the Description section--> <maml:para>The Test-AzureTrafficManagerDomainName cmdlet checks whether a domain name is available as a Microsoft Azure Traffic Manager profile. If the domain name is available, this cmdlet returns a value of $True.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-AzureTrafficManagerDomainName</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name to test. You must include the following string: .trafficmanager.net</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>DomainName</maml:name> <maml:description> <maml:para>Specifies the domain name to test. You must include the following string: .trafficmanager.net</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> </maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> <maml:description> <maml:para> </maml:para> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para> </maml:para> <maml:para>Keywords: azure, azuresm, servicemanagement, management, service, traffic, trafficmanager</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1: Check whether a domain name is available --------------------------</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code>PS C:\>Test-AzureTrafficManagerDomainName -DomainName "ContosoApp.trafficmanager.net" $True</dev:code> <dev:remarks> <maml:para>This command checks whether the domain name ContosoApp.trafficmanager.net is available as a Traffic Manager profile.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>http://go.microsoft.com/fwlink/?LinkID=398290</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |