New-AzureRmResourceGroupDeployment
將 Azure 部署加入資源群組。
警告
自 2024 年 2 月 29 日起,AzureRM PowerShell 模組已正式淘汰。 建議使用者從 AzureRM 遷移至 Az PowerShell 模組,以確保持續支援和更新。
雖然 AzureRM 模組可能仍可運作,但不再維護或支援它,但會根據用戶的判斷權和風險放置任何繼續使用。 如需轉換至 Az 模組的指引,請參閱我們的 移轉資源 。
語法
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterObject <Hashtable>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterObject <Hashtable>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterFile <String>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterFile <String>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterUri <String>
-TemplateFile <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateParameterUri <String>
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
New-AzureRmResourceGroupDeployment
[-Name <String>]
-ResourceGroupName <String>
[-Mode <DeploymentMode>]
[-DeploymentDebugLogLevel <String>]
[-RollbackToLastDeployment]
[-RollBackDeploymentName <String>]
[-Force]
[-AsJob]
-TemplateUri <String>
[-ApiVersion <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
New-AzureRmResourceGroupDeployment Cmdlet 會將部署新增至現有的資源群組。 這包括部署所需的資源。 Azure 資源是使用者管理的 Azure 實體,例如資料庫伺服器、資料庫、網站、虛擬機或記憶體帳戶。 Azure 資源群組是部署為單位的 Azure 資源集合,例如財務網站所需的網站、資料庫伺服器和資料庫。 資源群組部署會使用範本將資源新增至資源群組,並加以發佈,使其可在 Azure 中使用。 若要在不使用範本的情況下將資源新增至資源群組,請使用 New-AzureRmResource Cmdlet。 若要新增資源群組部署,請指定現有資源群組和資源群組範本的名稱。 資源群組範本是 JSON 字串,代表複雜雲端式服務的資源群組,例如入口網站。 此範本包含必要資源和可設定屬性值的參數佔位元元,例如名稱和大小。 您可以在 Azure 樣本資源庫中找到許多範本,也可以建立自己的範本。 您可以使用 Get-AzureRmResourceGroupGalleryTemplate Cmdlet 在資源庫中尋找範本。 若要使用自定義範本來建立資源群組,請指定 TemplateFile 參數或 TemplateUri 參數。 每個範本都有可設定屬性的參數。 若要指定範本參數的值,請指定 TemplateParameterFile 參數或 TemplateParameterObject 參數。 或者,您可以在指定範本時,使用動態新增至命令的範本參數。 若要使用動態參數,請在命令提示字元中輸入它們,或輸入減號 (-) 來指出參數,並使用 Tab 鍵來迴圈查看可用的參數。 您在命令提示字元輸入的樣本參數值優先於範本參數物件或檔案中的值。
範例
範例 1:使用自定義範本和參數檔案來建立部署
PS C:\>New-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoEngineering" -TemplateFile "D:\Azure\Templates\EngineeringSite.json" -TemplateParameterFile "D:\Azure\Templates\EngSiteParms.json"
此命令會使用自定義範本和磁碟上的範本檔案來建立新的部署。 此命令會使用 TemplateFile 參數來指定範本和 TemplateParameterFile 參數,以指定包含參數和參數值的檔案。
參數
-ApiVersion
指定資源提供者支援的 API 版本。 您可以指定與預設版本不同的版本。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-AsJob
在背景執行 Cmdlet
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Confirm
執行 Cmdlet 之前先提示您確認。
類型: | SwitchParameter |
別名: | cf |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-DefaultProfile
用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶
類型: | IAzureContextContainer |
別名: | AzureRmContext, AzureCredential |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-DeploymentDebugLogLevel
指定偵錯記錄層級。 此參數可接受的值為:
- RequestContent
- ResponseContent
- 全部
- 無
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Force
強制命令執行,而不要求使用者確認。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Mode
指定部署模式。 此參數可接受的值為:
- 完成
- 累加 在完整模式中,Resource Manager 會刪除存在於資源群組中的資源,但未在範本中指定。 在累加模式中,Resource Manager 會保留存在於資源群組中但未在範本中指定的未變更資源。
類型: | DeploymentMode |
Position: | Named |
預設值: | Incremental |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Name
指定要建立的資源組名。
類型: | String |
別名: | DeploymentName |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Pre
指出此 Cmdlet 會在自動判斷要使用的版本時,考慮發行前版本 API 版本。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-ResourceGroupName
指定要部署的資源群組名稱。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-RollBackDeploymentName
如果使用 -RollbackToLastDeployment,則不應該使用資源群組中具有指定名稱的成功部署。
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-RollbackToLastDeployment
如果使用 -RollBackDeploymentName,則不應該在資源群組中復原至最後一次成功的部署。
類型: | SwitchParameter |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-TemplateFile
指定 JSON 範本檔案的完整路徑。 這可以是自定義範本或資源庫範本,會儲存為 JSON 檔案,例如使用 Save-AzureRmResourceGroupGalleryTemplate Cmdlet 所建立的範本。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TemplateParameterFile
指定 JSON 檔案的完整路徑,其中包含範本參數的名稱和值。 如果範本具有參數,您必須使用 TemplateParameterFile 參數或 TemplateParameterObject 參數來指定參數值。 當您指定範本時,範本參數會動態新增至命令。 若要使用動態參數,請輸入減號 (-) 來指出參數名稱,然後使用 Tab 鍵來迴圈查看可用的參數。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TemplateParameterObject
指定範本參數名稱和值的哈希表。
如需 Windows PowerShell 中哈希表的說明,請輸入 Get-Help about_Hash_Tables
。
如果範本具有參數,您必須指定參數值。
當您指定範本時,範本參數會動態新增至命令。
類型: | Hashtable |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TemplateParameterUri
指定範本參數檔案的 URI。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-TemplateUri
指定 JSON 範本檔案的 URI。 此檔案可以是自定義範本或儲存為 JSON 檔案的資源庫範本,例如使用 Save-AzureRmResourceGroupGalleryTemplate。
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
類型: | SwitchParameter |
別名: | wi |
Position: | Named |
預設值: | False |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
輸入
None
輸出
Microsoft.Azure.Commands.ResourceManager.Models.PSResourceGroupDeployment