Remove-AzTenantDeployment
Removes a deployment at tenant scope and any associated operations
Syntax
Remove-AzTenantDeployment
[-Name] <String>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzTenantDeployment
-Id <String>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Remove-AzTenantDeployment
-InputObject <PSDeployment>
[-AsJob]
[-PassThru]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Remove-AzTenantDeployment cmdlet removes an Azure deployment at the current tenant scope and any associated operations.
Examples
Example 1: Remove a deployment with a given name
Remove-AzTenantDeployment -Name "RolesDeployment"This command removes the deployment "RolesDeployment" at the current tenant scope.
Example 2: Get a deployment and remove it
Get-AzTenantDeployment -Name "RolesDeployment" | Remove-AzTenantDeploymentThis command gets the deployment "RolesDeployment" at the current tenant scope and removes it.
Parameters
-AsJob
Run cmdlet in the background
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
The fully qualified resource Id of the deployment. example: /providers/Microsoft.Resources/deployments/{deploymentName}
| Type: | String |
| Aliases: | DeploymentId, ResourceId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The deployment object.
| Type: | PSDeployment |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the deployment.
| Type: | String |
| Aliases: | DeploymentName |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
{{ Fill PassThru Description }}
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Pre
When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
