你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzureRmResourceGroup

获取资源组。

警告

截至 2024 年 2 月 29 日,AzureRM PowerShell 模块已正式弃用。 为了确保持续获得支持和更新,建议用户从 AzureRM 迁移到 Az PowerShell 模块。

尽管 AzureRM 模块仍可能正常运行,但它不再维护或受支持,但会根据用户的自由裁量权和风险继续使用任何继续使用模块。 有关过渡到 Az 模块的指导,请参阅我们的迁移资源

语法

Get-AzureRmResourceGroup
   [-Name <String>]
   [-Location <String>]
   [-Tag <Hashtable>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmResourceGroup
   [-Location <String>]
   [-Id <String>]
   [-ApiVersion <String>]
   [-Pre]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzureRmResourceGroup cmdlet 获取当前订阅中的 Azure 资源组。 可以获取所有资源组,也可以按名称或其他属性指定资源组。 默认情况下,此 cmdlet 获取当前订阅中的所有资源组。 有关 Azure 资源和 Azure 资源组的详细信息,请参阅 New-AzureRmResourceGroup cmdlet。

示例

示例 1:按名称获取资源组

PS C:\>Get-AzureRmResourceGroup -Name "EngineerBlog"

此命令获取名为 EngineerBlog 的订阅中的 Azure 资源组。

示例 2:获取资源组的所有标记

PS C:\>(Get-AzureRmResourceGroup -Name "ContosoRG").Tags

此命令获取名为 ContosoRG 的资源组,并显示与该组关联的标记。

示例 3:按位置显示资源组

PS C:\> Get-AzureRmResourceGroup |
  Sort Location,ResourceGroupName |
  Format-Table -GroupBy Location ResourceGroupName,ProvisioningState,Tags

示例 4:显示特定位置中所有资源组的名称

PS C:\> Get-AzureRmResourceGroup -Location westus2 |
   Sort ResourceGroupName | 
   Format-Wide ResourceGroupName -Column 4

示例 5:显示名称以 WebServer 开头的资源组

PS C:\> Get-AzureRmResourceGroup | Where ResourceGroupName -like WebServer*

参数

-ApiVersion

指定资源提供程序支持的 API 版本。 可以指定与默认版本不同的版本。

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

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

指定要获取的资源组的 ID。 不允许使用通配符。

Type:String
Aliases:ResourceGroupId, ResourceId
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Location

指定要获取的资源组的位置。

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

-Name

指定要获取的资源组的名称。 此参数支持字符串开头和/或末尾的 wild卡s。

Type:String
Aliases:ResourceGroupName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

指示此 cmdlet 在自动确定要使用的版本时会考虑预发布 API 版本。

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

-Tag

要按其筛选资源组的标记哈希表。

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

输入

None

输出

Microsoft.Azure.Commands.ResourceManagement.PSResourceGroup