共用方式為

Set-AzureEnvironment

  • 參考
模組:
Azure

變更 Azure 環境的屬性。

注意

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

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

語法

Set-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

Set-AzureEnvironment Cmdlet 會變更 Azure 環境的屬性。 它會傳回 物件，這個物件表示環境的新屬性值。 使用 Name 參數來識別環境和其他參數來變更屬性值。 您無法使用 Set-AzureEnvironment 來變更 Azure 環境的名稱。

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

注意：請勿變更 AzureCloud 或 AzureChinaCloud 環境的屬性。 使用此 Cmdlet 來變更您建立的私人環境值。

範例

範例 1：變更環境屬性

PS C:\> Set-AzureEnvironment -Name ContosoEnv -PublishSettingsFileUrl "https://contoso.com" -StorageEndpoint "contoso.com"

此命令會變更 ContosoEnv 環境的 PublishSettingsFileUrl 和 StorageEndpoint 屬性的值。

參數

-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 的說明主題。

類型: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

識別正在變更的環境。 此為必要參數。 參數值會區分大小寫。 不允許通配符。

類型: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 Cmdlet （https://go.microsoft.com/fwlink/?LinkID=394765） 和使用 Windows PowerShell 搭配 Resource Manager （https://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