Add-AzureAccount
將 Azure 帳戶新增至 Windows PowerShell。
注意
本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager(ASM) API 的舊版 Azure 資源。 建立新的資源時,不建議使用此舊版 PowerShell 模組,因為 ASM 已排定淘汰。 如需詳細資訊,請參閱 Azure Service Manager 淘汰。
Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager (ARM) 資源的建議 PowerShell 模組。
語法
Add-AzureAccount
[-Environment <String>]
[-Credential <PSCredential>]
[-Tenant <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Add-AzureAccount
[-Environment <String>]
-Credential <PSCredential>
[-ServicePrincipal]
-Tenant <String>
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
Add-AzureAccount Cmdlet 可讓您的 Azure 帳戶及其訂用帳戶可在 Windows PowerShell 中使用。 就像在 Windows PowerShell 中登入您的 Azure 帳戶一樣。 若要註銷帳戶,請使用 Remove-AzureAccount Cmdlet。
Add-AzureAccount 會下載 Azure 帳戶的相關信息,並將它儲存在漫遊使用者配置檔中的訂用帳戶數據檔中。 它也會取得存取令牌,可讓 Windows PowerShell 代表您存取您的 Azure 帳戶。 當命令完成時,您可以在 Windows PowerShell 中管理 Azure 帳戶。
有兩種不同的方式可讓您的 Azure 帳戶可供 Windows PowerShell 使用。 您可以使用 Add-AzureAccount Cmdlet,其使用 Microsoft Entra 驗證存取令牌,或使用 管理憑證的 Import-AzurePublishSettingsFile。 如需使用方法的指引,請參閱 如何:連線到您的訂用帳戶 (https://azure.microsoft.com/documentation/articles/install-configure-powershell/#Connect)。
當您執行 Add-AzureAccount 時,它會顯示互動式視窗,提示您登入 Azure 帳戶。 此登入有效,直到存取令牌到期為止。 到期時,需要存取帳戶的 Cmdlet 會提示您再次執行 Add-AzureAccount 。
本主題描述 Microsoft Azure PowerShell 模組 0.8.10 版本中的 Cmdlet。
若要取得您所使用的模組版本,請在 Azure PowerShell 控制台中輸入 (Get-Module -Name Azure).Version
。
範例
範例 1:新增帳戶
PS C:\> Add-AzureAccount
此命令會將 Azure 帳戶新增至 Windows PowerShell。 當您執行命令時,視窗會彈出來要求帳戶的使用者名稱和密碼。
範例 2:使用替代訂用帳戶數據檔
PS C:\> Add-AzureAccount -SubscriptionDataFile C:\Testing\SDF.xml
此命令會 使用 SubscriptionDataFile 參數來指示 Add-AzureAccount 將帳戶數據儲存在 C:\Testing\SDF.xml 檔案中,而不是預設檔案。
參數
-Credential
類型: | PSCredential |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-Environment
指定 Azure 環境。
Azure 環境是獨立部署Microsoft Azure,例如適用於全球 Azure 的 Azure 雲端,以及由中國 21Vianet 營運的 AzureChinaCloud。 您也可以使用 Azure Pack 和 WAPack Cmdlet 來建立內部部署 Azure 環境。 如需詳細資訊,請參閱 Azure Pack。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Profile
指定此 Cmdlet 從中讀取的 Azure 設定檔。 如果您未指定設定檔,此 Cmdlet 會從本機預設配置檔讀取。
類型: | AzureSMProfile |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ServicePrincipal
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-Tenant
類型: | String |
別名: | TenantId |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
None
您無法使用管線將輸入傳送至此 Cmdlet
輸出
None
此 Cmdlet 不會傳回任何輸出。
備註
- Add-AzureAccount (和 Microsoft Entra 驗證方法)優先於 Import-AzurePublishSettings (以及管理憑證方法)。 如果您在 帳戶上使用 Add-AzureAccount 一次,則會使用 Microsoft Entra 驗證方法,並忽略管理憑證。 若要移除 Microsoft Entra 令牌並還原管理憑證方法,請使用 Remove-AzureAccount Cmdlet。 如需詳細資訊,請輸入: Get-Help Remove-AzureAccount。
- 錯誤:「您的認證已過期。 請使用 Add-AzureAccount 再次登入。」表示您的存取令牌已過期,且 Windows PowerShell 無法存取您的 Azure 帳戶。 若要還原帳戶的存取權,請再次執行 Add-AzureAccount 。
- Azure PowerShell 帳戶和訂用帳戶 Cmdlet 會從訂用帳戶數據檔取得其數據,而不是從即時 Azure 帳戶取得數據。 如果您在 Windows PowerShell 外部變更帳戶或訂用帳戶,例如使用 Azure 管理入口網站,請再次執行 Add-AzureAccount 以重新整理訂用帳戶 數據檔。