共用方式為


Add-AzureEnvironment

建立 Azure 環境。

注意

本文件中參考的 Cmdlet 用於管理使用 Azure Service Manager(ASM) API 的舊版 Azure 資源。 建立新的資源時,不建議使用此舊版 PowerShell 模組,因為 ASM 已排定淘汰。 如需詳細資訊,請參閱 Azure Service Manager 淘汰

Az PowerShell 模組是使用 PowerShell 管理 Azure Resource Manager (ARM) 資源的建議 PowerShell 模組。

語法

Add-AzureEnvironment
   -Name <String>
   [-PublishSettingsFileUrl <String>]
   [-ServiceEndpoint <String>]
   [-ManagementPortalUrl <String>]
   [-StorageEndpoint <String>]
   [-ActiveDirectoryEndpoint <String>]
   [-ResourceManagerEndpoint <String>]
   [-GalleryEndpoint <String>]
   [-ActiveDirectoryServiceEndpointResourceId <String>]
   [-GraphEndpoint <String>]
   [-AzureKeyVaultDnsSuffix <String>]
   [-AzureKeyVaultServiceEndpointResourceId <String>]
   [-TrafficManagerDnsSuffix <String>]
   [-SqlDatabaseDnsSuffix <String>]
   [-EnableAdfsAuthentication]
   [-AdTenant <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

Add-AzureEnvironment Cmdlet 會建立新的自定義 Azure 帳戶環境,並將它儲存在您的漫遊使用者配置檔中。 Cmdlet 會傳回代表新環境的物件。 當命令完成時,您可以在 Windows PowerShell 中使用環境。

Azure 環境是獨立部署Microsoft Azure,例如適用於全球 Azure 的 Azure 雲端,以及由中國 21Vianet 營運的 AzureChinaCloud。 您也可以使用 Azure Pack 和 WAPack Cmdlet 來建立內部部署 Azure 環境。 如需詳細資訊,請參閱 Azure Pack

只有這個 Cmdlet 的 Name 參數是必要的。 如果您省略參數,其值為 null($Null),且使用該端點的服務可能無法正常運作。 若要新增或變更環境屬性的值,請使用 Set-AzureEnvironment Cmdlet。

注意:變更您的環境可能會導致您的帳戶失敗。 一般而言,環境只會新增以進行測試或疑難解答。

本主題描述 Microsoft Azure PowerShell 模組 0.8.10 版本中的 Cmdlet。 若要取得您所使用的模組版本,請在 Azure PowerShell 控制台中輸入 (Get-Module -Name Azure).Version

範例

範例 1:新增 Azure 環境

PS C:\> Add-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl https://contoso.com/fwlink/?LinkID=101 -ServiceEndpoint https://contoso.com/fwlink/?LinkID=102

Name                          : ContosoEnv

PublishSettingsFileUrl        : https://contoso.com/fwlink/?LinkID=101

ServiceEndpoint               : https://contoso.com/fwlink/?LinkID=102

ResourceManagerEndpoint       :

ManagementPortalUrl           :

ActiveDirectoryEndpoint       :

ActiveDirectoryCommonTenantId :

StorageEndpointSuffix         :

StorageBlobEndpointFormat     :

StorageQueueEndpointFormat    :

StorageTableEndpointFormat    :

GalleryEndpoint               :

此命令會建立 ContosoEnv Azure 環境。

參數

-ActiveDirectoryEndpoint

指定新環境中Microsoft Entra 驗證的端點。

類型:String
別名:AdEndpointUrl, ActiveDirectory, ActiveDirectoryAuthority
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ActiveDirectoryServiceEndpointResourceId

指定管理 API 的資源識別碼,其存取權是由 Microsoft Entra ID 所管理。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-AdTenant

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-AzureKeyVaultDnsSuffix

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-AzureKeyVaultServiceEndpointResourceId

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-EnableAdfsAuthentication

類型:SwitchParameter
別名:OnPremise
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-GalleryEndpoint

指定儲存資源群組資源庫範本的 Azure Resource Manager 資源庫端點。 如需 Azure 資源群組和資源庫範本的詳細資訊,請參閱 Get-AzureResourceGroupGalleryTemplate 的說明主題https://go.microsoft.com/fwlink/?LinkID=393052.

類型:String
別名:Gallery, GalleryUrl
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-GraphEndpoint

類型:String
別名:Graph, GraphUrl
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ManagementPortalUrl

指定新環境中的 Azure 管理入口網站的 URL。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-Name

指定環境的名稱。 此為必要參數。 請勿使用默認環境、AzureCloud 和 AzureChinaCloud 的名稱。

類型:String
Position:Named
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

-Profile

指定此 Cmdlet 從中讀取的 Azure 設定檔。 如果您未指定設定檔,此 Cmdlet 會從本機預設配置檔讀取。

類型:AzureSMProfile
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-PublishSettingsFileUrl

指定您帳戶之發佈配置檔的 URL。 Azure 發佈配置檔案是一個 XML 檔案,其中包含您的帳戶相關信息,以及允許 Windows PowerShell 代表您登入 Azure 帳戶的管理憑證。

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ResourceManagerEndpoint

指定 Azure Resource Manager 數據的端點,包括與帳戶相關聯的資源群組相關數據。 如需 Azure Resource Manager 的詳細資訊,請參閱 Azure Resource Manager Cmdlethttps://go.microsoft.com/fwlink/?LinkID=394765) 和使用 Windows PowerShell 搭配 Resource Managerhttps://go.microsoft.com/fwlink/?LinkID=394767)。

類型:String
別名:ResourceManager, ResourceManagerUrl
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-ServiceEndpoint

指定 Azure 服務端點的 URL。 Azure 服務端點會決定您的應用程式是由全球 Azure 平臺管理、由中國 21Vianet 運作的 Azure,還是私人 Azure 安裝。

類型:String
別名:ServiceManagement, ServiceManagementUrl
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-SqlDatabaseDnsSuffix

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

-StorageEndpoint

指定新環境中記憶體服務的預設端點。

類型:String
別名:StorageEndpointSuffix
Position:Named
預設值:None
必要:False
接受管線輸入:False
接受萬用字元:False

-TrafficManagerDnsSuffix

類型:String
Position:Named
預設值:None
必要:False
接受管線輸入:True
接受萬用字元:False

輸入

None

您可以透過屬性名稱將輸入管線傳送至此 Cmdlet,但不能依值傳送。

輸出

Microsoft.WindowsAzure.Commands.Utilities.Common.WindowsAzureEnvironment