Skip to main content

Add-VSTeamBanner

SYNOPSIS​

Adds a new banner message to an Azure DevOps organization.

SYNTAX​

Add-VSTeamBanner -Message <String> -Level <String> -ExpirationDate <DateTime> [-Id <String>]
 [<CommonParameters>]

DESCRIPTION​

Adds a new banner message to an Azure DevOps organization.

EXAMPLES​

Example 1​

Add-VSTeamBanner -Level info -Message 'Test Message' -ExpirationDate '2024-01-01T04:00' -Id '9547ed55-66e1-403d-95aa-9e628726861c'

PARAMETERS​

-Level​

The level of the banner message. The acceptable values for this parameter are:

  • info
  • warning
  • error
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Message​

The message content to be displayed on the banner.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ExpirationDate​

The expiration date of the banner in the format `yyyy-mm-ddThh:mm`.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

The unique identifier for the banner.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

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

INPUTS​

OUTPUTS​

System.Object​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version

Remove-VSTeamBanner

Update-VSTeamBanner