Get-AzureTrafficManagerProfile
Get-AzureTrafficManagerProfile
Gets an Azure Traffic Manager profile.
Syntax
Parameter Set: Default
Get-AzureTrafficManagerProfile -Name <String> -ResourceGroupName <String> [-Profile <AzureProfile> ] [ <CommonParameters>]
Detailed Description
The Get-AzureTrafficManagerProfile cmdlet gets a Traffic Manager profile from Azure Traffic Manager, and returns an object that represents that profile. You can modify the local object, and then apply changes to the profile by using the Set-AzureTrafficManagerProfile cmdlet.
Parameters
-Name<String>
Specifies the name of the Traffic Manager profile to get.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Profile<AzureProfile>
Specifies an Azure profile.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<String>
Specifies the name of a resource group that contains the Traffic Manager profile.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Azure.Commands.Network.TrafficManagerProfile
This cmdlet returns a TrafficManagerProfile object. You can modify this object, and then apply changes to Traffic Manager by using Set-AzureTrafficManagerProfile.
Examples
Example 1: Get a profile
This command gets the profile named ContosoProfile in ResourceGroup11.
PS C:\> Get-AzureTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"
Related topics
New-AzureTrafficManagerProfile