Skip to main content

Get-VSTeamDescriptor

SYNOPSIS

Resolve a storage key to a descriptor.

SYNTAX

Get-VSTeamDescriptor [-StorageKey] <String> [<CommonParameters>]

DESCRIPTION

Resolve a storage key to a descriptor.

EXAMPLES

Example 1

Get-VSTeamDescriptor -StorageKey "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"

This command retrieves the descriptor associated with the provided storage key.

Example 2

"a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" | Get-VSTeamDescriptor

This example demonstrates how to pipe a storage key string directly to `Get-VSTeamDescriptor` to obtain the corresponding descriptor.

PARAMETERS

-StorageKey

Storage key of the subject (user, group, scope, etc.) to resolve

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
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

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