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

Get-AzurePublishSettingsFile

参考

模块:: Azure

下载 Azure 订阅的发布设置文件。

注意

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

Az PowerShell 模块是建议用于管理 PowerShell 的 Azure 资源管理器 (ARM) 资源的 PowerShell 模块。

语法

Get-AzurePublishSettingsFile
   [-Environment <String>]
   [-Realm <String>]
   [-PassThru]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

说明

Get-AzurePublishSettingsFile cmdlet 下载帐户中订阅的发布设置文件。命令完成后，可以使用 Import-PublishSettingsFile cmdlet 使文件中的设置可供 Windows PowerShell 使用。

若要使 Azure 帐户可用于 Windows PowerShell，可以使用发布设置文件或 Add-AzureAccount cmdlet。通过发布设置文件，可以提前准备会话，以便可以无人参与地运行脚本和后台作业。但是，并非所有服务都支持发布设置文件。例如， AzureResourceManager 模块不支持发布设置文件。

运行 Get-AzurePublishSettingsFile 时，它会打开默认浏览器并提示你登录到 Azure 帐户，选择订阅，并选择发布设置文件的文件系统位置。然后，它会将订阅的发布设置文件下载到所选文件中。

“发布设置文件”是扩展名为 .publishsettings 的 XML 文件。该文件包含一个编码的证书，该证书为 Azure 订阅提供管理凭据。

安全说明： 发布设置文件包含用于管理 Azure 订阅和服务的凭据。如果恶意用户访问发布设置文件，他们可以编辑、创建和删除 Azure 服务。最佳做法是，将文件保存到“下载”或“文档”文件夹中的位置，然后使用 Import-AzurePublishSettingsFile cmdlet 导入设置后将其删除。

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

示例

示例 1：下载发布设置文件

PS C:\> Get-AzurePublishSettingsFile

此命令将打开默认浏览器，连接到 Windows Azure 帐户，然后下载帐户的 .publishsettings 文件。

示例 2：指定领域

PS C:\> Get-AzurePublishSettingsFile -Realm contoso.com -Passthru

此命令下载 contoso.com 域中帐户的发布设置文件。使用组织帐户（而不是Microsoft帐户）登录到 Azure 时，将命令与 Realm 参数配合使用。

参数

-Environment

指定 Azure 环境。

Azure 环境独立于 azure 部署Microsoft，例如 AzureCloud for global Azure，以及由世纪互联在中国运营的 AzureChinaCloud for Azure。还可以使用 Azure Pack 和 WAPack cmdlet 创建本地 Azure 环境。有关详细信息，请参阅 Azure Pack。

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

-PassThru

如果命令成功，$False失败，则返回$True。默认情况下，此 cmdlet 不返回任何输出。

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

-Profile

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

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

-Realm

指定组织 ID 中的组织。例如，如果以 Azure 身份admin@contoso.com登录，则 Realm 参数的值 contoso.com。使用组织 ID 登录到Azure 门户时，请使用此参数。使用Microsoft帐户（例如 outlook.com 或 live.com 帐户）时，不需要此参数。

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

输入

None

可以通过属性名称（而不是值）通过管道将输入传递给此 cmdlet。

输出

None or System.Boolean

使用 PassThru 参数时，此 cmdlet 返回布尔值。否则，此 cmdlet 不返回任何输出

通过