Get-ImmyComputersPaged
| Detail |
Value |
| Class |
PSImmyBot.Cmdlets.GetComputersPaged |
| Source |
Cmdlets/GetComputersPaged.cs |
| HTTP Method |
GET |
| Endpoint |
/api/v1/computers/paged? |
| Return Type |
ComputerPageResponse |
| SupportsShouldProcess |
False |
| SupportsPaging |
False |
| SupportsTransactions |
False |
| ConfirmImpact |
None |
| Default Parameter Set |
None |
Behavior
- Calls
ImmyBotApiService.GET targeting /api/v1/computers/paged? and deserializes to ComputerPageResponse.
- Builds query strings using
Globals.ConvertToQueryParameters to keep parameter encoding consistent.
Parameters
| Name |
Type |
Mandatory |
Position |
Parameter Sets |
Pipeline Input |
| DeletedOnly |
Nullable1` |
False |
— |
All |
None |
| DevLabOnly |
Nullable1` |
False |
— |
All |
None |
| Filter |
String |
False |
— |
All |
None |
| IncludeOffline |
Nullable1` |
False |
— |
All |
None |
| LicensedOnly |
Nullable1` |
False |
— |
All |
None |
| OnboardingOnly |
Nullable1` |
False |
— |
All |
None |
| Skip |
Nullable1` |
False |
— |
All |
None |
| Sort |
String |
False |
— |
All |
None |
| SortDesc |
Nullable1` |
False |
— |
All |
None |
| StaleOnly |
Nullable1` |
False |
— |
All |
None |
| Take |
Nullable1` |
False |
— |
All |
None |
| TenantId |
Nullable1` |
False |
— |
All |
None |
Parameter sets
Outputs
Notes
This documentation was generated automatically by HelperScripts/GenerateDocs.ps1 by analyzing the cmdlet source and compiled metadata.