Api/LEWorkloadApi.ps1
|
# # Login Enterprise # v7.0-preview [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v7-preview), [Documentation (ReDoc)](/publicApi/v7-preview/docs/index.html) v6.0 [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v6), [Documentation (ReDoc)](/publicApi/v6/docs/index.html) v5.0 [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v5), [Documentation (ReDoc)](/publicApi/v5/docs/index.html) v4.0 [API Console (Swagger)](/publicApi/swagger/index.html?urls.primaryName=Login%20Enterprise%20API%20v4), [Documentation (ReDoc)](/publicApi/v4/docs/index.html) <br><b>API v7 (preview) – Introduced in Login Enterprise v5.0 and subject to breaking changes when API v7 becomes generally available.</b></br> <br><b>API v6 – is the recommended version to use. It is the actively developed version starting with Login Enterprise v4.10.</b></br> <br><b>API v5 – is currently supported but unmaintained as of v4.10.</b></br> <br><b>API v4 – is deprecated starting with v4.10. Will be removed in Q3 2023.</b></br> The Login Enterprise Public API provides documentation and Swagger per version within the product. For additional information please refer to the [documentation](https://support.loginvsi.com/hc/en-us/articles/360009534760) on our website. # Version: 6.0 # Generated by OpenAPI Generator: https://openapi-generator.tech # <# .SYNOPSIS Add test-workload steps .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER ConfigurationReplaceApplicationGroupStepsRequestInner List of step data .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function New-LETestWorkloadSteps { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject[]] ${ConfigurationReplaceApplicationGroupStepsRequestInner}, [Switch] $WithHttpInfo ) Process { 'Calling method: New-LETestWorkloadSteps' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling createTestWorkloadSteps." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) if (!$ConfigurationReplaceApplicationGroupStepsRequestInner) { throw "Error! The required parameter `ConfigurationReplaceApplicationGroupStepsRequestInner` missing when calling createTestWorkloadSteps." } $LocalVarBodyParameter = $ConfigurationReplaceApplicationGroupStepsRequestInner | ConvertTo-Json -Depth 100 if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'POST' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Remove test-workload step .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER StepId Step id .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Invoke-LEDeleteTestWorkloadStep { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${StepId}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-LEDeleteTestWorkloadStep' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload/{stepId}' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling deleteTestWorkloadStep." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) if (!$StepId) { throw "Error! The required parameter `StepId` missing when calling deleteTestWorkloadStep." } $LocalVarUri = $LocalVarUri.replace('{stepId}', [System.Web.HTTPUtility]::UrlEncode($StepId)) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Remove test-workload steps .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER RequestBody Step ids .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Invoke-LEDeleteTestWorkloadSteps { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String[]] ${RequestBody}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-LEDeleteTestWorkloadSteps' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling deleteTestWorkloadSteps." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) if (!$RequestBody) { throw "Error! The required parameter `RequestBody` missing when calling deleteTestWorkloadSteps." } $LocalVarBodyParameter = $RequestBody | ConvertTo-Json -Depth 100 if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'DELETE' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Get test-workload by test id .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS Workload #> function Get-LETestWorkload { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Switch] $WithHttpInfo ) Process { 'Calling method: Get-LETestWorkload' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling getTestWorkload." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'GET' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "Workload" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Replace test-workload steps .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER ConfigurationReplaceApplicationGroupStepsRequestInner List of step data .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Invoke-LEReplaceTestWorkloadSteps { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject[]] ${ConfigurationReplaceApplicationGroupStepsRequestInner}, [Switch] $WithHttpInfo ) Process { 'Calling method: Invoke-LEReplaceTestWorkloadSteps' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling replaceTestWorkloadSteps." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) $LocalVarBodyParameter = $ConfigurationReplaceApplicationGroupStepsRequestInner | ConvertTo-Json -Depth 100 if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $true if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } <# .SYNOPSIS Update test-workload step .DESCRIPTION No description available. .PARAMETER TestId Test id .PARAMETER StepId Step id .PARAMETER ConfigurationUpdateTestWorkloadStepRequest Step data .PARAMETER WithHttpInfo A switch when turned on will return a hash table of Response, StatusCode and Headers instead of just the Response .OUTPUTS None #> function Update-LETestWorkloadStep { [CmdletBinding()] Param ( [Parameter(Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${TestId}, [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [String] ${StepId}, [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true, Mandatory = $false)] [PSCustomObject] ${ConfigurationUpdateTestWorkloadStepRequest}, [Switch] $WithHttpInfo ) Process { 'Calling method: Update-LETestWorkloadStep' | Write-Debug $PSBoundParameters | Out-DebugParameter | Write-Debug $LocalVarAccepts = @() $LocalVarContentTypes = @() $LocalVarQueryParameters = @{} $LocalVarHeaderParameters = @{} $LocalVarFormParameters = @{} $LocalVarPathParameters = @{} $LocalVarCookieParameters = @{} $LocalVarBodyParameter = $null $Configuration = Get-LEConfiguration # HTTP header 'Accept' (if needed) $LocalVarAccepts = @('application/json') # HTTP header 'Content-Type' $LocalVarContentTypes = @('application/json') $LocalVarUri = '/v6/tests/{testId}/workload/{stepId}' if (!$TestId) { throw "Error! The required parameter `TestId` missing when calling updateTestWorkloadStep." } $LocalVarUri = $LocalVarUri.replace('{testId}', [System.Web.HTTPUtility]::UrlEncode($TestId)) if (!$StepId) { throw "Error! The required parameter `StepId` missing when calling updateTestWorkloadStep." } $LocalVarUri = $LocalVarUri.replace('{stepId}', [System.Web.HTTPUtility]::UrlEncode($StepId)) if (!$ConfigurationUpdateTestWorkloadStepRequest) { throw "Error! The required parameter `ConfigurationUpdateTestWorkloadStepRequest` missing when calling updateTestWorkloadStep." } $LocalVarBodyParameter = $ConfigurationUpdateTestWorkloadStepRequest | ConvertTo-Json -Depth 100 if ($Configuration["ApiKey"] -and $Configuration["ApiKey"]["Authorization"]) { $LocalVarHeaderParameters['Authorization'] = $Configuration["ApiKey"]["Authorization"] Write-Verbose ("Using API key 'Authorization' in the header for authentication in {0}" -f $MyInvocation.MyCommand) } $LocalVarResult = Invoke-LEApiClient -Method 'PUT' ` -Uri $LocalVarUri ` -Accepts $LocalVarAccepts ` -ContentTypes $LocalVarContentTypes ` -Body $LocalVarBodyParameter ` -HeaderParameters $LocalVarHeaderParameters ` -QueryParameters $LocalVarQueryParameters ` -FormParameters $LocalVarFormParameters ` -CookieParameters $LocalVarCookieParameters ` -ReturnType "" ` -IsBodyNullable $false if ($WithHttpInfo.IsPresent) { return $LocalVarResult } else { return $LocalVarResult["Response"] } } } |