Skip to content

Commit

Permalink
Updating Remove-ADOWiki.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 9c5e914 commit a496a82
Showing 1 changed file with 116 additions and 0 deletions.
116 changes: 116 additions & 0 deletions docs/Remove-ADOWiki.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@

Remove-ADOWiki
--------------
### Synopsis
Removes Azure DevOps Wikis

---
### Description

Removes Azure DevOps Wikis from a project.

---
### Related Links
* [Add-ADOWiki](Add-ADOWiki.md)
* [Get-ADOWiki](Get-ADOWiki.md)
* [https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/delete](https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/delete)
---
### Examples
#### EXAMPLE 1
```PowerShell
Remove-ADOWiki -Organization MyOrg -Project MyProject
```

---
### 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)|
---
#### **WikiID**

The WikiID.



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

The RepositoryID. If this is the same as the WikiID, it is a ProjectWiki, and the repository will be removed.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |4 |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 |5 |true (ByPropertyName)|
---
#### **ApiVersion**

The api version. By default, 5.1-preview.
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 |6 |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.Collections.Hashtable


---
### Syntax
```PowerShell
Remove-ADOWiki [-Organization] <String> [-Project] <String> [-WikiID] <String> [[-RepositoryID] <String>] [[-Server] <Uri>] [[-ApiVersion] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
---


0 comments on commit a496a82

Please sign in to comment.