Get-AzurePublishSettingsFile
下載 Azure 訂用帳戶的發佈設定檔。
注意
本檔中參考的 Cmdlet 用於管理使用服務管理 API 的舊版 Azure 資源。 如需管理 Azure Resource Manager 資源的 Cmdlet,請參閱 Az PowerShell 模組 。
Syntax
Get-AzurePublishSettingsFile
[-Environment <String>]
[-Realm <String>]
[-PassThru]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
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 網域中帳戶的發佈設定檔。 當您使用組織帳戶登入 Azure 時,請搭配 Realm 參數使用命令,而不是使用 Microsoft 帳戶。
參數
-Environment
指定 Azure 環境。
Azure 環境是 Microsoft Azure 的獨立部署,例如適用于全球 Azure 的 Azure 雲端,以及由中國 21Vianet 營運的 AzureChinaCloud。 您也可以使用 Azure Pack 和 WAPack Cmdlet 來建立內部部署 Azure 環境。 如需詳細資訊,請參閱 Azure Pack 。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
如果命令成功,並$False失敗,則傳回$True。 根據預設,此 Cmdlet 不會傳回任何輸出。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Profile
指定此 Cmdlet 從中讀取的 Azure 設定檔。 如果您未指定設定檔,此 Cmdlet 會從本機預設設定檔讀取。
Type: | AzureSMProfile |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Realm
指定組織識別碼中的組織。 例如,如果您以 身分 admin@contoso.com 登入 Azure,則 Realm 參數的值 會 contoso.com。 當您使用組織識別碼登入 Azure 入口網站時,請使用此參數。 當您使用 Microsoft 帳戶時,不需要此參數,例如 outlook.com 或 live.com 帳戶。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
輸入
None
您可以透過屬性名稱將輸入管線傳送至此 Cmdlet,但不能依值傳送。
輸出
None or System.Boolean
當您使用 PassThru 參數時,這個 Cmdlet 會傳回布林值。 否則,此 Cmdlet 不會傳回任何輸出