Get-AzTrafficManagerProfile.md

external help file	Module Name	ms.assetid	online version	schema
Microsoft.Azure.PowerShell.Cmdlets.TrafficManager.dll-Help.xml	Az.TrafficManager	5032D487-3849-4C80-BD14-5B735FC39285	https://learn.microsoft.com/powershell/module/az.trafficmanager/get-aztrafficmanagerprofile	2.0.0

Get-AzTrafficManagerProfile

SYNOPSIS

Gets a Traffic Manager profile.

SYNTAX

ResourceGroupParameterSet

Get-AzTrafficManagerProfile [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

AccountNameParameterSet

Get-AzTrafficManagerProfile [-ResourceGroupName] <String> [-Name] <String>
 [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]

DESCRIPTION

The Get-AzTrafficManagerProfile 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.

You can modify this object locally, and then apply changes to the profile by using the Set-AzTrafficManagerProfile cmdlet.

EXAMPLES

Example 1: Get a profile

Get-AzTrafficManagerProfile -Name "ContosoProfile" -ResourceGroupName "ResourceGroup11"

This command gets the profile named ContosoProfile in ResourceGroup11.

PARAMETERS

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the Traffic Manager profile that this cmdlet gets.

Type: System.String
Parameter Sets: AccountNameParameterSet
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ResourceGroupName

Specifies the name of a resource group that contains the Traffic Manager profile that this cmdlet gets.

Type: System.String
Parameter Sets: ResourceGroupParameterSet
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

Type: System.String
Parameter Sets: AccountNameParameterSet
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

Microsoft.Azure.Commands.TrafficManager.Models.TrafficManagerProfile

NOTES

RELATED LINKS

Disable-AzTrafficManagerProfile

Enable-AzTrafficManagerProfile

New-AzTrafficManagerProfile

Remove-AzTrafficManagerProfile

Set-AzTrafficManagerProfile