SnipeitPS/docs/Remove-SnipeitDepartment.md

125 lines
2.2 KiB
Markdown
Raw Normal View History

2021-06-12 12:30:41 +03:00
---
external help file: SnipeitPS-help.xml
2021-10-27 14:11:27 +03:00
Module Name: SnipeitPS
2021-06-12 12:30:41 +03:00
online version:
schema: 2.0.0
---
# Remove-SnipeitDepartment
## SYNOPSIS
Removes department from Snipe-it asset system
## SYNTAX
```
2021-08-23 18:50:13 +03:00
Remove-SnipeitDepartment [-id] <Int32[]> [[-url] <String>] [[-apiKey] <String>] [-WhatIf] [-Confirm]
2021-06-12 12:30:41 +03:00
[<CommonParameters>]
```
## DESCRIPTION
Removes department or multiple departments from Snipe-it asset system
## EXAMPLES
### EXAMPLE 1
```
2021-08-23 18:50:13 +03:00
Remove-SnipeitDepartment -ID 44
2021-06-12 12:30:41 +03:00
```
### EXAMPLE 2
```
2021-06-14 00:19:47 +03:00
Get-SnipeitDepartment | Where-object {$_.name -like '*head*'} | Remove-SnipeitDepartment
2021-06-12 12:30:41 +03:00
```
## PARAMETERS
2021-08-23 18:50:13 +03:00
### -apiKey
Deprecated parameter, please use Connect-SnipeitPS instead.
User's API Key for Snipeit.
2021-06-12 12:30:41 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-06-12 12:30:41 +03:00
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -id
Unique ID For department to be removed
```yaml
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
2021-08-23 18:50:13 +03:00
### -url
Deprecated parameter, please use Connect-SnipeitPS instead.
URL of Snipeit system.
2021-06-12 12:30:41 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-08-23 18:50:13 +03:00
Required: False
2021-06-12 12:30:41 +03:00
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS