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

Get-AzureRole

返回 Microsoft Azure 服务中的角色列表。

注意

本文档中引用的 cmdlet 用于管理使用 Azure Service Manager (ASM) API 的旧 Azure 资源。 创建新的资源时,不建议使用此旧版 PowerShell 模块,因为 ASM 计划停用。 有关详细信息,请参阅 Azure Service Manager 停用

Az PowerShell 模块是推荐的 PowerShell 模块,用于使用 PowerShell 管理 Azure 资源管理器 (ARM) 资源。

语法

Get-AzureRole
   [-ServiceName] <String>
   [[-Slot] <String>]
   [[-RoleName] <String>]
   [-InstanceDetails]
   [-Profile <AzureSMProfile>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

说明

Get-AzureRole cmdlet 返回一个列表对象,其中包含有关 Microsoft azure 服务中角色的详细信息。 如果指定 RoleName 参数, Get-AzureRole 仅返回该角色的详细信息。 如果指定 InstanceDetails 参数,则返回特定于实例的其他详细信息。

示例

示例 1:获取服务的角色列表

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production"

此命令返回一个对象,其中包含 MySvc01 服务上运行的所有生产角色的详细信息。

示例 2:获取有关服务上运行的角色的详细信息

PS C:\> Get-AzureRole -ServiceName "MySvc1" -Slot "Staging" -RoleName "MyTestVM3"

此命令返回一个对象,其中包含 MyTestVM3 角色的详细信息,该角色在 MySvc01 服务的暂存环境中运行。

示例 3:获取有关服务上运行的角色实例的实例信息

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production" -RoleName "MyTestVM02" -InstanceDetails

此命令返回一个对象,其中包含 MySvc01 服务生产环境中运行的 MyTestVM02 角色实例的详细信息。

示例 4:获取与服务关联的角色实例的表

PS C:\> Get-AzureRole -ServiceName "MySvc01" -Slot "Production" -InstanceDetails | Format-Table -Auto "InstanceName", "InstanceSize", "InstanceStatus"

此命令返回 MySvc01 服务生产环境中运行的所有角色实例的实例名称、大小和状态表。

参数

-InformationAction

指定此 cmdlet 如何响应信息事件。

此参数的可接受值为:

  • 继续
  • 忽略
  • 询问
  • SilentlyContinue
  • 停止
  • Suspend
类型:ActionPreference
Aliases:infa
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

指定信息变量。

类型:String
Aliases:iv
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-InstanceDetails

指定此 cmdlet 返回有关每个角色的实例的详细信息。

类型:SwitchParameter
Position:3
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-Profile

指定此 cmdlet 从中读取的 Azure 配置文件。 如果未指定配置文件,此 cmdlet 将从本地默认配置文件中读取。

类型:AzureSMProfile
Position:Named
默认值:None
必需:False
Accept pipeline input:False
Accept wildcard characters:False

-RoleName

指定要获取的角色的名称。

类型:String
Position:2
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False

-ServiceName

指定 Azure 服务的名称。

类型:String
Position:0
默认值:None
必需:True
Accept pipeline input:True
Accept wildcard characters:False

-Slot

指定 Azure 部署环境。 此参数的可接受值为:生产或暂存。

类型:String
Position:1
默认值:None
必需:False
Accept pipeline input:True
Accept wildcard characters:False