Connect-HealthCheck

NAME Connect-HealthCheck



SYNOPSIS

The Connect-HealthCheck cmdlet store the API key for the HealthCheck module cmdlets.



Connect-HealthCheck will only store the API key, no validation is done.





SYNTAX

Connect-HealthCheck [-ApiKey] <String> [<CommonParameters>]





DESCRIPTION

The Connect-B2Cloud cmdlet is used to store the API key for the HealthCheck cmdlets.



The API key can be obtained from your HealthCheck account page.





PARAMETERS

-ApiKey <String>

The API key to access the HealthCheck account.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String



This cmdlet takes the API key as a string.





OUTPUTS

None





NOTES





Connect-HealthCheck will only store the API key, no validation is done.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Connect-HealthCheck



The above cmdlet will prompt for the API key and save the API key for use in the other HealthCheck modules.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Connect-B2Cloud -ApiKey YOUR_API_KEY



The above cmdlet will take the given API key and save the API key for use in the other HealthCheck modules.











RELATED LINKS

https://healthchecks.io/docs/