Skip to content

Get-GitHubScheduledMaintenance

SYNOPSIS

Gets the status of GitHub scheduled maintenance

SYNTAX

__AllParameterSets

Get-GitHubScheduledMaintenance [[-Stamp] <string>] [-Active] [-Upcoming] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Scheduled maintenances are planned outages, upgrades, or general notices that you're working on infrastructure and disruptions may occurr. A close sibling of Incidents, each usually goes through a progression of statuses listed below, with an impact calculated from a blend of component statuses (or an optional override).

Status: Scheduled, In Progress, Verifying, or Completed Impact: None (black), Minor (yellow), Major (orange), or Critical (red)

EXAMPLES

EXAMPLE 1

Get-GitHubScheduledMaintenance

Get a list of the 50 most recent scheduled maintenances. This includes scheduled maintenances as described in the above two endpoints, as well as those in the Completed state.

EXAMPLE 2

Get-GitHubScheduledMaintenance -Active

Get a list of any active maintenances.

EXAMPLE 3

Get-GitHubScheduledMaintenance -Upcoming

Get a list of any upcoming maintenances.

PARAMETERS

-Active

Get a list of any active maintenances. This endpoint will only return scheduled maintenances in the In Progress or Verifying state.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Stamp

The stamp to check status for.

Type: System.String
DefaultValue: Public
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Upcoming

Get a list of any upcoming maintenances. This endpoint will only return scheduled maintenances still in the Scheduled state.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Scheduled maintenances