Share via


Stop-AzureRmResourceGroupDeployment

取消資源群組部署。

警告

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

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

Syntax

Stop-AzureRmResourceGroupDeployment
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]
Stop-AzureRmResourceGroupDeployment
    -Id <String>
    [-ApiVersion <String>]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Stop-AzureRmResourceGroupDeployment Cmdlet 會取消已啟動但尚未完成的 Azure 資源群組部署。 若要停止部署,部署必須具有不完整的布建狀態,例如布建,而不是已完成的狀態,例如已布建或失敗。 Azure 資源是使用者管理的實體,例如網站、資料庫或資料庫伺服器。 資源群組是部署為單位的資源集合。 若要部署資源群組,請使用 New-AzureRmResourceGroupDeployment Cmdlet。 New-AzureRmResource Cmdlet 會建立新的資源,但不會觸發此 Cmdlet 可以停止的資源群組部署作業。 此 Cmdlet 只會停止一個執行中的部署。 使用 Name 參數來停止特定部署。 如果您省略 Name 參數,Stop-AzureRmResourceGroupDeployment 會搜尋執行中的部署並停止它。 如果 Cmdlet 找到多個執行中的部署,命令就會失敗。

範例

範例 1:啟動和停止資源群組部署

PS C:\> New-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg -TemplateFile .\storage-account-create-azuredeploy.json -TemplateParameterFile .\storage-account-create-azuredeploy.parameters.json -AsJob

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Long Running... AzureLongRun... Running       True            localhost            New-AzureRmResourceGro...

PS C:\> Stop-AzureRmResourceGroupDeployment -Name mynewstorageaccount -ResourceGroupName myrg
True

PS C:\> Get-Job 1

Id     Name            PSJobTypeName   State         HasMoreData     Location             Command
--     ----            -------------   -----         -----------     --------             -------
1      Long Running... AzureLongRun... Failed        True            localhost            New-AzureRmResourceGro...

參數

-ApiVersion

指定資源提供者支援的 API 版本。 您可以指定與預設版本不同的版本。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

指定要停止的資源群組部署標識碼。

Type:String
Aliases:DeploymentId, ResourceId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

指定要停止的資源群組部署名稱。 如果您未指定此參數,此 Cmdlet 會在資源群組中搜尋執行中的部署,並加以停止。 如果找到多個執行中的部署,命令就會失敗。 若要取得部署名稱,請使用 Get-AzureRmResourceGroupDeployment Cmdlet。

Type:String
Aliases:DeploymentName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Pre

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

指定資源群組的名稱。 此 Cmdlet 會停止部署此參數所指定的資源群組。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

None

輸出

Boolean