Skip to content

Commit

Permalink
Updating Remove-ADOAreaPath.md
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Jun 7, 2022
1 parent 16a7d48 commit 0812d0a
Showing 1 changed file with 105 additions and 0 deletions.
105 changes: 105 additions & 0 deletions docs/Remove-ADOAreaPath.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@

Remove-ADOAreaPath
------------------
### Synopsis
Removes an Azure DevOps AreaPath.

---
### Description

Removes an Azure DevOps AreaPath. AreaPaths are used to logically group work items within a project.

---
### Related Links
* [Add-ADOAreaPath](Add-ADOAreaPath.md)
* [Get-ADOAreaPath](Get-ADOAreaPath.md)
---
### Examples
#### EXAMPLE 1
```PowerShell
Remove-ADOAreaPath -Organization MyOrg -Project MyProject -AreaPath MyAreaPath
```

---
### Parameters
#### **Organization**

The Organization



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|true |1 |true (ByPropertyName)|
---
#### **Project**

The Project



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|true |2 |true (ByPropertyName)|
---
#### **AreaPath**

The AreaPath



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|true |3 |true (ByPropertyName)|
---
#### **Server**

The server. By default https://dev.azure.com/.
To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs).



|Type |Requried|Postion|PipelineInput |
|-----------|--------|-------|---------------------|
|```[Uri]```|false |4 |true (ByPropertyName)|
---
#### **ApiVersion**

The api version. By default, 5.1.
If targeting TFS, this will need to change to match your server version.
See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[String]```|false |5 |false |
---
#### **WhatIf**
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
-WhatIf is used to see what would happen, or return operations without executing them
#### **Confirm**
-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
-Confirm is used to -Confirm each operation.

If you pass ```-Confirm:$false``` you will not be prompted.


If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed.

---
### Outputs
System.Nullable


System.Management.Automation.PSObject


---
### Syntax
```PowerShell
Remove-ADOAreaPath [-Organization] <String> [-Project] <String> [-AreaPath] <String> [[-Server] <Uri>] [[-ApiVersion] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
---


0 comments on commit 0812d0a

Please sign in to comment.