Skip to main content

Get-VSTeamBanner

SYNOPSIS

Retrieves a banner from Azure DevOps based on its ID.

SYNTAX

Get-VSTeamBanner [-Id <String>] [<CommonParameters>]

DESCRIPTION

Retrieves a banner from Azure DevOps based on its ID.

EXAMPLES

Example 1

Get-VSTeamBanner -Id '12345'

Returns the banner with the specified ID.

PARAMETERS

-Id

The ID of 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

PSCustomObject

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