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

Get-AzureSubscription

获取 Azure 帐户中的 Azure 订阅。

注意

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

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

语法

Get-AzureSubscription
   [-SubscriptionName <String>]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-SubscriptionId <String>]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-Default]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]
Get-AzureSubscription
   [-Current]
   [-ExtendedDetails]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

说明

Get-AzureSubscription cmdlet 获取 Azure 帐户中的订阅。 可以使用此 cmdlet 获取有关订阅的信息,并通过管道将订阅传递给其他 cmdlet。

Get-AzureSubscription 需要访问 Azure 帐户。 在运行 Get-AzureSubscription 之前,必须运行 Add-AzureAccount cmdlet 或下载并安装发布设置文件的 cmdlet(Get-AzurePublishSettingsFileImport-AzurePublishSettingsFile)。

本主题介绍 Microsoft Azure PowerShell 模块的 0.8.10 版本中的 cmdlet。 若要获取正在使用的模块版本,请在 Azure PowerShell 控制台中键入 (Get-Module -Name Azure).Version

示例

示例 1:获取所有订阅

C:\PS>Get-AzureSubscription

此命令获取帐户中的所有订阅。

示例 2:按名称获取订阅

C:\PS>Get-AzureSubscription -SubscriptionName "MyProdSubscription"

此命令仅获取“MyProdSubsciption”订阅。

示例 3:获取默认订阅

C:\PS>(Get-AzureSubscription -Default).SubscriptionName

此命令仅获取默认订阅的名称。 该命令首先获取订阅,然后使用 dot 方法获取 订阅的 SubscriptionName 属性。

示例 4:获取所选订阅属性

C:\PS>Get-AzureSubscription -Current | Format-List -Property SubscriptionName, Certificate

此命令返回一个列表,其中包含当前订阅的名称和证书。 它使用 Get-AzureSubscription 命令获取当前订阅。 然后,它通过管道将订阅传递给一个 Format-List 命令,该命令在列表中显示所选属性。

示例 5:使用备用订阅数据文件

C:\PS>Get-AzureSubscription -SubscriptionDataFile "C:\Temp\MySubscriptions.xml"

此命令从 C:\Temp\MySubscriptions.xml 订阅数据文件获取订阅。 如果在运行 Add-AzureAccountImport-PublishSettingsFile cmdlet 时指定了备用订阅数据文件,请使用 SubscriptionDataFile 参数。

参数

-Current

仅获取指定为“current”的订阅的当前订阅。默认情况下, Get-AzureSubscription 获取 Azure 帐户中的所有订阅。 若要将订阅指定为“当前”,请使用 Select-AzureSubscription cmdlet 的 Current 参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Default

仅获取默认订阅,即指定为“default”的订阅。默认情况下, Get-AzureSubscription 获取 Azure 帐户中的所有订阅。 若要将订阅指定为“default”,请使用 Select-AzureSubscription cmdlet 的默认参数。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ExtendedDetails

除了标准设置之外,还返回订阅的配额信息。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Profile

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

类型:AzureSMProfile
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-SubscriptionId

类型:String
别名:Id
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-SubscriptionName

仅获取指定的订阅。 输入订阅名称。 该值区分大小写。 不支持通配符。 默认情况下, Get-AzureSubscription 获取 Azure 帐户中的所有订阅。

类型:String
别名:Name
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

输入

None

可以按名称通过管道将输入传递给 SubscriptionName 属性,但不能通过值进行传递。

输出

Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureSubscription

备注

  • Get-AzureSubscription 从 Add-AzureAccountImport-PublishSettingsFile cmdlet 创建的订阅数据文件中获取数据。