internal/Get-JcSdkInternalNextScheduledBulkUserState.ps1
|
# ---------------------------------------------------------------------------------- # Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.6.6, generator: @autorest/powershell@3.0.463) # Changes may cause incorrect behavior and will be lost if the code is regenerated. # ---------------------------------------------------------------------------------- <# .Synopsis This endpoint is used to lookup the next upcoming scheduled state change for each user in the\ngiven list. The users parameter is limited to 100 items per request. The results are also limited\nto 100 items. This endpoint returns a max of 1 event per state per user. For example, if a user\nhas 3 ACTIVATED events scheduled it will return the next upcoming activation event. However, if a\nuser also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next\nupcoming activation event _and_ the next upcoming suspension event. .Description This endpoint is used to lookup the next upcoming scheduled state change for each user in the\ngiven list. The users parameter is limited to 100 items per request. The results are also limited\nto 100 items. This endpoint returns a max of 1 event per state per user. For example, if a user\nhas 3 ACTIVATED events scheduled it will return the next upcoming activation event. However, if a\nuser also has a SUSPENDED event scheduled along with the ACTIVATED events it will return the next\nupcoming activation event _and_ the next upcoming suspension event. .Example PS C:\> {{ Add code here }} {{ Add output here }} .Example PS C:\> {{ Add code here }} {{ Add output here }} .Outputs JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema .Link https://github.com/TheJumpCloud/jcapi-powershell/tree/master/SDKs/PowerShell/JumpCloud.SDK.V2/docs/exports/Get-JcSdkInternalNextScheduledBulkUserState.md #> function Get-JcSdkInternalNextScheduledBulkUserState { [OutputType([JumpCloud.SDK.V2.Models.IPathsUbbqf1BulkUserstatesEventlistNextGetResponses200ContentApplicationJsonSchema])] [CmdletBinding(DefaultParameterSetName='Get', PositionalBinding=$false)] param( [Parameter(Mandatory)] [AllowEmptyCollection()] [JumpCloud.SDK.V2.Category('Query')] [System.String[]] # A list of system user IDs, limited to 100 items. ${Users}, [Parameter()] [JumpCloud.SDK.V2.Category('Query')] [System.Int32] # The number of records to return at once. # Limited to 100. ${Limit}, [Parameter()] [JumpCloud.SDK.V2.Category('Query')] [System.Int32] # The offset into the records to return. ${Skip}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Wait for .NET debugger to attach ${Break}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be appended to the front of the pipeline ${HttpPipelineAppend}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [JumpCloud.SDK.V2.Runtime.SendAsyncStep[]] # SendAsync Pipeline Steps to be prepended to the front of the pipeline ${HttpPipelinePrepend}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Uri] # The URI for the proxy server to use ${Proxy}, [Parameter(DontShow)] [ValidateNotNull()] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.PSCredential] # Credentials for a proxy server to use for the remote call ${ProxyCredential}, [Parameter(DontShow)] [JumpCloud.SDK.V2.Category('Runtime')] [System.Management.Automation.SwitchParameter] # Use the default credentials for the proxy ${ProxyUseDefaultCredentials} ) begin { try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref]$outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $parameterSet = $PSCmdlet.ParameterSetName $mapping = @{ Get = 'JumpCloud.SDK.V2.private\Get-JcSdkInternalNextScheduledBulkUserState_Get'; } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand(($mapping[$parameterSet]), [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = {& $wrappedCmd @PSBoundParameters} $steppablePipeline = $scriptCmd.GetSteppablePipeline($MyInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { try { $steppablePipeline.End() } catch { throw } } } |