< Back
Stop-AzureRmResourceGroupDeployment
Post
NAME Stop-AzureRmResourceGroupDeployment
SYNOPSIS
Cancels a resource group deployment.
SYNTAX
Stop-AzureRmResourceGroupDeployment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-Pre] [-Confirm] [-WhatIf]
[<CommonParameters>]
Stop-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-ApiVersion <String>] [-DefaultProfile
<IAzureContextContainer>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmResourceGroupDeployment cmdlet cancels an Azure resource group deployment that has started but not completed. To stop a
deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or
Failed.
An Azure resource is a user-managed entity, such as a website, database, or database server. A resource group is a collection of resources that
are deployed as a unit. To deploy a resource group, use the New-AzureRmResourceGroupDeployment cmdlet.
The New-AzureRmResource cmdlet creates a new resource, but it does not trigger a resource group deployment operation that this cmdlet can stop.
This cmdlet stops only one running deployment.
Use the Name parameter to stop a specific deployment. If you omit the Name parameter, Stop-AzureRmResourceGroupDeployment searches for a running
deployment and stops it. If the cmdlet finds more than one running deployment, the command fails.
PARAMETERS
-ApiVersion <String>
Specifies the API version that is supported by the resource Provider. You can specify a different version than the default version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the resource group deployment to stop.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the resource group deployment to stop.
If you do not specify this parameter, this cmdlet searches for a running deployment in the resource group and stops it. If it finds more than
one running deployment, the command fails. To get the deployment name, use the Get-AzureRmResourceGroupDeployment cmdlet.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This cmdlet stops the deployment of the resource group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Boolean
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmResourceGroupDeployment
New-AzureRmResource
New-AzureRmResourceGroup
New-AzureRmResourceGroupDeployment
Remove-AzureRmResourceGroupDeployment
Test-AzureRmResourceGroupDeployment
SYNOPSIS
Cancels a resource group deployment.
SYNTAX
Stop-AzureRmResourceGroupDeployment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-Pre] [-Confirm] [-WhatIf]
[<CommonParameters>]
Stop-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [-Name] <String> [-ApiVersion <String>] [-DefaultProfile
<IAzureContextContainer>] [-Pre] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Stop-AzureRmResourceGroupDeployment cmdlet cancels an Azure resource group deployment that has started but not completed. To stop a
deployment, the deployment must have an incomplete provisioning state, such as Provisioning, and not a completed state, such as Provisioned or
Failed.
An Azure resource is a user-managed entity, such as a website, database, or database server. A resource group is a collection of resources that
are deployed as a unit. To deploy a resource group, use the New-AzureRmResourceGroupDeployment cmdlet.
The New-AzureRmResource cmdlet creates a new resource, but it does not trigger a resource group deployment operation that this cmdlet can stop.
This cmdlet stops only one running deployment.
Use the Name parameter to stop a specific deployment. If you omit the Name parameter, Stop-AzureRmResourceGroupDeployment searches for a running
deployment and stops it. If the cmdlet finds more than one running deployment, the command fails.
PARAMETERS
-ApiVersion <String>
Specifies the API version that is supported by the resource Provider. You can specify a different version than the default version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the resource group deployment to stop.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the resource group deployment to stop.
If you do not specify this parameter, this cmdlet searches for a running deployment in the resource group and stops it. If it finds more than
one running deployment, the command fails. To get the deployment name, use the Get-AzureRmResourceGroupDeployment cmdlet.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group. This cmdlet stops the deployment of the resource group that this parameter specifies.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Boolean
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmResourceGroupDeployment
New-AzureRmResource
New-AzureRmResourceGroup
New-AzureRmResourceGroupDeployment
Remove-AzureRmResourceGroupDeployment
Test-AzureRmResourceGroupDeployment