├── AtwsSOAP ├── obj │ ├── Debug │ │ └── netcoreapp3.1 │ │ │ ├── AtwsSOAP.AssemblyInfoInputs.cache │ │ │ ├── AtwsSOAP.csproj.AssemblyReference.cache │ │ │ └── AtwsSOAP.AssemblyInfo.cs │ ├── AtwsSOAP.csproj.nuget.cache │ ├── AtwsSOAP.csproj.nuget.g.targets │ ├── AtwsSOAP.csproj.nuget.g.props │ ├── project.nuget.cache │ └── AtwsSOAP.csproj.nuget.dgspec.json ├── .vs │ └── AtwsSOAP │ │ ├── v16 │ │ └── .suo │ │ └── DesignTimeBuild │ │ └── .dtbcache.v2 ├── Program.cs ├── AtwsSOAP.csproj ├── Autotask │ └── dotnet-svcutil.params.json └── Missing properties on EntityInfo.patch ├── .gitignore ├── Scripts ├── Sync-ExternalHelp.ps1 └── DebugModule.ps1 ├── LICENSE.md ├── Docs ├── Get-AtwsWsdlVersion.md ├── How to connect on Azure.md ├── Get-AtwsThresholdAndUsageInfo.md ├── How to make changes to entities.md ├── How to create new entities.md ├── How to delete entities.md ├── Update-AtwsRamCache.md ├── Get-AtwsConnectionObject.md ├── Build-AtwsModule.md ├── Get-AtwsModuleConfiguration.md ├── Uninstall-AtwsOldModuleVersion.md ├── Update-AtwsFunctions.md ├── Remove-AtwsTag.md ├── Save-AtwsModuleConfiguration.md ├── Remove-AtwsTagAlias.md ├── Remove-AtwsContact.md ├── Remove-AtwsHoliday.md ├── Remove-AtwsTagGroup.md ├── Remove-AtwsModuleConfiguration.md ├── Remove-AtwsAccountTeam.md ├── Remove-AtwsQuoteItem.md ├── Remove-AtwsTimeEntry.md ├── Remove-AtwsActionType.md ├── Remove-AtwsHolidaySet.md ├── Remove-AtwsTicketCost.md ├── Remove-AtwsAccountToDo.md ├── Remove-AtwsAppointment.md ├── Remove-AtwsProductTier.md ├── Remove-AtwsProjectCost.md ├── Remove-AtwsServiceCall.md ├── Remove-AtwsContactGroup.md ├── Remove-AtwsContractCost.md ├── Remove-AtwsSubscription.md ├── about_Autotask.md ├── Remove-AtwsServiceBundle.md ├── Remove-AtwsServiceCallTask.md ├── Remove-AtwsAccountWebhook.md ├── Remove-AtwsContactWebhook.md ├── Remove-AtwsChangeRequestLink.md ├── Remove-AtwsServiceCallTicket.md ├── Remove-AtwsChangeOrderCost.md ├── Remove-AtwsTaskPredecessor.md ├── Remove-AtwsTicketRmaCredit.md ├── Remove-AtwsWebhookEventErrorLog.md ├── Remove-AtwsChecklistLibrary.md ├── Remove-AtwsContactGroupContact.md ├── Remove-AtwsComanagedAssociation.md ├── Remove-AtwsServiceBundleService.md ├── Remove-AtwsTicketTagAssociation.md ├── Remove-AtwsAccountWebhookField.md ├── Remove-AtwsContactWebhookField.md ├── Remove-AtwsContractBillingRule.md ├── Remove-AtwsContractExclusionRole.md ├── Remove-AtwsTaskSecondaryResource.md ├── Remove-AtwsTicketChecklistItem.md ├── Remove-AtwsContractExclusionSet.md ├── Remove-AtwsInstalledProductType.md ├── Remove-AtwsServiceCallTaskResource.md ├── Remove-AtwsTicketAdditionalContact.md └── Remove-AtwsTicketSecondaryResource.md ├── Autotask ├── Private │ ├── Get-Copyright.ps1 │ ├── Convert-AtwsFunctionToText.ps1 │ ├── Write-AtwsProgress.ps1 │ ├── ConvertTo-AtwsDate.ps1 │ └── Remove-AtwsDefinition.ps1 ├── Public │ ├── Get-AtwsWsdlVersion.ps1 │ ├── Build-AtwsModule.ps1 │ └── Get-AtwsConnectionObject.ps1 └── en-US │ └── about_Autotask.help.txt ├── Tests └── Private │ └── ConvertTo-AtwsDate.Tests.ps1 └── about_module.md /AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.AssemblyInfoInputs.cache: -------------------------------------------------------------------------------- 1 | a7e0a7ab9c8dcc431abe1fab55cc3b779d991881 2 | -------------------------------------------------------------------------------- /AtwsSOAP/.vs/AtwsSOAP/v16/.suo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ecitsolutions/Autotask/HEAD/AtwsSOAP/.vs/AtwsSOAP/v16/.suo -------------------------------------------------------------------------------- /AtwsSOAP/.vs/AtwsSOAP/DesignTimeBuild/.dtbcache.v2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ecitsolutions/Autotask/HEAD/AtwsSOAP/.vs/AtwsSOAP/DesignTimeBuild/.dtbcache.v2 -------------------------------------------------------------------------------- /AtwsSOAP/obj/AtwsSOAP.csproj.nuget.cache: -------------------------------------------------------------------------------- 1 | { 2 | "version": 1, 3 | "dgSpecHash": "8lgGQ55c0f/nxQG421ry7txnQMz8N34T5Wq/vfB6Hmh2Y+xgLPPxCkw+ert9seMbz80at01F4KDeM42ZHCsZgw==", 4 | "success": true 5 | } -------------------------------------------------------------------------------- /AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.csproj.AssemblyReference.cache: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ecitsolutions/Autotask/HEAD/AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.csproj.AssemblyReference.cache -------------------------------------------------------------------------------- /AtwsSOAP/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | 3 | namespace AtwsSOAP 4 | { 5 | class Program 6 | { 7 | static void Main(string[] args) 8 | { 9 | 10 | } 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /AtwsSOAP/obj/AtwsSOAP.csproj.nuget.g.targets: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | $(MSBuildAllProjects);$(MSBuildThisFileFullPath) 5 | 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode/* 2 | !.vscode/settings.json 3 | !.vscode/tasks.json 4 | !.vscode/launch.json 5 | !.vscode/extensions.json 6 | .DS_Store 7 | AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.csprojAssemblyReference.cache 8 | AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.assets.cache 9 | .gitignore 10 | AtwsSOAP/obj/Debug/netcoreapp3.1/.NETCoreApp,Version=v3.1.AssemblyAttributes.cs -------------------------------------------------------------------------------- /AtwsSOAP/AtwsSOAP.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp3.1 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /Scripts/Sync-ExternalHelp.ps1: -------------------------------------------------------------------------------- 1 | #requires -modules platyps 2 | # Copyright (c) 2021 klemmestad 3 | # 4 | # This software is released under the MIT License. 5 | # 6 | # https://github.com/karamem0/SPClientCore/blob/master/LICENSE 7 | # 8 | 9 | $modulePath = join-path -Path $PSScriptRoot -ChildPath '..' -AdditionalChildPath 'Autotask' 10 | $docPath = Join-Path -Path $PSScriptRoot -ChildPath '..' -AdditionalChildPath 'docs' 11 | $extHelpPath = Join-Path -Path $modulePath -ChildPath 'en-US' 12 | 13 | import-module $modulePath -force 14 | 15 | Update-MarkdownHelpModule -Path $docPath 16 | #Update-ExternalHelp -Path $docPath -OutputPath $extHelpPath 17 | 18 | -------------------------------------------------------------------------------- /AtwsSOAP/Autotask/dotnet-svcutil.params.json: -------------------------------------------------------------------------------- 1 | { 2 | "providerId": "Microsoft.Tools.ServiceModel.Svcutil", 3 | "version": "2.0.2", 4 | "options": { 5 | "inputs": [ 6 | "https://webservices2.Autotask.net/atservices/1.6/atws.wsdl" 7 | ], 8 | "namespaceMappings": [ 9 | "*, Autotask" 10 | ], 11 | "outputFile": "Reference.cs", 12 | "references": [ 13 | "System.Reflection.DispatchProxy, {System.Reflection.DispatchProxy, 4.7.1}", 14 | "System.Security.AccessControl, {System.Security.AccessControl, 4.7.0}", 15 | "System.Security.Cryptography.Xml, {System.Security.Cryptography.Xml, 4.7.0}", 16 | "System.Security.Permissions, {System.Security.Permissions, 4.7.0}", 17 | "System.Security.Principal.Windows, {System.Security.Principal.Windows, 4.7.0}", 18 | "System.Windows.Extensions, {System.Windows.Extensions, 4.7.0}" 19 | ], 20 | "sync": true, 21 | "targetFramework": "netcoreapp3.1", 22 | "typeReuseMode": "All" 23 | } 24 | } -------------------------------------------------------------------------------- /AtwsSOAP/obj/Debug/netcoreapp3.1/AtwsSOAP.AssemblyInfo.cs: -------------------------------------------------------------------------------- 1 | //------------------------------------------------------------------------------ 2 | // 3 | // This code was generated by a tool. 4 | // Runtime Version:4.0.30319.42000 5 | // 6 | // Changes to this file may cause incorrect behavior and will be lost if 7 | // the code is regenerated. 8 | // 9 | //------------------------------------------------------------------------------ 10 | 11 | using System; 12 | using System.Reflection; 13 | 14 | [assembly: System.Reflection.AssemblyCompanyAttribute("AtwsSOAP")] 15 | [assembly: System.Reflection.AssemblyConfigurationAttribute("Debug")] 16 | [assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0.0")] 17 | [assembly: System.Reflection.AssemblyInformationalVersionAttribute("1.0.0")] 18 | [assembly: System.Reflection.AssemblyProductAttribute("AtwsSOAP")] 19 | [assembly: System.Reflection.AssemblyTitleAttribute("AtwsSOAP")] 20 | [assembly: System.Reflection.AssemblyVersionAttribute("1.0.0.0")] 21 | 22 | // Generated by the MSBuild WriteCodeFragment class. 23 | 24 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | # MIT License 2 | 3 | **Copyright (c) 2018 Hugo Klemmestad** 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /Docs/Get-AtwsWsdlVersion.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Get-AtwsWsdlVersion 9 | 10 | ## SYNOPSIS 11 | This function gets the current API version from the Autotask servers. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Get-AtwsWsdlVersion [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | The function calls GetWsdlVersion() and returns the result. 21 | 22 | ## EXAMPLES 23 | 24 | ### EXAMPLE 1 25 | ``` 26 | Get-AtwsWsdlVersion 27 | gets the current API version from the Autotask servers. 28 | ``` 29 | 30 | ## PARAMETERS 31 | 32 | ### CommonParameters 33 | 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). 34 | 35 | ## INPUTS 36 | 37 | ### Nothing. 38 | ## OUTPUTS 39 | 40 | ### ATWSResponse 41 | ## NOTES 42 | NAME: Get-AtwsWsdlVersion 43 | 44 | ## RELATED LINKS 45 | -------------------------------------------------------------------------------- /Autotask/Private/Get-Copyright.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .COPYRIGHT 3 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 4 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 5 | #> 6 | Function Get-Copyright { 7 | <# 8 | .SYNOPSIS 9 | This function returns the copyright text for the module. 10 | .DESCRIPTION 11 | This function returns the copyright text for the module. 12 | .INPUTS 13 | Nothing. 14 | .OUTPUTS 15 | Text. 16 | .EXAMPLE 17 | Get-Copyright 18 | Returns the copyright text for the module. 19 | .NOTES 20 | NAME: Get-Copyright 21 | 22 | #> 23 | [CmdletBinding()] 24 | Param() 25 | Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 26 | 27 | # Copyright text as here-string 28 | @" 29 | <# 30 | .COPYRIGHT 31 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 32 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 33 | #> 34 | "@ 35 | } -------------------------------------------------------------------------------- /Docs/How to connect on Azure.md: -------------------------------------------------------------------------------- 1 | # How to connect on Azure 2 | 3 | To connect to the Autotask API on Azure you need the **username and password of type API user** and an **API security key** stored as resources. The `Connect-AtwsWebApi` cmdlet will check if it is running on Azure and look for resources by name if it is. You do not need to connect explicitly. As all other functions will call `Connect-AtwsWebApi` automatically if they aren't already connected you can just use the module as you would any other PowerShell module. Import it and use it. 4 | 5 | ## Azure Automation - Runbooks 6 | 7 | If you are using the module from an Azure PowerShell runbook you should add the following resources to your automation account: 8 | 9 | * `AtwsDefaultCredential [credential]` - Your Autotask API user stored as a credential object 10 | * `AtwsDefaultSecureIdentifier [string]` - The cleartext tracking identifier from your Autotask API user 11 | 12 | ## Azure Functions 13 | 14 | To connect automatically from an Azure Function you need to create 3 environment variables: 15 | 16 | * `AtwsUsername [string]` - the username for your Autotask API user 17 | * `AtwsPassword [string]` - the cleartext password for your Autotask API user 18 | * `AtwsTrackingIdentifier [string]` - the cleartext tracking identifier from your Autotask API user 19 | -------------------------------------------------------------------------------- /AtwsSOAP/obj/AtwsSOAP.csproj.nuget.g.props: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | True 5 | NuGet 6 | $(MSBuildThisFileDirectory)project.assets.json 7 | $(UserProfile)\.nuget\packages\ 8 | C:\Users\bjorn\.nuget\packages\ 9 | PackageReference 10 | 5.10.0 11 | 12 | 13 | 14 | 15 | 16 | $(MSBuildAllProjects);$(MSBuildThisFileFullPath) 17 | 18 | -------------------------------------------------------------------------------- /Docs/Get-AtwsThresholdAndUsageInfo.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Get-AtwsThresholdAndUsageInfo 9 | 10 | ## SYNOPSIS 11 | This function collects information about a specific Autotask invoice object and returns a generic 12 | powershell object with all relevant information as a starting point for import into other systems. 13 | 14 | ## SYNTAX 15 | 16 | ``` 17 | Get-AtwsThresholdAndUsageInfo [] 18 | ``` 19 | 20 | ## DESCRIPTION 21 | The function accepts an invoice object or an invoice id and makes a special API call to get a 22 | complete invoice description, including billingitems. 23 | For some types of billingitems additional 24 | information may be collected. 25 | All information is collected and stored in a PSObject which is 26 | returned. 27 | 28 | ## EXAMPLES 29 | 30 | ### EXAMPLE 1 31 | ``` 32 | Get-AtwsThresholdAndUsageInfo 33 | ``` 34 | 35 | ## PARAMETERS 36 | 37 | ### CommonParameters 38 | 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). 39 | 40 | ## INPUTS 41 | 42 | ### Nothing 43 | ## OUTPUTS 44 | 45 | ### [String] 46 | ## NOTES 47 | 48 | ## RELATED LINKS 49 | -------------------------------------------------------------------------------- /Docs/How to make changes to entities.md: -------------------------------------------------------------------------------- 1 | # How to make changes to entities 2 | 3 | For all entities in the Autotask that supports being changed through the Web Services API, our module creates *Set-* functions. All *Set* functions expects you to pass any objects you want modified through the pipeline or by using the *-InputObject* parameter. So to modify existing entities in Autotask you first have [*Get* them][1]. 4 | 5 | ```powershell 6 | $EndDate = Get-Date 31-12-2018 7 | $NewEndDate = $EndDate.AddYears(1) 8 | 9 | $Contracts = Get-AtwsContract -ContractType 'Recurring Service' -EndDate $EndDate 10 | 11 | # Method 1 12 | $Contracts | Set-AtwsContract -EndDate $NewEndDate 13 | 14 | # Method 2 15 | Set-AtwsContract -InputObject $Contracts -EndDate $NewEndDate 16 | 17 | # Method 3 - A one-liner 18 | Get-AtwsContract -ContractType 'Recurring Service' -EndDate $EndDate | Set-AtwsContract -EndDate $NewEndDate 19 | ``` 20 | 21 | The example demonstrates how you can use PowerShell to extend Recurring Service contracts by a year. As you can see, modifying objects is very easy. All the work is in making sure you get the right objects from Autotask in the first place. A *Set* function happily modifies any object you pass to it, as long as it is an object of the right type. *Set-AtwsContract* can only modify contracts. It you try to pass it an object of a different type it will throw an exception. So make sure you [write your queries right][1], because the Autotask Web API does **not** support undo... 22 | 23 | [1]: https://github.com/officecenter/Autotask/blob/master/Docs/How%20to%20Query.md 24 | -------------------------------------------------------------------------------- /Docs/How to create new entities.md: -------------------------------------------------------------------------------- 1 | # New Entities 2 | 3 | For every entity in the Autotask that support being created through the API there are created a *New-* function. All New functions support 2 methods for creating new objects: *By parameters* and *by object*. Choose whichever method that suits your coding style, or switch between them as needs dictate. 4 | 5 | ```powershell 6 | $Account = Get-AtwsAccount -Name 'Hugo Klemmestad' 7 | $Duedate = (Get-Date).AddDays(8) 8 | $Title = 'Testing the API on a ticket' 9 | 10 | # Method 1 11 | $Ticket = New-AtwsTicket -AccountID $Account.id -DueDateTime $Duedate -Priority Medium -Status New -Title $Title -QueueID 'Queue Name' 12 | 13 | # Method 2 14 | $Ticket = New-Object Autotask.Ticket 15 | $Ticket.AccountId = $Account.id 16 | $Ticket.DueDateTime = $Duedate 17 | $Ticket.Priority = 'Medium' 18 | $Ticket.Status = 'New' 19 | $Ticket.Title = $Title 20 | 21 | $NewTicket = New-AtwsTicket -InputObject $Ticket 22 | 23 | # Or 24 | 25 | $NewTicket = $Ticket | New-AtwsTicket 26 | ``` 27 | 28 | ## Method 1: Create by parameters 29 | 30 | When you create a new object by specifying parameters you can create a single object at a time. All parameters support **IntelliSense** and performs parameter validation before creating an object immediately through the API. The new object is always returned as output. 31 | 32 | ## Method 2: Create by object 33 | 34 | Any Autotask entity can be created as an object through *New-Object*. The namespace is *Autotask* and supports **IntelliSense**. Using objects you can prepare multiple objects offline and pass them all to the entity's *New* function to create a batch of objects in one go. 35 | -------------------------------------------------------------------------------- /Docs/How to delete entities.md: -------------------------------------------------------------------------------- 1 | # Deleting entities 2 | 3 | Not all entities in Autotask supports being deleted through the API. We are not sure why, but there is nothing we can do about it. For all entities that do support deletion, our module creates a *Remove-* function. The *Remove* functions all work the same. You pass them an object - or the Id of an object - and the function deletes the object from Autotask. Again, without any support for undo. Remember, if you delete an object you shouldn't have, but still have the object in a variable in PowerShell, then you may try to re-create it. But the object you create will be a new object with a new Id. so any existing objects in Autotask that refers to the old object you deleted will not point to the new one. 4 | 5 | ## These are the *Remove* functions that are supported by the API 6 | 7 | ```powershell 8 | Remove-AtwsAccountTeam 9 | Remove-AtwsAccountToDo 10 | Remove-AtwsActionType 11 | Remove-AtwsAppointment 12 | Remove-AtwsChangeRequestLink 13 | Remove-AtwsContractCost 14 | Remove-AtwsContractExclusionAllocationCode 15 | Remove-AtwsContractExclusionRole 16 | Remove-AtwsInstalledProductType 17 | Remove-AtwsInstalledProductTypeUdfAssociation 18 | Remove-AtwsProjectCost 19 | Remove-AtwsQuoteItem 20 | Remove-AtwsServiceBundle 21 | Remove-AtwsServiceBundleService 22 | Remove-AtwsServiceCall 23 | Remove-AtwsServiceCallTask 24 | Remove-AtwsServiceCallTaskResource 25 | Remove-AtwsServiceCallTicket 26 | Remove-AtwsServiceCallTicketResource 27 | Remove-AtwsSubscription 28 | Remove-AtwsTaskPredecessor 29 | Remove-AtwsTaskSecondaryResource 30 | Remove-AtwsTicketAdditionalContact 31 | Remove-AtwsTicketChangeRequestApproval 32 | Remove-AtwsTicketCost 33 | Remove-AtwsTicketSecondaryResource 34 | ``` -------------------------------------------------------------------------------- /Docs/Update-AtwsRamCache.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Update-AtwsRamCache 9 | 10 | ## SYNOPSIS 11 | This function reads all entities with detailed fieldinfo and writes everything to disk. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Update-AtwsRamCache [-WhatIf] [-Confirm] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | This function reads all entities with detailed fieldinfo and writes everything to disk. 21 | 22 | ## EXAMPLES 23 | 24 | ### EXAMPLE 1 25 | ``` 26 | Update-AtwsDiskCache 27 | Gets all valid built-in fields and user defined fields for the Account entity. 28 | ``` 29 | 30 | ## PARAMETERS 31 | 32 | ### -WhatIf 33 | Shows what would happen if the cmdlet runs. 34 | The cmdlet is not run. 35 | 36 | ```yaml 37 | Type: SwitchParameter 38 | Parameter Sets: (All) 39 | Aliases: wi 40 | 41 | Required: False 42 | Position: Named 43 | Default value: None 44 | Accept pipeline input: False 45 | Accept wildcard characters: False 46 | ``` 47 | 48 | ### -Confirm 49 | Prompts you for confirmation before running the cmdlet. 50 | 51 | ```yaml 52 | Type: SwitchParameter 53 | Parameter Sets: (All) 54 | Aliases: cf 55 | 56 | Required: False 57 | Position: Named 58 | Default value: None 59 | Accept pipeline input: False 60 | Accept wildcard characters: False 61 | ``` 62 | 63 | ### CommonParameters 64 | 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). 65 | 66 | ## INPUTS 67 | 68 | ### None. 69 | ## OUTPUTS 70 | 71 | ### Nothing (writes data to disk) 72 | ## NOTES 73 | 74 | ## RELATED LINKS 75 | -------------------------------------------------------------------------------- /Docs/Get-AtwsConnectionObject.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Get-AtwsConnectionObject 9 | 10 | ## SYNOPSIS 11 | This function returns a SOAPClient Object with the active connection to Autotask Web Api from the current namespace. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Get-AtwsConnectionObject [-WhatIf] [-Confirm] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | This function returns a SOAPClient Object with the active connection to Autotask Web API from the current namespace. 21 | Advanced users may use this object for direct access to API methods or hardcoded queries. 22 | It may also be useful for 23 | debugging. 24 | 25 | ## EXAMPLES 26 | 27 | ### EXAMPLE 1 28 | ``` 29 | $Atws = Get-AtwsConnectionObject 30 | Gets a SOAPClient Object with the active connection to Autotask Web Api from the current namespace. 31 | ``` 32 | 33 | ## PARAMETERS 34 | 35 | ### -WhatIf 36 | Shows what would happen if the cmdlet runs. 37 | The cmdlet is not run. 38 | 39 | ```yaml 40 | Type: SwitchParameter 41 | Parameter Sets: (All) 42 | Aliases: wi 43 | 44 | Required: False 45 | Position: Named 46 | Default value: None 47 | Accept pipeline input: False 48 | Accept wildcard characters: False 49 | ``` 50 | 51 | ### -Confirm 52 | Prompts you for confirmation before running the cmdlet. 53 | 54 | ```yaml 55 | Type: SwitchParameter 56 | Parameter Sets: (All) 57 | Aliases: cf 58 | 59 | Required: False 60 | Position: Named 61 | Default value: None 62 | Accept pipeline input: False 63 | Accept wildcard characters: False 64 | ``` 65 | 66 | ### CommonParameters 67 | 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). 68 | 69 | ## INPUTS 70 | 71 | ### Nothing. 72 | ## OUTPUTS 73 | 74 | ### [Autotask.SOAPClient] 75 | ## NOTES 76 | NAME: Get-AtwsConnectionObject 77 | 78 | ## RELATED LINKS 79 | -------------------------------------------------------------------------------- /Docs/Build-AtwsModule.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Build-AtwsModule 9 | 10 | ## SYNOPSIS 11 | This function rebuilds the module based on updated info form the Autotask API 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Build-AtwsModule [-Force] [-WhatIf] [-Confirm] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | This functions first verifies that you have write permissions to the module directory, 21 | then proceeds with refreshing the entity cache from online data and rebuilds all 22 | entity functions based on the updated entity cache. 23 | 24 | ## EXAMPLES 25 | 26 | ### EXAMPLE 1 27 | ``` 28 | Build-AtwsModule 29 | ``` 30 | 31 | ## PARAMETERS 32 | 33 | ### -Force 34 | {{ Fill Force Description }} 35 | 36 | ```yaml 37 | Type: SwitchParameter 38 | Parameter Sets: (All) 39 | Aliases: 40 | 41 | Required: False 42 | Position: Named 43 | Default value: False 44 | Accept pipeline input: False 45 | Accept wildcard characters: False 46 | ``` 47 | 48 | ### -WhatIf 49 | Shows what would happen if the cmdlet runs. 50 | The cmdlet is not run. 51 | 52 | ```yaml 53 | Type: SwitchParameter 54 | Parameter Sets: (All) 55 | Aliases: wi 56 | 57 | Required: False 58 | Position: Named 59 | Default value: None 60 | Accept pipeline input: False 61 | Accept wildcard characters: False 62 | ``` 63 | 64 | ### -Confirm 65 | Prompts you for confirmation before running the cmdlet. 66 | 67 | ```yaml 68 | Type: SwitchParameter 69 | Parameter Sets: (All) 70 | Aliases: cf 71 | 72 | Required: False 73 | Position: Named 74 | Default value: None 75 | Accept pipeline input: False 76 | Accept wildcard characters: False 77 | ``` 78 | 79 | ### CommonParameters 80 | 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). 81 | 82 | ## INPUTS 83 | 84 | ### Nothing. 85 | ## OUTPUTS 86 | 87 | ### Script files in module directory. 88 | ## NOTES 89 | NAME: Build-AtwsModule 90 | 91 | ## RELATED LINKS 92 | -------------------------------------------------------------------------------- /Autotask/Private/Convert-AtwsFunctionToText.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | 3 | .COPYRIGHT 4 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 5 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 6 | 7 | #> 8 | Function Convert-AtwsFunctionToText { 9 | <# 10 | .SYNOPSIS 11 | This function generates a scriptblock as text from a custom, structured object created 12 | by other functions in this module 13 | .DESCRIPTION 14 | This function assembles the various parts of a function into a single text scriptblock. 15 | It is not generic. It is internal to this module. 16 | .INPUTS 17 | [PSObject] 18 | .OUTPUTS 19 | [String] 20 | #> 21 | [CmdLetBinding()] 22 | Param 23 | ( 24 | [Parameter(Mandatory = $true)] 25 | [PSObject] 26 | $AtwsFunction 27 | ) 28 | 29 | begin { 30 | 31 | # Enable modern -Debug behavior 32 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } 33 | 34 | Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 35 | 36 | # Value to insert in #Requires tag on top of every script file 37 | $requiredVersion = '5.0' 38 | 39 | # The textframe with placeholders for all dynamic elements 40 | $textFrame = "#Requires -Version {0}`n{1}`nFunction {2}`n{{`n{3}`n [CmdLetBinding(SupportsShouldProcess = `$true, DefaultParameterSetName='{4}', ConfirmImpact='{5}',`n HelpURI='https://github.com/ecitsolutions/Autotask/blob/master/Docs/{2}.md')]`n Param`n (`n{6}`n )`n{7}`n}}" 41 | } 42 | 43 | process { 44 | # Generate the function text from $textframe with all placeholders replaced with the correct variable 45 | $functionText = $textFrame -F 46 | $requiredVersion, 47 | $AtwsFunction.Copyright, 48 | $AtwsFunction.FunctionName, 49 | $AtwsFunction.HelpText, 50 | $AtwsFunction.DefaultParameterSetName, 51 | $AtwsFunction.ConfirmImpact, 52 | $($AtwsFunction.Parameters -join ",`n`n"), 53 | $AtwsFunction.Definition 54 | } 55 | 56 | end { 57 | # return the function text 58 | Return $functionText 59 | } 60 | 61 | } 62 | -------------------------------------------------------------------------------- /Autotask/Public/Get-AtwsWsdlVersion.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .COPYRIGHT 3 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 4 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 5 | #> 6 | 7 | Function Get-AtwsWsdlVersion { 8 | <# 9 | .SYNOPSIS 10 | This function gets the current API version from the Autotask servers. 11 | .DESCRIPTION 12 | The function calls GetWsdlVersion() and returns the result. 13 | .INPUTS 14 | Nothing. 15 | .OUTPUTS 16 | ATWSResponse 17 | .EXAMPLE 18 | Get-AtwsWsdlVersion 19 | gets the current API version from the Autotask servers. 20 | 21 | .NOTES 22 | NAME: Get-AtwsWsdlVersion 23 | 24 | #> 25 | 26 | [cmdletbinding()] 27 | Param 28 | ( 29 | ) 30 | 31 | begin { 32 | # Enable modern -Debug behavior 33 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } 34 | 35 | Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 36 | 37 | if (-not($Script:Atws.integrationsValue)) { 38 | # Not connected. Try to connect, prompt for credentials if necessary 39 | Write-Verbose ('{0}: Not connected. Calling Connect-AtwsWebApi without parameters for possible autoload of default connection profile.' -F $MyInvocation.MyCommand.Name) 40 | Connect-AtwsWebAPI 41 | } 42 | } 43 | 44 | process { 45 | try { 46 | Write-Verbose ('{0}: Calling GetWsdlVersion()' -F $MyInvocation.MyCommand.Name) 47 | 48 | $result = $Script:Atws.GetWsdlVersion($Script:Atws.IntegrationsValue) 49 | } 50 | catch { 51 | throw (New-Object System.Net.WebException ('{0}: FAILED on GetWsdlVersion($Script:Atws.IntegrationsValue). No data returned.' -F $MyInvocation.MyCommand.Name)) 52 | Return 53 | } 54 | 55 | # Handle any errors 56 | if ($result.Errors.Count -gt 0) { 57 | foreach ($AtwsError in $result.Errors) { 58 | Write-Error $AtwsError.Message 59 | } 60 | Return 61 | } 62 | } 63 | 64 | 65 | end { 66 | Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 67 | 68 | Return $result 69 | } 70 | } -------------------------------------------------------------------------------- /AtwsSOAP/obj/project.nuget.cache: -------------------------------------------------------------------------------- 1 | { 2 | "version": 2, 3 | "dgSpecHash": "Aijt+4qyFBgMgvsouypz1Gvg2ips+pUxeucvVxVkF82c6tWtIEYHnt0fR8ZH3ZU4Ct/LZKoS3QSmQmNwmqE2NA==", 4 | "success": true, 5 | "projectFilePath": "C:\\Git\\Autotask\\AtwsSOAP\\AtwsSOAP.csproj", 6 | "expectedPackageFiles": [ 7 | "C:\\Users\\bjorn\\.nuget\\packages\\microsoft.netcore.platforms\\3.1.0\\microsoft.netcore.platforms.3.1.0.nupkg.sha512", 8 | "C:\\Users\\bjorn\\.nuget\\packages\\microsoft.win32.systemevents\\4.7.0\\microsoft.win32.systemevents.4.7.0.nupkg.sha512", 9 | "C:\\Users\\bjorn\\.nuget\\packages\\system.drawing.common\\4.7.0\\system.drawing.common.4.7.0.nupkg.sha512", 10 | "C:\\Users\\bjorn\\.nuget\\packages\\system.numerics.vectors\\4.5.0\\system.numerics.vectors.4.5.0.nupkg.sha512", 11 | "C:\\Users\\bjorn\\.nuget\\packages\\system.private.servicemodel\\4.8.1\\system.private.servicemodel.4.8.1.nupkg.sha512", 12 | "C:\\Users\\bjorn\\.nuget\\packages\\system.reflection.dispatchproxy\\4.7.1\\system.reflection.dispatchproxy.4.7.1.nupkg.sha512", 13 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.accesscontrol\\4.7.0\\system.security.accesscontrol.4.7.0.nupkg.sha512", 14 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.cryptography.cng\\4.7.0\\system.security.cryptography.cng.4.7.0.nupkg.sha512", 15 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.cryptography.pkcs\\4.7.0\\system.security.cryptography.pkcs.4.7.0.nupkg.sha512", 16 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.cryptography.xml\\4.7.0\\system.security.cryptography.xml.4.7.0.nupkg.sha512", 17 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.permissions\\4.7.0\\system.security.permissions.4.7.0.nupkg.sha512", 18 | "C:\\Users\\bjorn\\.nuget\\packages\\system.security.principal.windows\\4.7.0\\system.security.principal.windows.4.7.0.nupkg.sha512", 19 | "C:\\Users\\bjorn\\.nuget\\packages\\system.servicemodel.duplex\\4.8.1\\system.servicemodel.duplex.4.8.1.nupkg.sha512", 20 | "C:\\Users\\bjorn\\.nuget\\packages\\system.servicemodel.http\\4.8.1\\system.servicemodel.http.4.8.1.nupkg.sha512", 21 | "C:\\Users\\bjorn\\.nuget\\packages\\system.servicemodel.nettcp\\4.8.1\\system.servicemodel.nettcp.4.8.1.nupkg.sha512", 22 | "C:\\Users\\bjorn\\.nuget\\packages\\system.servicemodel.primitives\\4.8.1\\system.servicemodel.primitives.4.8.1.nupkg.sha512", 23 | "C:\\Users\\bjorn\\.nuget\\packages\\system.servicemodel.security\\4.8.1\\system.servicemodel.security.4.8.1.nupkg.sha512", 24 | "C:\\Users\\bjorn\\.nuget\\packages\\system.windows.extensions\\4.7.0\\system.windows.extensions.4.7.0.nupkg.sha512" 25 | ], 26 | "logs": [] 27 | } -------------------------------------------------------------------------------- /Autotask/Public/Build-AtwsModule.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .COPYRIGHT 3 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 4 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 5 | 6 | #> 7 | Function Build-AtwsModule { 8 | <# 9 | .SYNOPSIS 10 | This function rebuilds the module based on updated info form the Autotask API 11 | .DESCRIPTION 12 | This functions first verifies that you have write permissions to the module directory, 13 | then proceeds with refreshing the entity cache from online data and rebuilds all 14 | entity functions based on the updated entity cache. 15 | .INPUTS 16 | Nothing. 17 | .OUTPUTS 18 | Script files in module directory. 19 | .EXAMPLE 20 | Build-AtwsModule 21 | .NOTES 22 | NAME: Build-AtwsModule 23 | #> 24 | 25 | [CmdLetBinding( 26 | SupportsShouldProcess = $true, 27 | ConfirmImpact = 'High' 28 | )] 29 | 30 | Param( 31 | [switch] 32 | $Force 33 | ) 34 | 35 | begin { 36 | # Enable modern -Debug behavior 37 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } 38 | 39 | Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 40 | 41 | if (-not($Script:Atws.integrationsValue)) { 42 | # Not connected. Try to connect, prompt for credentials if necessary 43 | Write-Verbose ('{0}: Not connected. Calling Connect-AtwsWebApi without parameters for possible autoload of default connection profile.' -F $MyInvocation.MyCommand.Name) 44 | Connect-AtwsWebAPI 45 | } 46 | 47 | if ($Force.IsPresent -and -not $Confirm) { 48 | $ConfirmPreference = 'none' 49 | } 50 | 51 | } 52 | 53 | process { 54 | 55 | 56 | $RootPath = $MyInvocation.MyCommand.Module.ModuleBase 57 | $manifest = Join-Path $RootPath -ChildPath 'Autotask.psd1' 58 | 59 | Try { [io.file]::OpenWrite($manifest).close() } 60 | Catch { 61 | Write-Warning "You do not have write access to the directory $RootPath" 62 | return 63 | } 64 | 65 | # Rebuild ramcache 66 | Update-AtwsRamCache 67 | 68 | # Rebuild all functions 69 | Update-AtwsFunctions 70 | 71 | } # Process 72 | end { 73 | Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /Docs/Get-AtwsModuleConfiguration.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Get-AtwsModuleConfiguration 9 | 10 | ## SYNOPSIS 11 | This function loads from disk the internal configuration object that stores all module options. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Get-AtwsModuleConfiguration [[-Path] ] [[-Name] ] [-All] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | This function loads from disk the internal configuration object that stores all module options. 21 | The default path is the current PowerShell configuration directory, 22 | 23 | ## EXAMPLES 24 | 25 | ### EXAMPLE 1 26 | ``` 27 | Get-AtwsModuleConfiguration 28 | ``` 29 | 30 | ### EXAMPLE 2 31 | ``` 32 | Get-AtwsModuleConfiguration -Name Sandbox 33 | ``` 34 | 35 | ### EXAMPLE 3 36 | ``` 37 | Get-AtwsModuleConfiguration -Path AtwsConfig.clixml 38 | ``` 39 | 40 | ## PARAMETERS 41 | 42 | ### -Path 43 | {{ Fill Path Description }} 44 | 45 | ```yaml 46 | Type: FileInfo 47 | Parameter Sets: (All) 48 | Aliases: ProfilePath 49 | 50 | Required: False 51 | Position: 2 52 | Default value: $(Join-Path -Path $Global:AtwsModuleConfigurationPath -ChildPath AtwsConfig.clixml) 53 | Accept pipeline input: False 54 | Accept wildcard characters: False 55 | ``` 56 | 57 | ### -Name 58 | {{ Fill Name Description }} 59 | 60 | ```yaml 61 | Type: String 62 | Parameter Sets: (All) 63 | Aliases: ProfileName 64 | 65 | Required: False 66 | Position: 1 67 | Default value: Default 68 | Accept pipeline input: False 69 | Accept wildcard characters: False 70 | ``` 71 | 72 | ### -All 73 | {{ Fill All Description }} 74 | 75 | ```yaml 76 | Type: SwitchParameter 77 | Parameter Sets: (All) 78 | Aliases: 79 | 80 | Required: False 81 | Position: Named 82 | Default value: False 83 | Accept pipeline input: False 84 | Accept wildcard characters: False 85 | ``` 86 | 87 | ### CommonParameters 88 | 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). 89 | 90 | ## INPUTS 91 | 92 | ### Nothing. 93 | ## OUTPUTS 94 | 95 | ### [PSObject] 96 | ## NOTES 97 | Related commands: 98 | Save-AtwsModuleConfiguration 99 | New-AtwsModuleConfiguration 100 | Set-AtwsModuleConfiguration 101 | Remove-AtwsModuleConfiguration 102 | 103 | ## RELATED LINKS 104 | -------------------------------------------------------------------------------- /Tests/Private/ConvertTo-AtwsDate.Tests.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | .COPYRIGHT 3 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 4 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 5 | 6 | .SYNOPSIS 7 | Test the function of the same name as the test file. 8 | .DESCRIPTION 9 | Runs Pester tests against the function by the same name as the test file. 10 | #> 11 | 12 | [cmdletbinding( 13 | SupportsShouldProcess = $True, 14 | ConfirmImpact = 'Low', 15 | DefaultParameterSetName = 'Default' 16 | )] 17 | 18 | Param 19 | ( 20 | [Parameter( 21 | Mandatory = $True, 22 | ParameterSetName = 'Default' 23 | )] 24 | [ValidateNotNullOrEmpty()] 25 | [pscredential] 26 | $Credential, 27 | 28 | [Parameter( 29 | Mandatory = $True, 30 | ParameterSetName = 'Default' 31 | )] 32 | [String] 33 | $ApiTrackingIdentifier, 34 | 35 | [Parameter( 36 | Mandatory = $false, 37 | ParameterSetName = 'Default' 38 | )] 39 | [String] 40 | $ModuleName = 'Autotask', 41 | 42 | [Parameter( 43 | Mandatory = $false, 44 | ParameterSetName = 'Default' 45 | )] 46 | [ValidateSCript( { 47 | Test-Path $_ 48 | })] 49 | [String] 50 | $RootPath = $(Split-Path -Parent -Path (Split-Path -Parent -Path $MyInvocation.MyCommand.Path)) 51 | ) 52 | 53 | $modulePath = '{0}\{1}' -F $RootPath, $ModuleName 54 | 55 | $loadedModule = Get-Module -Name $ModuleName 56 | If (-not ($loadedModule)) { 57 | # Import the module. Issues that need their own load version will have to do so in their context 58 | Import-Module $modulePath -Force -ArgumentList $Credential, $ApiTrackingIdentifier 59 | } 60 | 61 | # this is a private function 62 | InModuleScope Autotask { 63 | Describe 'ConvertTo-AtwsDate' { 64 | 65 | # The date as [DateTime] 66 | $date = Get-Date 67 | 68 | # The date as a sortable date [string] with UTC offset appended 69 | $this = $date.ToString('yyyy-MM-ddTHH:mm:ss.ffffz') 70 | 71 | It 'should be date with timezone info' { 72 | ConvertTo-AtwsDate -DateTime $Date | Should -Be $this 73 | } 74 | 75 | # The date as [DateTime] 76 | $date = Get-Date '2019.08.06' 77 | 78 | # The date as a sortable date [string] with UTC offset appended 79 | $this = $date.ToString('yyyy-MM-ddTHH:mm:ss.ffff') 80 | 81 | It 'should be date without any timezone info' { 82 | ConvertTo-AtwsDate -DateTime $Date | Should -Be $this 83 | } 84 | } 85 | } -------------------------------------------------------------------------------- /AtwsSOAP/obj/AtwsSOAP.csproj.nuget.dgspec.json: -------------------------------------------------------------------------------- 1 | { 2 | "format": 1, 3 | "restore": { 4 | "C:\\Git\\Autotask\\AtwsSOAP\\AtwsSOAP.csproj": {} 5 | }, 6 | "projects": { 7 | "C:\\Git\\Autotask\\AtwsSOAP\\AtwsSOAP.csproj": { 8 | "version": "1.0.0", 9 | "restore": { 10 | "projectUniqueName": "C:\\Git\\Autotask\\AtwsSOAP\\AtwsSOAP.csproj", 11 | "projectName": "AtwsSOAP", 12 | "projectPath": "C:\\Git\\Autotask\\AtwsSOAP\\AtwsSOAP.csproj", 13 | "packagesPath": "C:\\Users\\bjorn\\.nuget\\packages\\", 14 | "outputPath": "C:\\Git\\Autotask\\AtwsSOAP\\obj\\", 15 | "projectStyle": "PackageReference", 16 | "configFilePaths": [ 17 | "C:\\Users\\bjorn\\AppData\\Roaming\\NuGet\\NuGet.Config", 18 | "C:\\Program Files (x86)\\NuGet\\Config\\Microsoft.VisualStudio.Offline.config" 19 | ], 20 | "originalTargetFrameworks": [ 21 | "netcoreapp3.1" 22 | ], 23 | "sources": { 24 | "C:\\Program Files (x86)\\Microsoft SDKs\\NuGetPackages\\": {}, 25 | "https://api.nuget.org/v3/index.json": {} 26 | }, 27 | "frameworks": { 28 | "netcoreapp3.1": { 29 | "targetAlias": "netcoreapp3.1", 30 | "projectReferences": {} 31 | } 32 | }, 33 | "warningProperties": { 34 | "warnAsError": [ 35 | "NU1605" 36 | ] 37 | } 38 | }, 39 | "frameworks": { 40 | "netcoreapp3.1": { 41 | "targetAlias": "netcoreapp3.1", 42 | "dependencies": { 43 | "System.ServiceModel.Duplex": { 44 | "target": "Package", 45 | "version": "[4.*, )" 46 | }, 47 | "System.ServiceModel.Http": { 48 | "target": "Package", 49 | "version": "[4.*, )" 50 | }, 51 | "System.ServiceModel.NetTcp": { 52 | "target": "Package", 53 | "version": "[4.*, )" 54 | }, 55 | "System.ServiceModel.Security": { 56 | "target": "Package", 57 | "version": "[4.*, )" 58 | } 59 | }, 60 | "imports": [ 61 | "net461", 62 | "net462", 63 | "net47", 64 | "net471", 65 | "net472", 66 | "net48" 67 | ], 68 | "assetTargetFallback": true, 69 | "warn": true, 70 | "frameworkReferences": { 71 | "Microsoft.NETCore.App": { 72 | "privateAssets": "all" 73 | } 74 | }, 75 | "runtimeIdentifierGraphPath": "C:\\Program Files\\dotnet\\sdk\\5.0.300\\RuntimeIdentifierGraph.json" 76 | } 77 | } 78 | } 79 | } 80 | } -------------------------------------------------------------------------------- /Autotask/Private/Write-AtwsProgress.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | 3 | .COPYRIGHT 4 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 5 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 6 | 7 | #> 8 | 9 | Function Write-AtwsProgress { 10 | <# 11 | .SYNOPSIS 12 | This function emulates a very simple Write-Progress when running under VSCode, otherwise it just calls 13 | Write-Progress. 14 | .DESCRIPTION 15 | This function emulates a very simple Write-Progress when running under VSCode, otherwise it just calls 16 | Write-Progress. 17 | .INPUTS 18 | Nothing, only parameters. 19 | .OUTPUTS 20 | Text or calls Write-Progress 21 | .NOTES 22 | NAME: Write-AtwsProgress 23 | 24 | #> 25 | [cmdletbinding()] 26 | Param 27 | ( 28 | [string]$Activity, 29 | [string]$Status, 30 | [int]$Id, 31 | [int]$PercentComplete, 32 | [int]$SecondsRemaining, 33 | [string]$CurrentOperation, 34 | [int]$ParentID, 35 | [switch]$Completed, 36 | [int]$SourceId 37 | ) 38 | 39 | begin { 40 | # Enable modern -Debug behavior 41 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { 42 | $DebugPreference = 'Continue' 43 | } 44 | 45 | # Progress bar length in characters 46 | $size = 30 47 | Write-Verbose ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 48 | } 49 | 50 | process { 51 | if ($env:TERM_PROGRAM -eq 'vscode' -and $PSVersionTable.PSVersion.Major -le 8) { 52 | # Running in VSCode. Do our own stuff. 53 | $i = [Math]::Round($PercentComplete / (100 / $size)) 54 | $string = $CurrentOperation.substring(0, [System.Math]::Min(39, $CurrentOperation.Length)) 55 | $Message = "`r[{2}] {1,3} % - {0,-39}" -f $string, $PercentComplete, (''.PadLeft($i, '#') + ''.PadLeft($size - $i, '-')) 56 | 57 | # When using -NoNewLine this will be overwritten by -Verbose and/or -Debug 58 | Write-Host $Message -ForegroundColor Green -NoNewline 59 | 60 | if ($Completed.IsPresent) { 61 | # End the line. Looks better. 62 | Write-Host "`n" 63 | } 64 | 65 | # Repeat message if -Verbose is on 66 | Write-Verbose $Message 67 | } 68 | else { 69 | # Write-Progress should be supported. Pass all parameters to Write-Progress 70 | Write-Progress @PSBoundParameters 71 | } 72 | 73 | } 74 | 75 | end { 76 | Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /Docs/Uninstall-AtwsOldModuleVersion.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Uninstall-AtwsOldModuleVersion 9 | 10 | ## SYNOPSIS 11 | This function uninstalls old module versions. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Uninstall-AtwsOldModuleVersion [[-ModuleName] ] [-WhatIf] [-Confirm] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | When you update modules from Powershell Gallery with built-in functions any new 21 | module versions are installed alongside existing versions. 22 | Sometimes this may 23 | cause problems, including wasting disk space. 24 | This function gets a list of all 25 | installed versions of a module and uninstalls every version but the last. 26 | 27 | ## EXAMPLES 28 | 29 | ### EXAMPLE 1 30 | ``` 31 | Uninstall-AtwsOldModuleVersion 32 | Uninstalls all but the last version of this module. 33 | ``` 34 | 35 | ### EXAMPLE 2 36 | ``` 37 | Uninstall-AtwsOldModuleVersion -ModuleName ModuleName 38 | Uninstalls all but the last version of any module named ModuleName. 39 | ``` 40 | 41 | ## PARAMETERS 42 | 43 | ### -ModuleName 44 | The name of the module where all versions but the last should be uninstalled. 45 | 46 | ```yaml 47 | Type: String 48 | Parameter Sets: (All) 49 | Aliases: Name 50 | 51 | Required: False 52 | Position: 1 53 | Default value: $MyInvocation.MyCommand.ModuleName 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -WhatIf 59 | Shows what would happen if the cmdlet runs. 60 | The cmdlet is not run. 61 | 62 | ```yaml 63 | Type: SwitchParameter 64 | Parameter Sets: (All) 65 | Aliases: wi 66 | 67 | Required: False 68 | Position: Named 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -Confirm 75 | Prompts you for confirmation before running the cmdlet. 76 | 77 | ```yaml 78 | Type: SwitchParameter 79 | Parameter Sets: (All) 80 | Aliases: cf 81 | 82 | Required: False 83 | Position: Named 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### CommonParameters 90 | 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). 91 | 92 | ## INPUTS 93 | 94 | ### Nothing, only a parameter. 95 | ## OUTPUTS 96 | 97 | ### Nothing, it only deletes. 98 | ## NOTES 99 | NAME: Uninstall-AtwsOldModuleVersion 100 | 101 | ## RELATED LINKS 102 | -------------------------------------------------------------------------------- /Autotask/Public/Get-AtwsConnectionObject.ps1: -------------------------------------------------------------------------------- 1 | #Requires -Version 4.0 2 | <# 3 | 4 | .COPYRIGHT 5 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 6 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 7 | 8 | #> 9 | 10 | Function Get-AtwsConnectionObject { 11 | <# 12 | .SYNOPSIS 13 | This function returns a SOAPClient Object with the active connection to Autotask Web Api from the current namespace. 14 | .DESCRIPTION 15 | This function returns a SOAPClient Object with the active connection to Autotask Web API from the current namespace. 16 | Advanced users may use this object for direct access to API methods or hardcoded queries. It may also be useful for 17 | debugging. 18 | .INPUTS 19 | Nothing. 20 | .OUTPUTS 21 | [Autotask.SOAPClient] 22 | .EXAMPLE 23 | $Atws = Get-AtwsConnectionObject 24 | Gets a SOAPClient Object with the active connection to Autotask Web Api from the current namespace. 25 | .NOTES 26 | NAME: Get-AtwsConnectionObject 27 | 28 | #> 29 | 30 | [cmdletbinding(SupportsShouldProcess = $true, ConfirmImpact = 'High')] 31 | Param() 32 | 33 | begin { 34 | # Enable modern -Debug behavior before the first Write-Debug 35 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { $DebugPreference = 'Continue' } 36 | 37 | Write-Verbose ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 38 | 39 | if (-not($Script:Atws.integrationsValue)) { 40 | # Not connected. Try to connect, prompt for credentials if necessary 41 | Write-Verbose ('{0}: Not connected. Calling Connect-AtwsWebApi without parameters for possible autoload of default connection profile.' -F $MyInvocation.MyCommand.Name) 42 | Connect-AtwsWebAPI 43 | } 44 | 45 | } 46 | 47 | process { 48 | Write-Verbose ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 49 | 50 | $caption = $MyInvocation.MyCommand.Name 51 | $verboseDescription = '{0}: About to return the Web Proxy Object for the current connection Autotask Web API. This will expose your credentials in clear text in your terminals variable scope.' -F $caption 52 | $verboseWarning = '{0}: About to return the Web Proxy Object for the current connection Autotask Web API. This will expose your credentials in clear text in your terminals variable scope. Do you want to continue?' -F $caption 53 | 54 | if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { 55 | Return $Script:Atws 56 | } 57 | } 58 | 59 | end { 60 | Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 61 | } 62 | } -------------------------------------------------------------------------------- /Docs/Update-AtwsFunctions.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Update-AtwsFunctions 9 | 10 | ## SYNOPSIS 11 | This function recreates the autotask powershell functions. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Update-AtwsFunctions [-Force] [-WhatIf] [-Confirm] [] 17 | ``` 18 | 19 | ## DESCRIPTION 20 | Entities with picklists need customized parameter definitions to get the right validateset 21 | attributes. 22 | This function regenerates either static functions (those for entities that do not 23 | have any picklists or user defined fields) or dynamic functions (any function for an entity 24 | with either picklists or user defined fields). 25 | 26 | ## EXAMPLES 27 | 28 | ### EXAMPLE 1 29 | ``` 30 | Update-AtwsFunctions -FunctionSet Static 31 | Regenerates all static functions in $Module.Modulebase/Static directory 32 | ``` 33 | 34 | ### EXAMPLE 2 35 | ``` 36 | Update-AtwsFunctions -FunctionSet Dynamic 37 | Regenerates all static functions in $Module.Modulebase/Dynamic directory and the current user's 38 | dynamic cache directory. 39 | ``` 40 | 41 | ## PARAMETERS 42 | 43 | ### -Force 44 | {{ Fill Force Description }} 45 | 46 | ```yaml 47 | Type: SwitchParameter 48 | Parameter Sets: (All) 49 | Aliases: 50 | 51 | Required: False 52 | Position: Named 53 | Default value: False 54 | Accept pipeline input: False 55 | Accept wildcard characters: False 56 | ``` 57 | 58 | ### -WhatIf 59 | Shows what would happen if the cmdlet runs. 60 | The cmdlet is not run. 61 | 62 | ```yaml 63 | Type: SwitchParameter 64 | Parameter Sets: (All) 65 | Aliases: wi 66 | 67 | Required: False 68 | Position: Named 69 | Default value: None 70 | Accept pipeline input: False 71 | Accept wildcard characters: False 72 | ``` 73 | 74 | ### -Confirm 75 | Prompts you for confirmation before running the cmdlet. 76 | 77 | ```yaml 78 | Type: SwitchParameter 79 | Parameter Sets: (All) 80 | Aliases: cf 81 | 82 | Required: False 83 | Position: Named 84 | Default value: None 85 | Accept pipeline input: False 86 | Accept wildcard characters: False 87 | ``` 88 | 89 | ### CommonParameters 90 | 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). 91 | 92 | ## INPUTS 93 | 94 | ### A string representing the function set to regenerate, either Static or Dynamic. 95 | ## OUTPUTS 96 | 97 | ### Script files in module directory and the current user's dynamic cache. 98 | ## NOTES 99 | NAME: Update-AtwsFunctions 100 | 101 | ## RELATED LINKS 102 | -------------------------------------------------------------------------------- /Autotask/en-US/about_Autotask.help.txt: -------------------------------------------------------------------------------- 1 | TOPIC 2 | about_Autotask 3 | 4 | SHORT DESCRIPTION 5 | This is a script module with a set of functions per Autotask.Entity in the Autotask SOAP API. 6 | 7 | LONG DESCRIPTION 8 | The code is autogenerated from the entity information that is available through the API. There is a Get-function for any entities that support _Query_, a New-function for any entities that support _Create_, a Set-function for any entities that support _Update_ and a Remove-function for any entities that support _Delete_. If you cannot find a remove function for an entity, for instance *Ticket*, it is because the API does not permit deleting Tickets through the API. examples: 9 | 10 | Get-AtwsAccount 11 | New-AtwsAccount 12 | Set-AtwsAccount 13 | # No remove function for account, the API does not support deleting accounts 14 | Get-AtwsAccountTodo 15 | New-AtwsAccountTodo 16 | Set-AtwsAccountTodo 17 | Remove-AtwsAccountTodo 18 | 19 | This is a public release of an internal module we have developed. We use AUTOTASK, a SaaS software suite for ITSPs and MSPs. Autotask has a well documented SOAP API that we use quite extensively for automation. The API Documentation is available online: https://ww1.autotask.net/help/DeveloperHelp/Content/AdminSetup/2ExtensionsIntegrations/APIs/APIs.htm 20 | 21 | While working with the API we noted that a detailed definition of all entities and fields of entities is available programatically through the API. In this module we use this information to generate a PowerShell module with IntelliSense support in both ISE and Visual Studio Code. We also generate inline, comment based help to make working with the API in PowerShell as easy as possible. 22 | 23 | The module is generated dynamically, directly from the API information. All functions can be recreated if we update this module or when Autotask releases a new version of the API. Should Autotask update the API to permit deleting of Tickets through the API in the future, our module can be rebuilt and a *Remove-AtwsTicket* can be made availble to you. 24 | 25 | Use Get-Help *functionname* a lot. You will find information such as required parameters, any entities that the current entity have connections to, other entities that have connections to your current entity and a lot more. Possible values for *picklists* are included both in the help text and in IntelliSense autocomplete. 26 | 27 | DISCLAIMER AND WARNING 28 | BE CAREFUL! This module exposes all the Autotask Web Services API entities and methods as PowerShell functions. This makes it very easy to make a lot of changes very quickly. But there is no undo! If you use this module to destroy or delete anything in your Autotask tenant you did not intend to - you are entirely on your own! This module is provided "as is", without warranty of any kind, express or implied. In no event shall the authors or copyright holders be liable for any claim, damages or other liability (see the license). If this is not acceptable to you - do not use it! 29 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTag.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTag 9 | 10 | ## SYNOPSIS 11 | This function deletes a Tag through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTag [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTag -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a Tag through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTag [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: Tag[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.Tag[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.Tag that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTag 112 | Get-AtwsTag 113 | Set-AtwsTag 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Save-AtwsModuleConfiguration.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Save-AtwsModuleConfiguration 9 | 10 | ## SYNOPSIS 11 | This function saves to disk the internal configuration object that stores all module options. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Save-AtwsModuleConfiguration [[-Configuration] ] [[-Name] ] [[-Path] ] 17 | [] 18 | ``` 19 | 20 | ## DESCRIPTION 21 | This function saves to disk the internal configuration object that stores all module options. 22 | The default path is the current PowerShell configuration directory, 23 | 24 | ## EXAMPLES 25 | 26 | ### EXAMPLE 1 27 | ``` 28 | Save-AtwsModuleConfiguration 29 | ``` 30 | 31 | ### EXAMPLE 2 32 | ``` 33 | Save-AtwsModuleConfiguration -Path AtwsConfig.clixml 34 | ``` 35 | 36 | ## PARAMETERS 37 | 38 | ### -Configuration 39 | Validate the configuration object before accepting it 40 | A configuration object created with New-AtwsModuleConfiguration. 41 | Defaults to currently active configuration settings, if any. 42 | 43 | ```yaml 44 | Type: PSObject 45 | Parameter Sets: (All) 46 | Aliases: 47 | 48 | Required: False 49 | Position: 3 50 | Default value: Current default configuration profile, if any 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Name 56 | A name for your configuration profile. 57 | You can specify this name to Connect-AtwsWebApi and swich to 58 | another configuration set at runtime, any time you like. 59 | 60 | ```yaml 61 | Type: String 62 | Parameter Sets: (All) 63 | Aliases: ProfileName 64 | 65 | Required: False 66 | Position: 1 67 | Default value: Default 68 | Accept pipeline input: False 69 | Accept wildcard characters: False 70 | ``` 71 | 72 | ### -Path 73 | {{ Fill Path Description }} 74 | 75 | ```yaml 76 | Type: FileInfo 77 | Parameter Sets: (All) 78 | Aliases: ProfilePath 79 | 80 | Required: False 81 | Position: 2 82 | Default value: $(Join-Path -Path $Global:AtwsModuleConfigurationPath -ChildPath AtwsConfig.clixml) 83 | Accept pipeline input: False 84 | Accept wildcard characters: False 85 | ``` 86 | 87 | ### CommonParameters 88 | 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). 89 | 90 | ## INPUTS 91 | 92 | ### Nothing. 93 | ## OUTPUTS 94 | 95 | ### [PSObject] 96 | ## NOTES 97 | NAME: Save-AtwsModuleConfiguration 98 | 99 | Related commands: 100 | Get-AtwsModuleConfiguration 101 | Set-AtwsModuleConfiguration 102 | New-AtwsModuleConfiguration 103 | Remove-AtwsModuleConfiguration 104 | 105 | ## RELATED LINKS 106 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTagAlias.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTagAlias 9 | 10 | ## SYNOPSIS 11 | This function deletes a TagAlias through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTagAlias [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTagAlias -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TagAlias through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTagAlias [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TagAlias[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TagAlias[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TagAlias that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTagAlias 112 | Get-AtwsTagAlias 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Autotask/Private/ConvertTo-AtwsDate.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | 3 | .COPYRIGHT 4 | Copyright (c) Hugo Klemmestad. All rights reserved. Licensed under the MIT license. 5 | See https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md for license information. 6 | 7 | #TODO: Research på spørring på dato med tiddsoner. 8 | # CSU hvor dato begynner før og slutter etter nå. 9 | #> 10 | 11 | Function ConvertTo-AtwsDate { 12 | <# 13 | .SYNOPSIS 14 | This function converts a datetime object to a string representation of the datetime object that is 15 | compatible with the Autotask Web Services API. 16 | .DESCRIPTION 17 | There are two challenges with the Autotask Web Services API: There is a single DateTime property type 18 | that is used for both date fields and datetime fields. This becomes a challenge when you factor in 19 | that the API always uses the EST timezone, but most users expect DateTime to be treated in their local 20 | Timezone. This function takes both the DateTime object and the parameter name, because the parameter 21 | name is the only clue as to whether this property should be treated as a Date or a full DateTime value. 22 | .INPUTS 23 | [DateTime] 24 | .OUTPUTS 25 | [string] 26 | .EXAMPLE 27 | $Element | ConvertTo-AtwsDate -ParameterName 28 | Converts variable $Element with must contain a single DateTime value to a string representation of the 29 | Date or the DateTime, based on the parameter name. 30 | .NOTES 31 | NAME: ConvertTo-AtwsDate 32 | 33 | #> 34 | [cmdletbinding()] 35 | Param 36 | ( 37 | [Parameter( 38 | Mandatory = $true, 39 | ValueFromPipeline = $true 40 | )] 41 | [DateTime] 42 | $DateTime 43 | ) 44 | 45 | begin { 46 | Write-Debug ('{0}: Input Value: {1}' -F $MyInvocation.MyCommand.Name, $DateTime) 47 | } 48 | 49 | process { 50 | <# In memoria of superflouous code 51 | # Use local time for DateTime 52 | $OffsetSpan = (Get-TimeZone).BaseUtcOffset 53 | 54 | # Create the correct text string 55 | $Offset = '{0:00}:{1:00}' -F $OffsetSpan.Hours, $OffsetSpan.Minutes 56 | if ($OffsetSpan.Hours -ge 0) { 57 | $Offset = '+{0}' -F $Offset 58 | } 59 | $value = '{0}{1}' -F $(Get-Date $DateTime -Format s), $Offset 60 | #> 61 | if ($DateTime -eq $DateTime.Date) { 62 | # It is a date. Do not add timezone info. 63 | $value = $DateTime.ToString('yyyy-MM-ddTHH:mm:ss.ffff') 64 | } 65 | else { 66 | # It includes timeinfo. Add timezone 67 | $value = $DateTime.ToString('yyyy-MM-ddTHH:mm:ss.ffffz') 68 | } 69 | 70 | 71 | Write-Verbose ('{0}: Converting datetime to {1}' -F $MyInvocation.MyCommand.Name, $value) 72 | 73 | } 74 | 75 | end { 76 | Write-Debug ('{0}: Output value: {1}' -F $MyInvocation.MyCommand.Name, $value) 77 | 78 | return $value 79 | } 80 | } -------------------------------------------------------------------------------- /Docs/Remove-AtwsContact.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContact 9 | 10 | ## SYNOPSIS 11 | This function deletes a Contact through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContact [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContact -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a Contact through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContact [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: Contact[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.Contact[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.Contact that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContact 112 | Get-AtwsContact 113 | Set-AtwsContact 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsHoliday.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsHoliday 9 | 10 | ## SYNOPSIS 11 | This function deletes a Holiday through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsHoliday [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsHoliday -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a Holiday through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsHoliday [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: Holiday[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.Holiday[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.Holiday that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsHoliday 112 | Get-AtwsHoliday 113 | Set-AtwsHoliday 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTagGroup.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTagGroup 9 | 10 | ## SYNOPSIS 11 | This function deletes a TagGroup through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTagGroup [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTagGroup -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TagGroup through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTagGroup [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TagGroup[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TagGroup[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TagGroup that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTagGroup 112 | Get-AtwsTagGroup 113 | Set-AtwsTagGroup 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsModuleConfiguration.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsModuleConfiguration 9 | 10 | ## SYNOPSIS 11 | This function deletes from disk a named configuration object that stores all module options. 12 | 13 | ## SYNTAX 14 | 15 | ``` 16 | Remove-AtwsModuleConfiguration [[-Path] ] [[-Name] ] [-WhatIf] [-Confirm] 17 | [] 18 | ``` 19 | 20 | ## DESCRIPTION 21 | This function loads from disk the current list of configuration objects that have been saved. 22 | Any configuration with the name given will be deleted. 23 | 24 | ## EXAMPLES 25 | 26 | ### EXAMPLE 1 27 | ``` 28 | Remove-AtwsModuleConfiguration -Name Sandbox 29 | ``` 30 | 31 | ### EXAMPLE 2 32 | ``` 33 | Remove-AtwsModuleConfiguration -Name Default -Path AtwsConfig.clixml 34 | ``` 35 | 36 | ## PARAMETERS 37 | 38 | ### -Path 39 | {{ Fill Path Description }} 40 | 41 | ```yaml 42 | Type: FileInfo 43 | Parameter Sets: (All) 44 | Aliases: 45 | 46 | Required: False 47 | Position: 2 48 | Default value: $(Join-Path -Path $Global:AtwsModuleConfigurationPath -ChildPath AtwsConfig.clixml) 49 | Accept pipeline input: False 50 | Accept wildcard characters: False 51 | ``` 52 | 53 | ### -Name 54 | {{ Fill Name Description }} 55 | 56 | ```yaml 57 | Type: String 58 | Parameter Sets: (All) 59 | Aliases: 60 | 61 | Required: False 62 | Position: 1 63 | Default value: Default 64 | Accept pipeline input: False 65 | Accept wildcard characters: False 66 | ``` 67 | 68 | ### -WhatIf 69 | Shows what would happen if the cmdlet runs. 70 | The cmdlet is not run. 71 | 72 | ```yaml 73 | Type: SwitchParameter 74 | Parameter Sets: (All) 75 | Aliases: wi 76 | 77 | Required: False 78 | Position: Named 79 | Default value: None 80 | Accept pipeline input: False 81 | Accept wildcard characters: False 82 | ``` 83 | 84 | ### -Confirm 85 | Prompts you for confirmation before running the cmdlet. 86 | 87 | ```yaml 88 | Type: SwitchParameter 89 | Parameter Sets: (All) 90 | Aliases: cf 91 | 92 | Required: False 93 | Position: Named 94 | Default value: None 95 | Accept pipeline input: False 96 | Accept wildcard characters: False 97 | ``` 98 | 99 | ### CommonParameters 100 | 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). 101 | 102 | ## INPUTS 103 | 104 | ### Nothing. 105 | ## OUTPUTS 106 | 107 | ### Nothing 108 | ## NOTES 109 | NAME: Remove-AtwsModuleConfiguration 110 | 111 | Related commands: 112 | Get-AtwsModuleConfiguration 113 | Set-AtwsModuleConfiguration 114 | New-AtwsModuleConfiguration 115 | Save-AtwsModuleConfiguration 116 | 117 | ## RELATED LINKS 118 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsAccountTeam.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsAccountTeam 9 | 10 | ## SYNOPSIS 11 | This function deletes a AccountTeam through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsAccountTeam [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsAccountTeam -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a AccountTeam through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsAccountTeam [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: AccountTeam[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.AccountTeam[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.AccountTeam that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsAccountTeam 112 | Get-AtwsAccountTeam 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsQuoteItem.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsQuoteItem 9 | 10 | ## SYNOPSIS 11 | This function deletes a QuoteItem through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsQuoteItem [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsQuoteItem -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a QuoteItem through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsQuoteItem [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: QuoteItem[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.QuoteItem[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.QuoteItem that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsQuoteItem 112 | Get-AtwsQuoteItem 113 | Set-AtwsQuoteItem 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTimeEntry.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTimeEntry 9 | 10 | ## SYNOPSIS 11 | This function deletes a TimeEntry through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTimeEntry [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTimeEntry -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TimeEntry through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTimeEntry [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TimeEntry[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TimeEntry[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TimeEntry that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTimeEntry 112 | Get-AtwsTimeEntry 113 | Set-AtwsTimeEntry 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsActionType.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsActionType 9 | 10 | ## SYNOPSIS 11 | This function deletes a ActionType through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsActionType [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsActionType -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ActionType through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsActionType [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ActionType[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ActionType[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ActionType that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsActionType 112 | Get-AtwsActionType 113 | Set-AtwsActionType 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsHolidaySet.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsHolidaySet 9 | 10 | ## SYNOPSIS 11 | This function deletes a HolidaySet through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsHolidaySet [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsHolidaySet -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a HolidaySet through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsHolidaySet [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: HolidaySet[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.HolidaySet[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.HolidaySet that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsHolidaySet 112 | Get-AtwsHolidaySet 113 | Set-AtwsHolidaySet 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketCost.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketCost 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketCost through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketCost [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTicketCost -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TicketCost through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTicketCost [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TicketCost[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TicketCost[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TicketCost that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTicketCost 112 | Get-AtwsTicketCost 113 | Set-AtwsTicketCost 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsAccountToDo.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsAccountToDo 9 | 10 | ## SYNOPSIS 11 | This function deletes a AccountToDo through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsAccountToDo [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsAccountToDo -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a AccountToDo through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsAccountToDo [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: AccountToDo[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.AccountToDo[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.AccountToDo that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsAccountToDo 112 | Get-AtwsAccountToDo 113 | Set-AtwsAccountToDo 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsAppointment.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsAppointment 9 | 10 | ## SYNOPSIS 11 | This function deletes a Appointment through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsAppointment [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsAppointment -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a Appointment through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsAppointment [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: Appointment[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.Appointment[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.Appointment that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsAppointment 112 | Get-AtwsAppointment 113 | Set-AtwsAppointment 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsProductTier.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsProductTier 9 | 10 | ## SYNOPSIS 11 | This function deletes a ProductTier through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsProductTier [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsProductTier -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ProductTier through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsProductTier [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ProductTier[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ProductTier[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ProductTier that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsProductTier 112 | Get-AtwsProductTier 113 | Set-AtwsProductTier 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsProjectCost.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsProjectCost 9 | 10 | ## SYNOPSIS 11 | This function deletes a ProjectCost through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsProjectCost [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsProjectCost -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ProjectCost through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsProjectCost [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ProjectCost[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ProjectCost[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ProjectCost that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsProjectCost 112 | Get-AtwsProjectCost 113 | Set-AtwsProjectCost 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceCall.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceCall 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceCall through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceCall [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsServiceCall -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ServiceCall through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsServiceCall [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ServiceCall[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ServiceCall[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ServiceCall that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsServiceCall 112 | Get-AtwsServiceCall 113 | Set-AtwsServiceCall 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /about_module.md: -------------------------------------------------------------------------------- 1 | # Autotask 2 | 3 | ## Summary 4 | 5 | This is a script module with a set of functions per Autotask.Entity in the Autotask SOAP API. The code is autogenerated from the entity information that is available through the API. There is a Get-function for any entities that support _Query_, a New-function for any entities that support _Create_, a Set-function for any entities that support _Update_ and a Remove-function for any entities that support _Delete_. If you cannot find a remove function for an entity, for instance *Ticket*, it is because the API does not permit deleting Tickets through the API. examples: 6 | 7 | ```powershell 8 | Get-AtwsAccount 9 | New-AtwsAccount 10 | Set-AtwsAccount 11 | # No remove function for account, the API does not support deleting accounts 12 | Get-AtwsAccountTodo 13 | New-AtwsAccountTodo 14 | Set-AtwsAccountTodo 15 | Remove-AtwsAccountTodo 16 | ``` 17 | 18 | ## An Autotask Web Services Powershell module 19 | 20 | This is a public release of an internal module we have developed. We use [Autotask][1], a SaaS software suite for ITSPs and MSPs. Autotask has a well documented SOAP API that we use quite extensively for automation. The [API Documentation is available online][2]. 21 | 22 | While working with the API we noted that a detailed definition of all entities and fields of entities is available programatically through the API. In this module we use this information to generate a PowerShell module with **IntelliSense** support in both ISE and Visual Studio Code. We also generate inline, comment based help to make working with the API in PowerShell as easy as possible. 23 | 24 | The module is generated dynamically, directly from the API information. All functions can be recreated if we update this module or when Autotask releases a new version of the API. Should Autotask update the API to permit deleting of Tickets through the API in the future, our module can be rebuilt and a *Remove-AtwsTicket* can be made availble to you. 25 | 26 | Use Get-Help *functionname* a lot. You will find information such as required parameters, any entities that the current entity have connections to, other entities that have connections to your current entity and a lot more. Possible values for *picklists* are included both in the help text and in **IntelliSense** autocomplete 27 | 28 | ## Disclaimer and Warning 29 | 30 | **Be careful!** This module exposes all the Autotask Web Services API entities and methods as PowerShell functions. This makes it very easy to make a lot of changes very quickly. **But there is no undo!** If you use this module to destroy or delete anything in your Autotask tenant you did not intend to - you are entirely on your own! This module is provided "as is", without warranty of any kind, express or implied. In **no event** shall the authors or copyright holders be liable for any claim, damages or other liability ([see the license][3]). If this is not acceptable to you - do not use it! 31 | 32 | [1]: https://www.autotask.com 33 | [2]: https://ww1.autotask.net/help/DeveloperHelp/Content/AdminSetup/2ExtensionsIntegrations/APIs/APIs.htm 34 | [3]: https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md -------------------------------------------------------------------------------- /Autotask/Private/Remove-AtwsDefinition.ps1: -------------------------------------------------------------------------------- 1 | Function Remove-AtwsDefinition { 2 | begin { 3 | $entityName = '#EntityName' 4 | 5 | # Enable modern -Debug behavior 6 | if ($PSCmdlet.MyInvocation.BoundParameters['Debug'].IsPresent) { 7 | $DebugPreference = 'Continue' 8 | } 9 | else { 10 | # Respect configured preference 11 | $DebugPreference = $Script:Atws.Configuration.DebugPref 12 | } 13 | 14 | Write-Debug ('{0}: Begin of function' -F $MyInvocation.MyCommand.Name) 15 | 16 | if (!($PSCmdlet.MyInvocation.BoundParameters['Verbose'].IsPresent)) { 17 | # No local override of central preference. Load central preference 18 | $VerbosePreference = $Script:Atws.Configuration.VerbosePref 19 | } 20 | } 21 | 22 | process { 23 | 24 | # Collect copies of InputObject if passed any IDs 25 | # Has to collect in batches, or we are going to get the 26 | # dreaded 'too nested SQL' error 27 | If ($Id.count -gt 0) { 28 | $InputObject = @() 29 | for ($i = 0; $i -lt $Id.count; $i += 200) { 30 | $j = $i + 199 31 | if ($j -ge $Id.count) { 32 | $j = $Id.count - 1 33 | } 34 | 35 | # Create a filter with the current batch 36 | $Filter = 'Id -eq {0}' -F ($Id[$i .. $j] -join ' -or Id -eq ') 37 | 38 | $InputObject += Get-AtwsData -Entity $entityName -Filter $Filter 39 | } 40 | 41 | } 42 | 43 | Write-Verbose ('{0}: Deleting {1} object(s) from Autotask' -F $MyInvocation.MyCommand.Name, $InputObject.Count) 44 | 45 | if ($InputObject) { 46 | 47 | $caption = $MyInvocation.MyCommand.Name 48 | $verboseDescription = '{0}: About to delete {1} {2}(s). This action cannot be undone.' -F $caption, $InputObject.Count, $entityName 49 | $verboseWarning = '{0}: About to delete {1} {2}(s). This action cannot be undone. Do you want to continue?' -F $caption, $InputObject.Count, $entityName 50 | 51 | if ($PSCmdlet.ShouldProcess($verboseDescription, $verboseWarning, $caption)) { 52 | try { 53 | Remove-AtwsData -Entity $InputObject 54 | } 55 | catch { 56 | # Write a debug message with detailed information to developers 57 | $reason = ("{0}: {1}" -f $_.CategoryInfo.Category, $_.CategoryInfo.Reason) 58 | $message = "{2}: {0}`r`n`r`nLine:{1}`r`n`r`nScript stacktrace:`r`n{3}" -f $_.Exception.Message, $_.InvocationInfo.Line, $reason, $_.ScriptStackTrace 59 | Write-Debug $message 60 | 61 | # Pass on the error, but locate it to this function 62 | $PSCmdlet.ThrowTerminatingError($_) 63 | return 64 | } 65 | } 66 | } 67 | } 68 | 69 | end { 70 | Write-Debug ('{0}: End of function' -F $MyInvocation.MyCommand.Name) 71 | } 72 | 73 | } -------------------------------------------------------------------------------- /Docs/Remove-AtwsContactGroup.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContactGroup 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContactGroup through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContactGroup [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContactGroup -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContactGroup through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContactGroup [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContactGroup[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContactGroup[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContactGroup that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContactGroup 112 | Get-AtwsContactGroup 113 | Set-AtwsContactGroup 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContractCost.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContractCost 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContractCost through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContractCost [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContractCost -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContractCost through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContractCost [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContractCost[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContractCost[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContractCost that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContractCost 112 | Get-AtwsContractCost 113 | Set-AtwsContractCost 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsSubscription.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsSubscription 9 | 10 | ## SYNOPSIS 11 | This function deletes a Subscription through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsSubscription [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsSubscription -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a Subscription through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsSubscription [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: Subscription[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.Subscription[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.Subscription that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsSubscription 112 | Get-AtwsSubscription 113 | Set-AtwsSubscription 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/about_Autotask.md: -------------------------------------------------------------------------------- 1 | # Autotask 2 | 3 | ## about_Autotask 4 | 5 | # SHORT DESCRIPTION 6 | 7 | This is a script module with a set of functions per Autotask.Entity in the Autotask SOAP API. The code is autogenerated from the entity information that is available through the API. There is a Get-function for any entities that support _Query_, a New-function for any entities that support _Create_, a Set-function for any entities that support _Update_ and a Remove-function for any entities that support _Delete_. If you cannot find a remove function for an entity, for instance *Ticket*, it is because the API does not permit deleting Tickets through the API. examples: 8 | 9 | ```powershell 10 | Get-AtwsAccount 11 | New-AtwsAccount 12 | Set-AtwsAccount 13 | # No remove function for account, the API does not support deleting accounts 14 | Get-AtwsAccountTodo 15 | New-AtwsAccountTodo 16 | Set-AtwsAccountTodo 17 | Remove-AtwsAccountTodo 18 | ``` 19 | 20 | ## LONG DESCRIPTION 21 | 22 | This is a public release of an internal module we have developed. We use [Autotask][1], a SaaS software suite for ITSPs and MSPs. Autotask has a well documented SOAP API that we use quite extensively for automation. The [API Documentation is available online][2]. 23 | 24 | While working with the API we noted that a detailed definition of all entities and fields of entities is available programatically through the API. In this module we use this information to generate a PowerShell module with **IntelliSense** support in both ISE and Visual Studio Code. We also generate inline, comment based help to make working with the API in PowerShell as easy as possible. 25 | 26 | The module is generated dynamically, directly from the API information. All functions can be recreated if we update this module or when Autotask releases a new version of the API. Should Autotask update the API to permit deleting of Tickets through the API in the future, our module can be rebuilt and a *Remove-AtwsTicket* can be made availble to you. 27 | 28 | Use Get-Help *functionname* a lot. You will find information such as required parameters, any entities that the current entity have connections to, other entities that have connections to your current entity and a lot more. Possible values for *picklists* are included both in the help text and in **IntelliSense** autocomplete 29 | 30 | ## Disclaimer and Warning 31 | 32 | **Be careful!** This module exposes all the Autotask Web Services API entities and methods as PowerShell functions. This makes it very easy to make a lot of changes very quickly. **But there is no undo!** If you use this module to destroy or delete anything in your Autotask tenant you did not intend to - you are entirely on your own! This module is provided "as is", without warranty of any kind, express or implied. In **no event** shall the authors or copyright holders be liable for any claim, damages or other liability ([see the license][3]). If this is not acceptable to you - do not use it! 33 | 34 | [1]: https://www.autotask.com 35 | [2]: https://ww1.autotask.net/help/DeveloperHelp/Content/AdminSetup/2ExtensionsIntegrations/APIs/APIs.htm 36 | [3]: https://github.com/ecitsolutions/Autotask/blob/master/LICENSE.md -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceBundle.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceBundle 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceBundle through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceBundle [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsServiceBundle -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ServiceBundle through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsServiceBundle [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ServiceBundle[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ServiceBundle[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ServiceBundle that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsServiceBundle 112 | Get-AtwsServiceBundle 113 | Set-AtwsServiceBundle 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceCallTask.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceCallTask 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceCallTask through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceCallTask [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsServiceCallTask -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ServiceCallTask through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsServiceCallTask [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ServiceCallTask[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ServiceCallTask[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ServiceCallTask that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsServiceCallTask 112 | Get-AtwsServiceCallTask 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /AtwsSOAP/Missing properties on EntityInfo.patch: -------------------------------------------------------------------------------- 1 | diff --git a/Autotask/Private/Reference.cs b/Autotask/Private/Reference.cs 2 | index b4a77f9..38a53d5 100644 3 | --- a/Autotask/Private/Reference.cs 4 | +++ b/Autotask/Private/Reference.cs 5 | @@ -30890,7 +30890,15 @@ namespace Autotask 6 | private bool canCreateField; 7 | 8 | private bool canQueryField; 9 | - 10 | + 11 | + private string userAccessForCreateField; 12 | + 13 | + private string userAccessForQueryField; 14 | + 15 | + private string userAccessForUpdateField; 16 | + 17 | + private string userAccessForDeleteField; 18 | + 19 | private bool hasUserDefinedFieldsField; 20 | 21 | private bool supportsWebhookCalloutsField; 22 | @@ -30964,9 +30972,65 @@ namespace Autotask 23 | this.canQueryField = value; 24 | } 25 | } 26 | - 27 | + 28 | /// 29 | - [System.Xml.Serialization.XmlElementAttribute(Order=5)] 30 | + [System.Xml.Serialization.XmlElementAttribute(Order = 5)] 31 | + public string UserAccessForCreate 32 | + { 33 | + get 34 | + { 35 | + return this.userAccessForCreateField; 36 | + } 37 | + set 38 | + { 39 | + this.userAccessForCreateField = value; 40 | + } 41 | + } 42 | + 43 | + /// 44 | + [System.Xml.Serialization.XmlElementAttribute(Order = 6)] 45 | + public string UserAccessForQuery 46 | + { 47 | + get 48 | + { 49 | + return this.userAccessForQueryField; 50 | + } 51 | + set 52 | + { 53 | + this.userAccessForQueryField = value; 54 | + } 55 | + } 56 | + 57 | + /// 58 | + [System.Xml.Serialization.XmlElementAttribute(Order = 7)] 59 | + public string UserAccessForUpdate 60 | + { 61 | + get 62 | + { 63 | + return this.userAccessForUpdateField; 64 | + } 65 | + set 66 | + { 67 | + this.userAccessForUpdateField = value; 68 | + } 69 | + } 70 | + 71 | + /// 72 | + [System.Xml.Serialization.XmlElementAttribute(Order = 8)] 73 | + public string UserAccessForDelete 74 | + { 75 | + get 76 | + { 77 | + return this.userAccessForDeleteField; 78 | + } 79 | + set 80 | + { 81 | + this.userAccessForDeleteField = value; 82 | + } 83 | + } 84 | + 85 | + /// 86 | + [System.Xml.Serialization.XmlElementAttribute(Order=9)] 87 | public bool HasUserDefinedFields 88 | { 89 | get 90 | @@ -30980,7 +31044,7 @@ namespace Autotask 91 | } 92 | 93 | /// 94 | - [System.Xml.Serialization.XmlElementAttribute(Order=6)] 95 | + [System.Xml.Serialization.XmlElementAttribute(Order=10)] 96 | public bool SupportsWebhookCallouts 97 | { 98 | get 99 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsAccountWebhook.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsAccountWebhook 9 | 10 | ## SYNOPSIS 11 | This function deletes a AccountWebhook through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsAccountWebhook [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsAccountWebhook -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a AccountWebhook through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsAccountWebhook [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: AccountWebhook[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.AccountWebhook[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.AccountWebhook that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsAccountWebhook 112 | Get-AtwsAccountWebhook 113 | Set-AtwsAccountWebhook 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContactWebhook.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContactWebhook 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContactWebhook through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContactWebhook [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContactWebhook -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContactWebhook through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContactWebhook [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContactWebhook[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContactWebhook[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContactWebhook that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContactWebhook 112 | Get-AtwsContactWebhook 113 | Set-AtwsContactWebhook 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsChangeRequestLink.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsChangeRequestLink 9 | 10 | ## SYNOPSIS 11 | This function deletes a ChangeRequestLink through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsChangeRequestLink [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsChangeRequestLink -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ChangeRequestLink through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsChangeRequestLink [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ChangeRequestLink[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int32[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ChangeRequestLink[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ChangeRequestLink that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsChangeRequestLink 112 | Get-AtwsChangeRequestLink 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceCallTicket.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceCallTicket 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceCallTicket through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceCallTicket [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsServiceCallTicket -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ServiceCallTicket through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsServiceCallTicket [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ServiceCallTicket[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ServiceCallTicket[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ServiceCallTicket that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsServiceCallTicket 112 | Get-AtwsServiceCallTicket 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsChangeOrderCost.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsChangeOrderCost 9 | 10 | ## SYNOPSIS 11 | This function deletes a ChangeOrderCost through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsChangeOrderCost [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsChangeOrderCost -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ChangeOrderCost through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsChangeOrderCost [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ChangeOrderCost[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ChangeOrderCost[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ChangeOrderCost that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsChangeOrderCost 112 | Get-AtwsChangeOrderCost 113 | Set-AtwsChangeOrderCost 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTaskPredecessor.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTaskPredecessor 9 | 10 | ## SYNOPSIS 11 | This function deletes a TaskPredecessor through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTaskPredecessor [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTaskPredecessor -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TaskPredecessor through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTaskPredecessor [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TaskPredecessor[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TaskPredecessor[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TaskPredecessor that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTaskPredecessor 112 | Get-AtwsTaskPredecessor 113 | Set-AtwsTaskPredecessor 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketRmaCredit.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketRmaCredit 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketRmaCredit through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketRmaCredit [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTicketRmaCredit -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TicketRmaCredit through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTicketRmaCredit [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TicketRmaCredit[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TicketRmaCredit[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TicketRmaCredit that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTicketRmaCredit 112 | Get-AtwsTicketRmaCredit 113 | Set-AtwsTicketRmaCredit 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsWebhookEventErrorLog.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsWebhookEventErrorLog 9 | 10 | ## SYNOPSIS 11 | This function deletes a WebhookEventErrorLog through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsWebhookEventErrorLog [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsWebhookEventErrorLog -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a WebhookEventErrorLog through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsWebhookEventErrorLog [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: WebhookEventErrorLog[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.WebhookEventErrorLog[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.WebhookEventErrorLog that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | Get-AtwsWebhookEventErrorLog 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsChecklistLibrary.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsChecklistLibrary 9 | 10 | ## SYNOPSIS 11 | This function deletes a ChecklistLibrary through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsChecklistLibrary [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsChecklistLibrary -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ChecklistLibrary through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsChecklistLibrary [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ChecklistLibrary[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ChecklistLibrary[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ChecklistLibrary that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsChecklistLibrary 112 | Get-AtwsChecklistLibrary 113 | Set-AtwsChecklistLibrary 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContactGroupContact.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContactGroupContact 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContactGroupContact through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContactGroupContact [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContactGroupContact -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContactGroupContact through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContactGroupContact [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContactGroupContact[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContactGroupContact[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContactGroupContact that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContactGroupContact 112 | Get-AtwsContactGroupContact 113 | 114 | ## RELATED LINKS 115 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsComanagedAssociation.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsComanagedAssociation 9 | 10 | ## SYNOPSIS 11 | This function deletes a ComanagedAssociation through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsComanagedAssociation [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsComanagedAssociation -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a ComanagedAssociation through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsComanagedAssociation [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: ComanagedAssociation[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.ComanagedAssociation[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.ComanagedAssociation that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsComanagedAssociation 113 | Get-AtwsComanagedAssociation 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceBundleService.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceBundleService 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceBundleService through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceBundleService [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsServiceBundleService -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a ServiceBundleService through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsServiceBundleService [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: ServiceBundleService[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.ServiceBundleService[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.ServiceBundleService that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsServiceBundleService 113 | Get-AtwsServiceBundleService 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketTagAssociation.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketTagAssociation 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketTagAssociation through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketTagAssociation [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsTicketTagAssociation -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a TicketTagAssociation through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsTicketTagAssociation [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: TicketTagAssociation[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.TicketTagAssociation[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.TicketTagAssociation that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsTicketTagAssociation 113 | Get-AtwsTicketTagAssociation 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsAccountWebhookField.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsAccountWebhookField 9 | 10 | ## SYNOPSIS 11 | This function deletes a AccountWebhookField through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsAccountWebhookField [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsAccountWebhookField -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a AccountWebhookField through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsAccountWebhookField [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: AccountWebhookField[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.AccountWebhookField[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.AccountWebhookField that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsAccountWebhookField 112 | Get-AtwsAccountWebhookField 113 | Set-AtwsAccountWebhookField 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContactWebhookField.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContactWebhookField 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContactWebhookField through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContactWebhookField [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContactWebhookField -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContactWebhookField through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContactWebhookField [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContactWebhookField[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContactWebhookField[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContactWebhookField that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContactWebhookField 112 | Get-AtwsContactWebhookField 113 | Set-AtwsContactWebhookField 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContractBillingRule.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContractBillingRule 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContractBillingRule through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContractBillingRule [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsContractBillingRule -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a ContractBillingRule through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsContractBillingRule [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: ContractBillingRule[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.ContractBillingRule[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.ContractBillingRule that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsContractBillingRule 112 | Get-AtwsContractBillingRule 113 | Set-AtwsContractBillingRule 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContractExclusionRole.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContractExclusionRole 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContractExclusionRole through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContractExclusionRole [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsContractExclusionRole -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a ContractExclusionRole through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsContractExclusionRole [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: ContractExclusionRole[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.ContractExclusionRole[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.ContractExclusionRole that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsContractExclusionRole 113 | Get-AtwsContractExclusionRole 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTaskSecondaryResource.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTaskSecondaryResource 9 | 10 | ## SYNOPSIS 11 | This function deletes a TaskSecondaryResource through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTaskSecondaryResource [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsTaskSecondaryResource -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a TaskSecondaryResource through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsTaskSecondaryResource [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: TaskSecondaryResource[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.TaskSecondaryResource[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.TaskSecondaryResource that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsTaskSecondaryResource 113 | Get-AtwsTaskSecondaryResource 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketChecklistItem.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketChecklistItem 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketChecklistItem through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketChecklistItem [-InputObject ] [-WhatIf] [-Confirm] [] 18 | ``` 19 | 20 | ### By_parameters 21 | ``` 22 | Remove-AtwsTicketChecklistItem -Id [-WhatIf] [-Confirm] [] 23 | ``` 24 | 25 | ## DESCRIPTION 26 | This function deletes a TicketChecklistItem through the Autotask Web Services API. 27 | 28 | Entities that have fields that refer to the base entity of this CmdLet: 29 | 30 | ## EXAMPLES 31 | 32 | ### EXAMPLE 1 33 | ``` 34 | Remove-AtwsTicketChecklistItem [-ParameterName] [Parameter value] 35 | ``` 36 | 37 | ## PARAMETERS 38 | 39 | ### -InputObject 40 | Any objects that should be deleted 41 | 42 | ```yaml 43 | Type: TicketChecklistItem[] 44 | Parameter Sets: Input_Object 45 | Aliases: 46 | 47 | Required: False 48 | Position: Named 49 | Default value: None 50 | Accept pipeline input: True (ByValue) 51 | Accept wildcard characters: False 52 | ``` 53 | 54 | ### -Id 55 | The unique id of an object to delete 56 | 57 | ```yaml 58 | Type: Int64[] 59 | Parameter Sets: By_parameters 60 | Aliases: 61 | 62 | Required: True 63 | Position: Named 64 | Default value: None 65 | Accept pipeline input: False 66 | Accept wildcard characters: False 67 | ``` 68 | 69 | ### -WhatIf 70 | Shows what would happen if the cmdlet runs. 71 | The cmdlet is not run. 72 | 73 | ```yaml 74 | Type: SwitchParameter 75 | Parameter Sets: (All) 76 | Aliases: wi 77 | 78 | Required: False 79 | Position: Named 80 | Default value: None 81 | Accept pipeline input: False 82 | Accept wildcard characters: False 83 | ``` 84 | 85 | ### -Confirm 86 | Prompts you for confirmation before running the cmdlet. 87 | 88 | ```yaml 89 | Type: SwitchParameter 90 | Parameter Sets: (All) 91 | Aliases: cf 92 | 93 | Required: False 94 | Position: Named 95 | Default value: None 96 | Accept pipeline input: False 97 | Accept wildcard characters: False 98 | ``` 99 | 100 | ### CommonParameters 101 | 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). 102 | 103 | ## INPUTS 104 | 105 | ### [Autotask.TicketChecklistItem[]]. This function takes objects as input. Pipeline is supported. 106 | ## OUTPUTS 107 | 108 | ### Nothing. This fuction just deletes the Autotask.TicketChecklistItem that was passed to the function. 109 | ## NOTES 110 | Related commands: 111 | New-AtwsTicketChecklistItem 112 | Get-AtwsTicketChecklistItem 113 | Set-AtwsTicketChecklistItem 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Scripts/DebugModule.ps1: -------------------------------------------------------------------------------- 1 | <# 2 | 3 | Just a script so we have a workbench we can invoke to debug session. 4 | This is basically a workflow of what we need to write tests for as well. 5 | #> 6 | 7 | 8 | Import-Module Pester -RequiredVersion 5.1.0 -ErrorAction Stop 9 | $PesterModule = Get-Module -Name Pester 10 | 11 | $moduleName = 'Autotask' 12 | $RootPath = 'C:\Git\Autotask' 13 | $modulePath = '{0}\{1}' -F $RootPath, $ModuleName 14 | $SandBoxDomain = '@ECITSOLUTIONSSB12032021.NO' 15 | 16 | if (-not $Global:Credential -or -not $Global:TI) { 17 | Write-Warning "Running pester tests based on defaultconfig." 18 | $P = Join-Path (Split-Path -Path $profile -Parent) -ChildPath 'AtwsConfig.clixml' 19 | $Settings = Import-Clixml -Path $P -ErrorAction Stop 20 | try { 21 | $Global:Credential = [pscredential]::new($Settings.Default.Username, $Settings.Default.SecurePassword) 22 | $SBUname = $Settings.Default.Username.Split('@')[0] + $SandBoxDomain 23 | $Global:SandboxCredential = [pscredential]::new($SBUname, $Settings.Default.SecurePassword) 24 | $Global:SecureTI = $Settings.Default.SecureTrackingIdentifier 25 | 26 | $BSTR = [System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($Global:SecureTI) 27 | $Global:TI = [System.Runtime.InteropServices.Marshal]::PtrToStringBSTR($BSTR) 28 | } 29 | catch { 30 | $message = "Cannot read default moduleconfig file for pester tests. set this up before running pester test." 31 | throw (New-Object System.Configuration.Provider.ProviderException $message) 32 | } 33 | } 34 | 35 | $PesterConfigPath = Join-Path (Split-Path -Path $profile -Parent) -ChildPath 'AtwsPesterConfig.clixml' 36 | if (Test-Path $PesterConfigPath) { 37 | Remove-Item $PesterConfigPath 38 | } 39 | 40 | Import-Module $modulePath -Force -ErrorAction Stop 41 | $loadedModule = Get-Module $moduleName 42 | 43 | Connect-AtwsWebAPI -AtwsModuleConfigurationName Sandbox 44 | 45 | 46 | #Error 1: 47 | $Config = New-AtwsModuleConfiguration -Credential $Global:SandboxCredential -SecureTrackingIdentifier $Global:SecureTI -ErrorLimit 20 48 | Connect-AtwsWebAPI -AtwsModuleConfiguration $Config 49 | 50 | #Error 2: 51 | $Config = New-AtwsModuleConfiguration -Credential $Global:SandboxCredential -SecureTrackingIdentifier $Global:SecureTI -ErrorLimit 20 52 | 53 | Connect-AtwsWebAPI -AtwsModuleConfigurationName Pester 54 | 55 | $Products = Get-AtwsInstalledProduct -Type Firewall 56 | $cont = $false 57 | $Products[0].psobject.Properties.name.ForEach{ 58 | if ($_ -match '#') { 59 | $cont = $true 60 | } 61 | } 62 | if (-not $Cont) { 63 | Write-Error "fix this" 64 | } 65 | 66 | #Error 3: 67 | $Devices = Get-AtwsInstalledProduct -Type Server -Active $true 68 | $Devices.Count | Should -BeGreaterThan 600 69 | 70 | $Req1 = Set-AtwsInstalledProduct -InputObject $Devices -UserDefinedFields @{Name = 'Sist logget inn'; Value = 'Pester UDF test var her.' } -PassThru 71 | 72 | # TODO: UseCase: now restore old data. Should be able to run Set-AtwsInstalledProduct -InputObject $Devices right? 73 | $Req2 = Set-AtwsInstalledProduct -InputObject $Devices -PassThru 74 | 75 | $AfterModifications = Get-AtwsInstalledProduct -id $Devices.id 76 | 77 | 78 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsContractExclusionSet.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsContractExclusionSet 9 | 10 | ## SYNOPSIS 11 | This function deletes a ContractExclusionSet through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsContractExclusionSet [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsContractExclusionSet -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a ContractExclusionSet through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsContractExclusionSet [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: ContractExclusionSet[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.ContractExclusionSet[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.ContractExclusionSet that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsContractExclusionSet 113 | Get-AtwsContractExclusionSet 114 | Set-AtwsContractExclusionSet 115 | 116 | ## RELATED LINKS 117 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsInstalledProductType.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsInstalledProductType 9 | 10 | ## SYNOPSIS 11 | This function deletes a InstalledProductType through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsInstalledProductType [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsInstalledProductType -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a InstalledProductType through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsInstalledProductType [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: InstalledProductType[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.InstalledProductType[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.InstalledProductType that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsInstalledProductType 113 | Get-AtwsInstalledProductType 114 | Set-AtwsInstalledProductType 115 | 116 | ## RELATED LINKS 117 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsServiceCallTaskResource.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsServiceCallTaskResource 9 | 10 | ## SYNOPSIS 11 | This function deletes a ServiceCallTaskResource through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsServiceCallTaskResource [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsServiceCallTaskResource -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a ServiceCallTaskResource through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsServiceCallTaskResource [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: ServiceCallTaskResource[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.ServiceCallTaskResource[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.ServiceCallTaskResource that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsServiceCallTaskResource 113 | Get-AtwsServiceCallTaskResource 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketAdditionalContact.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketAdditionalContact 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketAdditionalContact through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketAdditionalContact [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsTicketAdditionalContact -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a TicketAdditionalContact through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsTicketAdditionalContact [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: TicketAdditionalContact[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.TicketAdditionalContact[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.TicketAdditionalContact that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsTicketAdditionalContact 113 | Get-AtwsTicketAdditionalContact 114 | 115 | ## RELATED LINKS 116 | -------------------------------------------------------------------------------- /Docs/Remove-AtwsTicketSecondaryResource.md: -------------------------------------------------------------------------------- 1 | --- 2 | external help file: Autotask-help.xml 3 | Module Name: Autotask 4 | online version: 5 | schema: 2.0.0 6 | --- 7 | 8 | # Remove-AtwsTicketSecondaryResource 9 | 10 | ## SYNOPSIS 11 | This function deletes a TicketSecondaryResource through the Autotask Web Services API. 12 | 13 | ## SYNTAX 14 | 15 | ### Input_Object (Default) 16 | ``` 17 | Remove-AtwsTicketSecondaryResource [-InputObject ] [-WhatIf] [-Confirm] 18 | [] 19 | ``` 20 | 21 | ### By_parameters 22 | ``` 23 | Remove-AtwsTicketSecondaryResource -Id [-WhatIf] [-Confirm] [] 24 | ``` 25 | 26 | ## DESCRIPTION 27 | This function deletes a TicketSecondaryResource through the Autotask Web Services API. 28 | 29 | Entities that have fields that refer to the base entity of this CmdLet: 30 | 31 | ## EXAMPLES 32 | 33 | ### EXAMPLE 1 34 | ``` 35 | Remove-AtwsTicketSecondaryResource [-ParameterName] [Parameter value] 36 | ``` 37 | 38 | ## PARAMETERS 39 | 40 | ### -InputObject 41 | Any objects that should be deleted 42 | 43 | ```yaml 44 | Type: TicketSecondaryResource[] 45 | Parameter Sets: Input_Object 46 | Aliases: 47 | 48 | Required: False 49 | Position: Named 50 | Default value: None 51 | Accept pipeline input: True (ByValue) 52 | Accept wildcard characters: False 53 | ``` 54 | 55 | ### -Id 56 | The unique id of an object to delete 57 | 58 | ```yaml 59 | Type: Int64[] 60 | Parameter Sets: By_parameters 61 | Aliases: 62 | 63 | Required: True 64 | Position: Named 65 | Default value: None 66 | Accept pipeline input: False 67 | Accept wildcard characters: False 68 | ``` 69 | 70 | ### -WhatIf 71 | Shows what would happen if the cmdlet runs. 72 | The cmdlet is not run. 73 | 74 | ```yaml 75 | Type: SwitchParameter 76 | Parameter Sets: (All) 77 | Aliases: wi 78 | 79 | Required: False 80 | Position: Named 81 | Default value: None 82 | Accept pipeline input: False 83 | Accept wildcard characters: False 84 | ``` 85 | 86 | ### -Confirm 87 | Prompts you for confirmation before running the cmdlet. 88 | 89 | ```yaml 90 | Type: SwitchParameter 91 | Parameter Sets: (All) 92 | Aliases: cf 93 | 94 | Required: False 95 | Position: Named 96 | Default value: None 97 | Accept pipeline input: False 98 | Accept wildcard characters: False 99 | ``` 100 | 101 | ### CommonParameters 102 | 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). 103 | 104 | ## INPUTS 105 | 106 | ### [Autotask.TicketSecondaryResource[]]. This function takes objects as input. Pipeline is supported. 107 | ## OUTPUTS 108 | 109 | ### Nothing. This fuction just deletes the Autotask.TicketSecondaryResource that was passed to the function. 110 | ## NOTES 111 | Related commands: 112 | New-AtwsTicketSecondaryResource 113 | Get-AtwsTicketSecondaryResource 114 | 115 | ## RELATED LINKS 116 | --------------------------------------------------------------------------------