共用方式為


Export-AzureRmResourceGroup

擷取資源群組作為範本,並將它儲存至檔案。

警告

自 2024 年 2 月 29 日起,AzureRM PowerShell 模組已正式淘汰。 建議使用者從 AzureRM 遷移至 Az PowerShell 模組,以確保持續支援和更新。

雖然 AzureRM 模組可能仍可運作,但不再維護或支援它,但會根據用戶的判斷權和風險放置任何繼續使用。 如需轉換至 Az 模組的指引,請參閱我們的 移轉資源

Syntax

Export-AzureRmResourceGroup
      -ResourceGroupName <String>
      [-Path <String>]
      [-IncludeParameterDefaultValue]
      [-IncludeComments]
      [-Force]
      [-ApiVersion <String>]
      [-Pre]
      [-DefaultProfile <IAzureContextContainer>]
      [-InformationAction <ActionPreference>]
      [-InformationVariable <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Export-AzureRmResourceGroup Cmdlet 會將指定的資源群組擷取為範本,並將它儲存至 JSON 檔案。這在您已經在資源群組中建立一些資源,然後想要利用使用範本支援的部署的優點時,這非常有用。 此 Cmdlet 可讓您輕鬆開始為資源群組中的現有資源產生範本。 在某些情況下,此 Cmdlet 無法產生範本的某些部分。 警告訊息會通知您失敗的資源。 範本仍會針對成功的元件產生。

範例

範例 1:匯出資源群組

PS C:\>Export-AzureRmResourceGroup -ResourceGroupName "TestGroup"

此命令會擷取名為TestGroup的資源群組作為範本,並將它儲存至目前目錄中的 JSON 檔案。

參數

-ApiVersion

指定要使用的資源提供者 API 版本。 如果未指定,則會使用最新的 API 版本。

類型:String
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

執行 Cmdlet 之前先提示您確認。

類型:SwitchParameter
Aliases:cf
Position:Named
預設值:False
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

類型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

強制命令執行,而不要求使用者確認。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeComments

指出這項作業會導出具有批注的範本。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeParameterDefaultValue

表示此作業會導出具有預設值的樣板參數。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationAction

指定此 Cmdlet 如何回應資訊事件。 此參數可接受的值為:

  • 繼續
  • 忽略
  • 詢問
  • SilentlyContinue
  • 停止
  • 暫止
類型:ActionPreference
Aliases:infa
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-InformationVariable

指定資訊變數。

類型:String
Aliases:iv
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

指定範本檔案的輸出路徑。

類型:String
Position:Named
預設值:None
必要:False
Accept pipeline input:True
Accept wildcard characters:False

-Pre

指出當自動判斷要使用的 API 版本時,此 Cmdlet 會使用發行前版本 API 版本。

類型:SwitchParameter
Position:Named
預設值:None
必要:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

指定要匯出的資源群組名稱。

類型:String
Aliases:ResourceGroup
Position:Named
預設值:None
必要:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

類型:SwitchParameter
Aliases:wi
Position:Named
預設值:False
必要:False
Accept pipeline input:False
Accept wildcard characters:False