Public/Get-HealthCheck.ps1
|
function Get-HealthCheck { <# .SYNOPSIS The Get-HealthCheck cmdlet will list all checks associated with the account. .DESCRIPTION The Get-HealthCheck cmdlet will list all checks associated with the account. An API key is required to use this cmdlet. .EXAMPLE Get-HealthCheck Grace : 900 LastPing : Saturday, July 9, 2016 6:58:43 AM PingCount : 1 Name : Api test 1 NextPing : Saturday, July 9, 2016 7:58:43 AM PingURL : https://hchk.io/25c55e7c-8092-4d21-ad06-7dacfbb6fc10 Tags : foo Timeout : 3600 Grace : 60 LastPing : PingCount : 0 Name : Api test 2 NextPing : PingURL : https://hchk.io/7e1b6e61-b16f-4671-bae3-e3233edd1b5e Tags : bar baz Timeout : 60 The cmdlet above will return all checks for the account. .EXAMPLE PS C:\>Get-B2Bucket | Where-Object {$_.Name -eq 'Api test 2'} Grace : 60 LastPing : PingCount : 0 Name : Api test 2 NextPing : PingURL : https://hchk.io/7e1b6e61-b16f-4671-bae3-e3233edd1b5e Tags : bar baz Timeout : 60 The cmdlet above will return all buckets and search for the one with a name of "Api test 2". .INPUTS System.String This cmdlet takes the AccountID and ApplicationKey as strings. .OUTPUTS .LINK https://healthchecks.io/docs/ .ROLE PS.HealthChecks .FUNCTIONALITY PS.HealthChecks #> [CmdletBinding(SupportsShouldProcess=$false, PositionalBinding)] [Alias()] [OutputType()] Param ( # The Api key for your account. [Parameter(Mandatory=$false)] [ValidateNotNull()] [ValidateNotNullOrEmpty()] [Uri]$ApiKey = $script:SavedHealthCheckApi ) Begin { if($ApiKey -eq $null) { throw 'The API key needs to be specified.' } [Hashtable]$sessionHeaders = @{'X-Api-Key'=$ApiKey} [Uri]$hchkApiUri = 'https://healthchecks.io/api/v1/checks/' } Process { $hchkInfo = Invoke-RestMethod -Method Get -Uri $hchkApiUri -Headers $sessionHeaders foreach($info in $hchkInfo.checks) { $hchkReturnInfo = [PSCustomObject]@{ 'Name' = $info.name 'Tag' = $info.tags 'Timeout' = $info.timeout 'Grace' = $info.grace 'PingURL' = $info.ping_url 'PingCount' = $info.n_pings 'LastPing' = $info.last_ping 'NextPing' = $info.next_ping } Write-Output $hchkReturnInfo } } } |