Lib/Core/TfsCmdlets.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>TfsCmdlets</name> </assembly> <members> <member name="T:TfsCmdlets.AssemblyResolver"> <summary> This class is used to resolve TfsCmdlets assemblies in runtime. </summary> </member> <member name="P:TfsCmdlets.AssemblyResolver.Assemblies"> <summary> Mantains a list of all assemblies stored in the /Lib folder of this module to support on-demand assembly resolving and loading </summary> </member> <member name="M:TfsCmdlets.AssemblyResolver.Register"> <summary> Registers the Assembly Resolver in the platform-specific assembly resolution mechanism and loads the list of private assemblies to the Assemblies dictionary </summary> </member> <member name="T:TfsCmdlets.AssemblyResolver.AssemblyEntry"> <summary> Represents a private assembly </summary> </member> <member name="M:TfsCmdlets.AssemblyResolver.AssemblyEntry.#ctor(System.String,System.String)"> <summary> Creates an instance from an assembly name and its file path </summary> <param name="name">Assembly name (e.g. "Newtonsoft.json")</param> <param name="path">Full path to assembly file (e.g. "X:/path/to/module/Lib/Newtonsoft.json")</param> </member> <member name="P:TfsCmdlets.AssemblyResolver.AssemblyEntry.Name"> <summary> Assembly name </summary> </member> <member name="P:TfsCmdlets.AssemblyResolver.AssemblyEntry.Path"> <summary> Full path to assembly file </summary> </member> <member name="P:TfsCmdlets.AssemblyResolver.AssemblyEntry.IsLoaded"> <summary> Indicates whether this assembly has already been loaded by the Assembly Resolver </summary> </member> <member name="P:TfsCmdlets.AssemblyResolver.AssemblyEntry.Assembly"> <summary> The actual assembly represented by this instance. If the assembly wasn't previously loaded, it will be read from disk and returned to the caller </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.GetConfigurationConnectionString"> <summary> Gets the configuration server database connection string. </summary> <related uri="https://tfscmdlets.dev/admin/get-tfsconfigurationConnectionstring/">Online version:</related> <related>Get-TfsInstallationPath</related> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetConfigurationConnectionString.ComputerName"> <summary> Specifies the name of a Team Foundation Server application tier from which to retrieve the connection string. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetConfigurationConnectionString.Session"> <summary> The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetConfigurationConnectionString.Version"> <summary> The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetConfigurationConnectionString.Credential"> <summary> The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.GetInstallationPath"> <summary> Gets the installation path of a given Team Foundation Server component. </summary> <remarks> Many times a Team Foundation Server admin needs to retrieve the location where TFS is actually installed. That can be useful, for instance, to locate tools like TfsSecurity or TfsServiceControl. That information is recorded at setup time, in a well-known location in the Windows Registry of the server where TFS is installed. </remarks> <example> <code>Get-TfsInstallationPath -Version 2017</code> <para>Gets the root folder (the BaseInstallationPath) of TFS in the local server where the cmdlet is being run</para> </example> <example> <code>Get-TfsInstallationPath -Computer SPTFSSRV -Version 2015 -Component SharepointExtensions -Credentials (Get-Credentials)</code> <para>Gets the location where the SharePoint Extensions have been installed in the remote server SPTFSSRV, prompting for admin credentials to be used for establishing a PS Remoting session to the server</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.ComputerName"> <summary> The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.Session"> <summary> The machine name of the server where the TFS component is installed. It must be properly configured for PowerShell Remoting in case it's a remote machine. Optionally, a System.Management.Automation.Runspaces.PSSession object pointing to a previously opened PowerShell Remote session can be provided instead. When omitted, defaults to the local machine where the script is being run </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.Component"> <summary> Indicates the TFS component whose installation path is being searched for. For the main TFS installation directory, use BaseInstallation. When omitted, defaults to BaseInstallation. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.Version"> <summary> The TFS version number, represented by the year in its name. For e.g. TFS 2015, use "2015". When omitted, will default to the newest installed version of TFS / Azure DevOps Server </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.Credential"> <summary> The user credentials to be used to access a remote machine. Those credentials must have the required permission to execute a PowerShell Remote session on that computer and also the permission to access the Windows Registry. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.GetVersion"> <summary> Gets the version information about Team Foundation / Azure DevOps servers and Azure DevOps Services organizations. </summary> <remarks> The Get-TfsVersion cmdlet retrieves version information from the supplied team project collection or Azure DevOps organization. When available/applicable, detailed information about installed updates, deployed sprints and so on are also provided. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetVersion.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetVersion.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue"> <summary> Gets the value of a given Team Foundation Server registry entry. </summary> <remarks> The 'Get-TfsRegistry' cmdlet retrieves the value of a TFS registry entry at the given path and scope. Registry entries can be scoped to the server, to a collection or to a specific user. </remarks> <notes> The registry is an internal, hierarchical database that TFS uses to store its configuration and user-level settings and preferences. IMPORTANT: Retrieving user-scoped values is currently not supported. </notes> <example> <code>Get-TfsRegistryValue -Path '/Service/Integration/Settings/EmailEnabled'</code> <para>Gets the current value of the 'EmailEnabled' key in the TFS Registry</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue.Path"> <summary> Specifies the full path of the TFS Registry key </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue.Scope"> <summary> Specifies the scope under which to search for the key. When omitted, defaults to the Server scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue"> <summary> Sets the value of a given Team Foundation Server registry entry. </summary> <remarks> The 'Set-TfsRegistry' cmdlet changes the value of a TFS registry key to the value specified in the command. </remarks> <example> <code>Get-TfsRegistryValue -Path '/Service/Integration/Settings/EmailEnabled'</code> <para>Gets the current value of the 'EmailEnabled' key in the TFS Registry</para> </example> <notes> The registry is an internal, hierarchical database that TFS uses to store its configuration and user-level settings and preferences. IMPORTANT: Retrieving user-scoped values is currently not supported. </notes> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Path"> <summary> Specifies the full path of the TFS Registry key </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Value"> <summary> Specifies the new value of the Registry key. To remove an existing value, set it to $null </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Scope"> <summary> Specifies the scope under which to search for the key. When omitted, defaults to the Server scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Artifact.GetArtifact"> <summary> Gets information from one or more artifact feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.Artifact"> <summary> Specifies the package (artifact) name. Wildcards are supported. When omitted, returns all packages in the specified feed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.Feed"> <summary> Specifies the feed name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.IncludeDeleted"> <summary> Includes deletes packages in the result. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.IncludeDescription"> <summary> Includes the package description in the results. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.IncludePrerelease"> <summary> Includes prerelease packages in the results. Applies only to Nuget packages. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.IncludeDelisted"> <summary> Includes delisted packages in the results. Applies only to Nuget packages. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.ProtocolType"> <summary> Returns only packages of the specified protocol type. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifact.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed"> <summary> Gets information from one or more artifact feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Feed"> <summary> Specifies the feed name. Wildcards are supported. When omitted, returns all feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Scope"> <summary> Returns only feeds from the given scope (collection or project). When omitted, returns all feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Role"> <summary> Filters by role. Returns only those feeds where the currently logged on user has one of the specified roles: either Administrator, Contributor, or Reader level permissions. When omitted, filters by Administrator role. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeed.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView"> <summary> Gets information from one or more Git repositories in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.View"> <summary> Specifies the view name. Wildcards are supported. When omitted, returns all views. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Feed"> <summary> Specifies the parent feed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Scope"> <summary> Returns only feeds from the given scope (collection or project). When omitted, returns all feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Role"> <summary> Filters by role. Returns only those feeds where the currently logged on user has one of the specified roles: either Administrator, Contributor, or Reader level permissions. When omitted, filters by Administrator role. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactFeedView.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion"> <summary> Gets information from one or more artifact feeds. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Version"> <summary> Specifies the version to return. Wildcards are supported. When omitted, returns all versions of the specified package. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Artifact"> <summary> Specifies the package (artifact) name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Feed"> <summary> Specifies the feed name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.IncludeDeleted"> <summary> Includes deletes packages in the result. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.IncludeDelisted"> <summary> Includes delisted packages in the results. Applies only to Nuget packages. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.ProtocolType"> <summary> Returns only packages of the specified protocol type. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Artifact.GetArtifactVersion.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Credential.NewCredential"> <summary> Provides credentials to use when you connect to a Team Foundation Server or Azure DevOps organization. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.Url"> <summary> Specifies the URL of the server, collection or organization to connect to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Credential.NewCredential.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension"> <summary> Disables an extension installed in the specified collection/organization. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension.Extension"> <summary> Specifies the ID or the name of the extensions. Wilcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension.Publisher"> <summary> Specifies the ID or the name of the publisher. Wilcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.DisableExtension.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension"> <summary> Enables a previously disabled extension installed in the specified collection/organization. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension.Extension"> <summary> Specifies the ID or the name of the extensions. Wilcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension.Publisher"> <summary> Specifies the ID or the name of the publisher. Wilcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.EnableExtension.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension"> <summary> Gets one or more installed extensions in the specified collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension.Extension"> <summary> Specifies the ID or the name of the extensions. Wilcards are supported. When omitted, returns all extensions installed in the specified organization/collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension.Publisher"> <summary> Specifies the ID or the name of the publisher. Wilcards are supported. When omitted, returns all extensions installed in the specified organization/collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension.IncludeDisabledExtensions"> <summary> Includes disabled extensions in the result. When omitted, disabled extensions are not included in the result. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.GetExtension.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension"> <summary> Installs an extension in the specified organization/collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension.Extension"> <summary> Specifies the ID of the extension to install. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension.Publisher"> <summary> Specifies the ID of the publisher of the extension. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension.Version"> <summary> Specifies the version of the extension to install. When omitted, installs the latest version. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.InstallExtension.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ExtensionManagement.UninstallExtension"> <summary> Uninstalls one of more extensions from the specified organization/collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.UninstallExtension.Extension"> <summary> Specifies the ID of the extension to uninstall. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.UninstallExtension.Publisher"> <summary> Specifies the ID of the publisher of the extension. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.UninstallExtension.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ExtensionManagement.UninstallExtension.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch"> <summary> Gets information from one or more branches in a remote Git repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Branch"> <summary> Specifies the name of a branch in the supplied Git repository. Wildcards are supported. When omitted, all branches are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Default"> <summary> Returns the default branch in the given repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Repository"> <summary> HELP_PARAM_GIT_REPOSITORY </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch"> <summary> Removes from one or more branches from a remote Git repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch.Branch"> <summary> Specifies the name of a branch in the supplied Git repository. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch.Repository"> <summary> HELP_PARAM_GIT_REPOSITORY </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Branch.RemoveGitBranch.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit"> <summary> Gets information from one or more Git commits in a remote repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Author"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Committer"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.CompareVersion"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.FromCommit"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.FromDate"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.ItemPath"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.ToCommit"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.ToDate"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.ExcludeDeletes"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.IncludeLinks"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.IncludePushData"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.IncludeUserImageUrl"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.ShowOldestCommitsFirst"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Skip"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Top"> <summary> </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Repository"> <summary> HELP_PARAM_GIT_REPOSITORY </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Commit.GetGitCommit.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.DisableGitRepository"> <summary> Disables one or more Git repositories. </summary> <remarks> Disables access to the repository. When a repository is disabled it cannot be accessed (including clones, pulls, pushes, builds, pull requests etc) but remains discoverable, with a warning message stating it is disabled. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.Git.DisableGitRepository.Repository"> <summary> Specifies the name or ID of a Git repository. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.DisableGitRepository.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.DisableGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.DisableGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.DisableGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.EnableGitRepository"> <summary> Enables one or more Git repositories. </summary> <remarks> This cmdlets re-enables access to a repository. When a repository is disabled it cannot be accessed (including clones, pulls, pushes, builds, pull requests etc) but remains discoverable, with a warning message stating it is disabled. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.Git.EnableGitRepository.Repository"> <summary> Specifies the name or ID of a Git repository. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.EnableGitRepository.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.EnableGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.EnableGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.EnableGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.GetGitRepository"> <summary> Gets information from one or more Git repositories in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.Repository"> <summary> Specifies the name or ID of a Git repository. Wildcards are supported. When omitted, all Git repositories in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.Default"> <summary> Returns the default repository in the given team project. The default repository is the one that is created when a team project is created, and has the same name as the team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.IncludeParent"> <summary> Returns details about the repository's parent (forked) repository, if it has one. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.GetGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Item.GetGitItem"> <summary> Gets information from one or more items (folders and/or files) in a remote Git repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Item.GetGitItem.Item"> <summary> Specifies the path to items (folders and/or files) in the supplied Git repository. Wildcards are supported. When omitted, all items in the root of the Git repository are retrieved. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Item.GetGitItem.Repository"> <summary> HELP_PARAM_GIT_REPOSITORY </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Item.GetGitItem.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Item.GetGitItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Item.GetGitItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.NewGitRepository"> <summary> Creates a new Git repository in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.Repository"> <summary> Specifies the name of the new repository </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.ForkFrom"> <summary> Forks the specified reposity. To fork a repository from another team project, specify the repository name in the form "project/repository" or pass in the result of a previous call to Get-TfsGitRepository that returns the source repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.SourceBranch"> <summary> Forks the specified branch in the source repository. When omitted, forks all branches. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.NewGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy"> <summary> Gets the Git branch policy configuration of the given Git branches. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.PolicyType"> <summary> Specifies the policy type of the branch policy to return. Wildcards are supported. When omitted, all branch policies defined for the given branch are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.Branch"> <summary> Specifies the name of the branch to query for branch policies. When omitted, the default branch in the given repository is queried. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.Repository"> <summary> HELP_PARAM_GIT_REPOSITORY </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType"> <summary> Gets one or more Git branch policies supported by the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType.PolicyType"> <summary> Specifies the display name or ID of the policy type. Wildcards are supported. When omitted, all policy types supported by the given team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.RemoveGitRepository"> <summary> Deletes one or more Git repositories from a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RemoveGitRepository.Repository"> <summary> Specifies the repository to be deleted. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RemoveGitRepository.Force"> <summary> HELP_PARAM_FORCE_REMOVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RemoveGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RemoveGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RemoveGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Git.RenameGitRepository"> <summary> Renames a Git repository in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RenameGitRepository.Repository"> <summary> Specifies the repository to be renamed. Value can be the name or ID of a Git repository, as well as a Microsoft.TeamFoundation.SourceControl.WebApi.GitRepository object representing a Git repository. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RenameGitRepository.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RenameGitRepository.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RenameGitRepository.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Git.RenameGitRepository.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.GetIdentity"> <summary> Gets one or more identities that represents either users or groups in Azure DevOps. This cmdlets resolves legacy identity information for use with older APIs such as the Security APIs </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.GetIdentity.Identity"> <summary> Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.GetIdentity.QueryMembership"> <summary> Specifies how group membership information should be processed when the returned identity is a group. "Direct" fetches direct members (both users and groups) of the group. "Expanded" expands contained groups recursively and returns their contained users. "None" is the fastest option as it fetches no membership information. When omitted, defaults to Direct. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.GetIdentity.Current"> <summary> Returns an identity representing the user currently logged in to the Azure DevOps / TFS instance </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.GetIdentity.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.GetIdentity.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember"> <summary> Adds group members to an Azure DevOps group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember.Member"> <summary> Specifies the member (user or group) to add to the given group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember.Group"> <summary> Specifies the group to which the member is added. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.GetGroup"> <summary> Gets one or more Azure DevOps groups. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Group"> <summary> Specifies the group to be retrieved. Supported values are: Group name or ID. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Scope"> <summary> Specifies the scope under which to search for the group. When omitted, defaults to the Collection scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Recurse"> <summary> Searches recursively for groups in the scopes under the specified scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroup.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember"> <summary> Gets the members of a Azure DevOps group </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.Group"> <summary> Specifies the group fom which to get its members. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.Member"> <summary> Specifies the member (user or group) to get from the given group. Wildcards are supported. When omitted, all group members are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.Recurse"> <summary> Recursively expands all member groups, returning the users and/or groups contained in them </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.NewGroup"> <summary> Creates a new Azure DevOps group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Group"> <summary> Specifies the name of the new group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Description"> <summary> Specifies a description for the new group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Scope"> <summary> Specifies the scope under which to create the group. When omitted, defaults to the Collection scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.NewGroup.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup"> <summary> Removes an Azure DevOps group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup.Group"> <summary> Specifies the group to be removed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup.Scope"> <summary> Specifies the scope under which to search for the group. When omitted, defaults to the Collection scope. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroup.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember"> <summary> Removes a member from an Azure DevOps group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember.Member"> <summary> Specifies the member (user or group) to remove from the given group. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember.Group"> <summary> Specifies the group from which the member is removed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.User.GetUser"> <summary> Gets information about one or more Azure DevOps users. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.User.GetUser.User"> <summary> Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.User.GetUser.Current"> <summary> Returns an identity representing the user currently logged in to the Azure DevOps / TFS instance </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.User.GetUser.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Identity.User.GetUser.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Organization.ConnectOrganization"> <summary> Connects to an Azure DevOps organization or a TFS Team Project Collection. </summary> <remarks> The Connect-TfsOrganization cmdlet connects to an Azure DevOps organization or a TFS Team Project Collection. That connection can be later reused by other TfsCmdlets commands until it's closed by a call to Disconnect-TfsOrganization. </remarks> <notes> Most cmdlets in the TfsCmdlets module require a Collection object to be provided via their -Collection argument in order to access a TFS instance. Those cmdlets will use the connection opened by Connect-TfsOrganization as their "default connection". In other words, TFS cmdlets (e.g. New-TfsWorkItem) that have a -Collection argument will use the connection provided by Connect-TfsOrganization by default. </notes> <example> <code>Connect-TfsOrganization -Collection http://tfs:8080/tfs/DefaultCollection</code> <para>Connects to a collection called "DefaultCollection" in a TF server called "tfs" using the cached credentials of the logged-on user</para> </example> <example> <code>Connect-TfsOrganization -Collection http://tfs:8080/tfs/DefaultCollection -Interactive</code> <para>Connects to a collection called "DefaultCollection" in a Team Foundation server called "tfs", firstly prompting the user for credentials (it ignores the cached credentials for the currently logged-in user). It's equivalent to the command: `Connect-TfsOrganization -Collection http://tfs:8080/tfs/DefaultCollection -Credential (Get-TfsCredential -Interactive)` </para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Organization"> <summary> Specifies the URL to the Azure DevOps Organization or Team Project Collection to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organization by simply providing its name instead of the full URL. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.ConnectOrganization.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Organization.DisconnectOrganization"> <summary> Disconnects from the currently connected Azure DevOps organization. </summary> <remarks> The Disconnect-TfsOrganization cmdlet removes the connection previously set by its counterpart Connect-TfsOrganization. Therefore, cmdlets relying on a "default organization/collection" as provided by "Get-TfsOrganization -Current" will no longer work after a call to this cmdlet, unless their -Collection argument is provided or a new call to Connect-TfsTeam is made. </remarks> </member> <member name="T:TfsCmdlets.Cmdlets.Organization.GetOrganization"> <summary> Gets one of more team project collections (organizations in Azure DevOps). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Organization"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Current"> <summary> Returns the organization specified in the last call to Connect-TfsOrganization (i.e. the "current" organization) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Organization.GetOrganization.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition"> <summary> Disables a build/pipeline definition. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition.Definition"> <summary> Specifies the pipeline name/path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.DisableBuildDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition"> <summary> Enables a previously disabled build/pipeline definition. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition.Definition"> <summary> Specifies the pipeline name/path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.EnableBuildDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition"> <summary> Gets one or more build/pipeline definitions in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition.Definition"> <summary> Specifies the pipeline path. Wildcards are supported. When omitted, all pipelines definitions in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition.QueryOrder"> <summary> Specifies the query order. When omitted, defaults to None. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.GetBuildDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.ResumeBuildDefinition"> <summary> Resumes (unpauses) a previously suspended build/pipeline definition. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.ResumeBuildDefinition.Definition"> <summary> Specifies the pipeline name/path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.ResumeBuildDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.ResumeBuildDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.ResumeBuildDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.SuspendBuildDefinition"> <summary> Suspends (pauses) a build/pipeline definition. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.SuspendBuildDefinition.Definition"> <summary> Specifies the pipeline name/path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.SuspendBuildDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.SuspendBuildDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Definition.SuspendBuildDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder"> <summary> Gets one or more build/pipeline definition folders in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder.Folder"> <summary> Specifies the folder path. Wildcards are supported. When omitted, all build/pipeline folders in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder.QueryOrder"> <summary> Specifies the query order. When omitted, defaults to None. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.GetBuildDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder"> <summary> Creates a new build/pipeline definition folder </summary> <remarks> Folders are created recursively - i.e. when specifying a path like '\foo\bar\baz', if any of the parent folders (foo, foo\bar) does not exist, it is automatically created before creating any child folders. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Folder"> <summary> Specifies the path of the new pipeline/build folder, including its name, separated by backslashes (\). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Description"> <summary> Specifies the description of the new build/pipeline folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.NewBuildDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder"> <summary> Deletes one or more build/pipeline definition folders. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Folder"> <summary> Specifies the path of the pipeline/build folder to delete, including its name, separated by backslashes (\). Wildcards are supperted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Recurse"> <summary> Removes folders recursively. When omitted, folders with subfolders cannot be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Force"> <summary> Forces the exclusion of folders containing build/pipelines definitions. When omitted, only empty folders can be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.Folder.RemoveBuildDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.StartBuild"> <summary> Gets one or more build/pipeline definitions in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.StartBuild.Definition"> <summary> Specifies the pipeline to start. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.StartBuild.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.StartBuild.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.StartBuild.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinition"> <summary> Gets information from one or more release definitions in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinition.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinition.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinition.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder"> <summary> Gets one or more Release/pipeline definition folders in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder.Folder"> <summary> Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder.QueryOrder"> <summary> Specifies the query order. When omitted, defaults to None. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder"> <summary> Creates a new release definition folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Folder"> <summary> Specifies the folder path. Wildcards are supported. When omitted, all Release/pipeline folders in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Description"> <summary> Specifies the description of the new build/pipeline folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.NewReleaseDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder"> <summary> Deletes one or more release definition folders. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Folder"> <summary> Specifies the path of the release folder to delete. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Recurse"> <summary> Removes folders recursively. When omitted, folders with subfolders cannot be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Force"> <summary> Forces the exclusion of folders containing release definitions definitions. When omitted, only empty folders can be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate"> <summary> Exports a XML-based process template definition to disk. </summary> <remarks> This cmdlet offers a functional replacement to the "Export Process Template" feature found in Team Explorer. All files pertaining to the specified process template (work item defininitons, reports, saved queries, process configuration and so on) are downloaded from the given Team Project Collection and saved in a local directory, preserving the directory structure required to later re-import it. This is specially handy to do small changes to a process template or to create a new process template based on an existing one. </remarks> <example> <code>Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection</code> <para>Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\Scrum directory in the local computer.</para> </example> <example> <code>Export-TfsProcessTemplate -Process "Scrum" -DestinationPath C:\PT -Collection http://vsalm:8080/tfs/DefaultCollection -NewName "MyScrum" -NewDescription "A customized version of the Scrum process template"</code> <para>Exports the Scrum process template from the DefaultCollection project collection in the VSALM server, saving the template files to the C:\PT\MyScrum directory in the local computer. Notice that the process template is being renamed from Scrum to MyScrum, so that it can be later reimported as a new process template instead of overwriting the original one.</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.ProcessTemplate"> <summary> Specifies the name of the process template(s) to be exported. Wildcards are supported. When omitted, all process templates in the given project collection are exported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.DestinationPath"> <summary> Path to the target directory where the exported process template (and related files) will be saved. A folder with the process template name will be created under this path. When omitted, templates are exported in the current directory. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.NewName"> <summary> Saves the exported process template with a new name. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original name is used. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.NewDescription"> <summary> Saves the exported process template with a new description. Useful when exporting a base template which will be used as a basis for a new process template. When omitted, the original description is used. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.Force"> <summary> Allows the cmdlet to overwrite an existing destination folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ProcessTemplate.GetProcessTemplate"> <summary> Gets information from one or more process templates. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.GetProcessTemplate.ProcessTemplate"> <summary> Specifies the name of the process template(s) to be returned. Wildcards are supported. When omitted, all process templates in the given project collection are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.GetProcessTemplate.Default"> <summary> Returns the default process template in the given orgnization / project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.GetProcessTemplate.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.GetProcessTemplate.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate"> <summary> Imports a process template definition from disk. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate.Path"> <summary> Specifies the folder containing the process template to be imported. This folder must contain the file ProcessTemplate.xml </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate.State"> <summary> Specifies the state of the template after it is imported. When set to Invisible, the process template will not be listed in the server UI. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate"> <summary> Creates a new inherited process. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.ProcessTemplate"> <summary> Specifies the name of the process to create. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Description"> <summary> Specifies the description of the new process. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.ReferenceName"> <summary> Specifies the reference name of the new process. When omitted, a random name will be automatically generated and assigned by the server. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Parent"> <summary> Specifies the name of the parent process from which the new process will inherit. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Force"> <summary> Allows the cmdlet to overwrite an existing process. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ProcessTemplate.NewProcessTemplate.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.RestApi.GetRestClient"> <summary> Gets an Azure DevOps HTTP Client object instance. </summary> <remarks> Connection objects (Microsoft.VisualStudio.Services.Client.VssConnection in PowerShell Core, Microsoft.TeamFoundation.Client.TfsTeamProjectCollection in Windows PowerShell) provide access to many HTTP client objects such as Microsoft.TeamFoundation.WorkItemTracking.WebApi.WorkItemTrackingHttpClient that wrap many of the REST APIs exposed by Azure DevOps. Those clients inherit the authentication information supplied by their parent connection object and can be used as a more convenient mechanism to issue API calls. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.GetRestClient.TypeName"> <summary> Specifies the full type name (optionally including its assembly name) of the HTTP Client class to return. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.GetRestClient.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.GetRestClient.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi"> <summary> Invoke an Azure DevOps REST API. </summary> <remarks> Invoke-TfsRestApi can automatically parse an example URL from https://docs.microsoft.com/en-us/rest/api/azure/devops/ and replace its various tokens (such as {organization}, {project} and {team}) as long as collection / project / team information are available via either the their respective arguments in this command or the corresponding Connect-Tfs* cmdlet. HTTP method and API version are also automatically extracted from the supplied example, when available. </remarks> <example> <code>Invoke-TfsRestApi -Method GET -Path /_apis/projects -ApiVersion 4.1 -Collection DefaultCollection</code> <para>Calls a REST API that lists all team projects in a TFS collection named DefaultCollection</para> </example> <example> <code>Invoke-TfsRestApi 'GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=5.1-preview.1'</code> <para>Calls the API described by an example extracted from the docs.microsoft.com web site. HTTP method, host name and API version are all set based on the supplied values; Tokens {organization}, {project} and {team} are properly replaced with the corresponding values provided by the current connection context (via previous calls to Connect-TfsTeamProjectCollection, Connect-TfsTeamProject and/or Connect-TfsTeam).</para> </example> <example> <code>Invoke-TfsRestApi 'GET https://{instance}/{collection}/_apis/process/processes?api-version=4.1' -Collection http://vsalm:8080/tfs/DefaultCollection</code> <para>Calls an API in a TFS instance, parsing the example provided by the docs.microsoft.com web site.</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Path"> <summary> Specifies the path of the REST API to call. Tipically it is the portion of the URL after the name of the collection/organization, i.e. in the URL https://dev.azure.com/{organization}/_apis/projects?api-version=5.1 the path is "/_apis/projects". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Method"> <summary> Specifies the HTTP method to call the API endpoint. When omitted, defaults to "GET". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Body"> <summary> Specifies the request body to send to the API endpoint. Tipically contains the JSON payload required by the API. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.RequestContentType"> <summary> Specifies the request body content type to send to the API. When omitted, defaults to "application/json". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.ResponseContentType"> <summary> Specifies the response body content type returned by the API. When omitted, defaults to "application/json". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.AdditionalHeaders"> <summary> Specifies a hashtable with additional HTTP headers to send to the API endpoint. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.QueryParameters"> <summary> Specifies a hashtable with additional query parameters to send to the API endpoint. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.ApiVersion"> <summary> Specifies the desired API version. When omitted, defaults to "4.1". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.UseHost"> <summary> Specifies an alternate host name for APIs not hosted in "dev.azure.com", e.g. "vsaex.dev.azure.com" or "vssps.dev.azure.com". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.NoAutoUnwrap"> <summary> Prevents the automatic expansion (unwrapping) of the 'value' property in the response JSON. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Raw"> <summary> Returns the API response as an unparsed string. If omitted, JSON responses will be parsed, converted and returned as objects (via ConvertFrom-Json). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Destination"> <summary> Saves the API response to a file. If omitted, the response will be written to the stardard output stream. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.AsTask"> <summary> Returns the System.Threading.Tasks.Task object used to issue the asynchronous call to the API. The caller is responsible for finishing the asynchronous call by e.g. accessing the Result property. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookConsumer"> <summary> Gets one or more service hook consumers. </summary> <remarks> Service hook consumers are the services that can consume (receive) notifications triggered by Azure DevOps. Examples of consumers available out-of-box with Azure DevOps are Microsoft Teams, Slack, Trello ou the generic WebHook consumer. Use this cmdlet to list the available consumers and get the ID of the desired one to be able to manage service hook subscriptions. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookConsumer.Consumer"> <summary> Specifies the name or ID of the service hook consumer to return. Wildcards are supported. When omitted, all service hook consumers registered in the given project collection/organization are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookConsumer.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookConsumer.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory"> <summary> Gets the notification history for a given service hook subscription </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.Subscription"> <summary> Specifies the subscription to get the notification history from. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.From"> <summary> Specifies the beginning of a date interval to filter notifications on. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.To"> <summary> Specifies the end of a date interval to filter notifications on. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.Status"> <summary> Specifies the notification status to filter on. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookNotificationHistory.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookPublisher"> <summary> Gets one or more service hook publishers. </summary> <remarks> Service hook publishers are the components inside of Azure DevOps that can publish (send) notifications triggered by event such as "work item changed" or "build queued". Use this cmdlet to list the available publishers and get the ID of the desired one to be able to manage service hook subscriptions. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookPublisher.Publisher"> <summary> Specifies the name or ID of the service hook publisher to return. Wildcards are supported. When omitted, returns all service hook consumers currently supported the current by Azure DevOps organization / TFS collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookPublisher.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookPublisher.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription"> <summary> Gets one or more service hook subscriptions </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.Subscription"> <summary> Specifies the name ("action description") of the subscription. Wildcards are supported. When omitted, returns all service hook subscriptions in the given team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.Publisher"> <summary> Specifies the name or ID of the service hook publisher to filter subscriptions by. When omitted, returns all subscriptions regardless of their publishers. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.Consumer"> <summary> Specifies the name or ID of the service hook consumer to filter subscriptions by. When omitted, returns all subscriptions regardless of their consumers. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.EventType"> <summary> Specifies the event type to filter subscriptions by. When omitted, returns all subscriptions regardless of their event types. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookSubscription.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Shell.EnterShell"> <summary> Activates the Azure DevOps Shell </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Shell.EnterShell.WindowTitle"> <summary> Specifies the shell window title. If omitted, defaults to "Azure DevOps Shell". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Shell.EnterShell.DoNotClearHost"> <summary> Do not clear the host screen when activating the Azure DevOps Shell. When set, the prompt is enabled without clearing the screen. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Shell.EnterShell.NoLogo"> <summary> Do not show the version banner when activating the Azure DevOps Shell. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Shell.EnterShell.NoProfile"> <summary> Do not load the user profile TfsCmdlets.Profile.ps1 (if present) when activating the Azure DevOps Shell. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Shell.ExitShell"> <summary> Deactivates the Azure DevOps Shell </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection"> <summary> Connects to a TFS team project collection or Azure DevOps organization. </summary> <remarks> The Connect-TfsTeamProjectCollection cmdlet connects to a TFS Team Project Collection or Azure DevOps organization. That connection can be later reused by other TfsCmdlets commands until it's closed by a call to Disconnect-TfsTeamProjectCollection. </remarks> <notes> Most cmdlets in the TfsCmdlets module require a Collection object to be provided via their -Collection argument in order to access a TFS instance. Those cmdlets will use the connection opened by Connect-TfsTeamProjectCollection as their "default connection". In other words, TFS cmdlets (e.g. New-TfsWorkItem) that have a -Collection argument will use the connection provided by Connect-TfsTeamProjectCollection by default. </notes> <example> <code>Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection</code> <para>Connects to a collection called "DefaultCollection" in a TF server called "tfs" using the cached credentials of the logged-on user</para> </example> <example> <code>Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection -Interactive</code> <para>Connects to a collection called "DefaultCollection" in a Team Foundation server called "tfs", firstly prompting the user for credentials (it ignores the cached credentials for the currently logged-in user). It's equivalent to the command: `Connect-TfsTeamProjectCollection -Collection http://tfs:8080/tfs/DefaultCollection -Credential (Get-TfsCredential -Interactive)` </para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Collection"> <summary> Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.ConnectTeamProjectCollection.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.DisconnectTeamProjectCollection"> <summary> Disconnects from the currently connected TFS team project collection or Azure DevOps organization. </summary> <remarks> The Disconnect-TfsTeamProjectCollection cmdlet removes the connection previously set by its counterpart Connect-TfsTeamProjectCollection. Therefore, cmdlets relying on a "default collection" as provided by "Get-TfsTeamProjectCollection -Current" will no longer work after a call to this cmdlet, unless their -Collection argument is provided or a new call to Connect-TfsTeam is made. </remarks> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection"> <summary> Gets one of more team project collections (organizations in Azure DevOps). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Current"> <summary> Returns the team project collection specified in the last call to Connect-TfsTeamProjectCollection (i.e. the "current" project collection) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.NewTeamProjectCollection"> <summary> Creates a new team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.NewTeamProjectCollection.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.NewTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.RemoveTeamProjectCollection"> <summary> Deletes a team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.RemoveTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar"> <summary> Exports the current avatar (image) of the specified team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar.Path"> <summary> Specifies the path of the file where the avatar image will be saved. When omitted, the image will be saved to the current directory as <team-project-name>.png. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar.Force"> <summary> HELP_PARAM_FORCE_OVERWRITE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ExportTeamProjectAvatar.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.Avatar.ImportTeamProjectAvatar"> <summary> Imports and sets a new team project avatar (image). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ImportTeamProjectAvatar.Path"> <summary> Specifies the path of the image file to import. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ImportTeamProjectAvatar.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ImportTeamProjectAvatar.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.ImportTeamProjectAvatar.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.Avatar.RemoveTeamProjectAvatar"> <summary> Removes the team project avatar, resetting it to the default. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.RemoveTeamProjectAvatar.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.RemoveTeamProjectAvatar.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Avatar.RemoveTeamProjectAvatar.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject"> <summary> Connects to a Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Project"> <summary> Specifies the name of the Team Project, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.TeamProject object to connect to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.ConnectTeamProject.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.DisconnectTeamProject"> <summary> Disconnects from the currently connected team project. </summary> <remarks> The Disconnect-TfsTeamProject cmdlet removes the connection previously set by its counterpart Connect-TfsTeamProject. Therefore, cmdlets relying on a "default team project" as provided by "Get-TfsTeamProject -Current" will no longer work after a call to this cmdlet, unless their -Project argument is provided or a new call to Connect-TfsTeamProject is made. </remarks> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject"> <summary> Gets information about one or more team projects. </summary> <remarks> The Get-TfsTeamProject cmdlets gets one or more Team Project objects (an instance of Microsoft.TeamFoundation.Core.WebApi.TeamProject) from the supplied Team Project Collection. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Project"> <summary> Specifies the name of a Team Project. Wildcards are supported. When omitted, all team projects in the supplied collection are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Deleted"> <summary> Lists deleted team projects present in the "recycle bin" </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Process"> <summary> Returns only those team projects matching the specified process template(s). Wildcards are supported. When omitted returns all team projects, regardless of process template. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.IncludeDetails"> <summary> Includes details about the team projects, such as the process template name and other properties. Specifying this argument signficantly increases the time it takes to complete the operation. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Current"> <summary> Returns the team project specified in the last call to Connect-TfsTeamProject (i.e. the "current" team project) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember"> <summary> Gets the members of a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember.Member"> <summary> Specifies the name of a team project member. Wildcards are supported. When omitted, all team project members are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember.AsIdentity"> <summary> Returns the members as fully resolved <see cref="T:Microsoft.VisualStudio.Services.Identity.Identity"/> objects. When omitted, it returns only the name, ID and email of the users. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.Member.GetTeamProjectMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject"> <summary> Creates a new team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.Project"> <summary> Specifies the name of the new team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.Description"> <summary> Specifies a description for the new team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.SourceControl"> <summary> Specifies the source control type to be provisioned initially with the team project. Supported types are "Git" and "Tfvc". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.ProcessTemplate"> <summary> Specifies the process template on which the new team project is based. Supported values are the process name or an instance of the Microsoft.TeamFoundation.Core.WebApi.Process class. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.NewTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject"> <summary> Deletes one or more team projects. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject.Project"> <summary> Specifies the name of a Team Project to delete. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject.Hard"> <summary> Deletes the team project permanently. When omitted, the team project is moved to a "recycle bin" and can be recovered either via UI or by using Undo-TfsTeamProjectRemoval. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject.Force"> <summary> HELP_PARAM_FORCE_REMOVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RemoveTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject"> <summary> Renames a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject.Project"> <summary> Specifies the name of a Team Project to rename. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject.Force"> <summary> Forces the renaming of the team project. When omitted, the command prompts for confirmation prior to renaming the team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.RenameTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject"> <summary> Changes the details of a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.Project"> <summary> Specifies the name of the Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.Description"> <summary> Specifies the description of the team project. To remove a previously set description, pass a blank string ('') to this argument. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.AvatarImage"> <summary> Specifies the name of a local image file to be uploaded and used as the team project icon ("avatar"). To remove a previously set image, pass either $null or a blank string ('') to this argument. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.SetTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProject.UndoTeamProjectRemoval"> <summary> Undeletes one or more team projects. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.UndoTeamProjectRemoval.Project"> <summary> Specifies the name of the Team Project to undelete. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.UndoTeamProjectRemoval.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProject.UndoTeamProjectRemoval.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel"> <summary> Gets information about one or more backlog levels of a given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel.Backlog"> <summary> Specifies one or more backlog level configurations to be returned. Valid values are the name (e.g. "Stories") or the ID (e.g. "Microsoft.RequirementCategory") of the backlog level to return. Wilcards are supported. When omitted, returns all backlogs levels of the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Backlog.GetTeamBacklogLevel.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard"> <summary> Gets one or more team boards. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard.Board"> <summary> Specifies the board name. Wildcards are supported. When omitted, returns all boards in the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoard.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule"> <summary> Gets one or more team board card rules. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Rule"> <summary> Specifies the rule name. Wildcards are supported. When omitted, returns all card rules in the given board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.RuleType"> <summary> Specifies the kind of rule to return. When omitted, returns both rule types (card color and tag color). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Board"> <summary> Specifies the board name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.GetTeamBoardCardRule.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule"> <summary> Set the card rule settings of the specified backlog board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.WebApiBoard"> <summary> Specifies the board name. Wildcards are supported. When omitted, returns card rules for all boards in the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.ConnectTeam"> <summary> Connects to a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Team"> <summary> Specifies the name of the Team, its ID (a GUID), or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object to connect to. For more details, see the Get-TfsTeam cmdlet. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.ConnectTeam.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.DisconnectTeam"> <summary> Disconnects from the currently connected team. </summary> <remarks> The Disconnect-TfsTeam cmdlet removes the connection previously set by its counterpart Connect-TfsTeam. Therefore, cmdlets relying on a "default team" as provided by "Get-TfsTeam -Current" will no longer work after a call to this cmdlet, unless their -Team argument is provided or a new call to Connect-TfsTeam is made. </remarks> </member> <member name="T:TfsCmdlets.Cmdlets.Team.GetTeam"> <summary> Gets information about one or more teams. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Team"> <summary> Specifies the team to return. Accepted values are its name, its ID, or a Microsoft.TeamFoundation.Core.WebApi.WebApiTeam object. Wildcards are supported. When omitted, all teams in the given team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.IncludeMembers"> <summary> Get team members (fills the Members property with a list of Microsoft.VisualStudio.Services.WebApi.TeamMember objects). When omitted, only basic team information (such as name, description and ID) are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.IncludeSettings"> <summary> Gets team settings (fills the Settings, TeamField, and IterationPaths properties). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Current"> <summary> Returns the team specified in the last call to Connect-TfsTeam (i.e. the "current" team) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Default"> <summary> Returns the default team in the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.GetTeam.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.NewTeam"> <summary> Creates a new team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Team"> <summary> Specifies the name of the new team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.DefaultAreaPath"> <summary> Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board. When omitted, an area path may still be associated to this team depending on whether NoAutomaticAreaPath is set </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.NoDefaultArea"> <summary> Do not associate an area path automatically to the new team. When omitted, an area path is created (if needed) and then is set as the default area path / team field </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.AreaPaths"> <summary> Specifies the backlog area path(s) that are associated with this team. Wildcards are supported. When the path ends with an asterisk, all child area paths will be included recursively. Otherwise, only the area itself (without its children) will be included. To include the children of the default area path, use the wildcard character (*) without a path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.BacklogIteration"> <summary> Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.DefaultIterationMacro"> <summary> Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.IterationPaths"> <summary> Specifies the backlog iteration path(s) that are associated with this team. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.NoBacklogIteration"> <summary> Do not associate an iteration path automatically to the new team. When omitted, an iteration path is created (if needed) and then is set as the default backlog iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Description"> <summary> Specifies a description of the new team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.NewTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.RemoveTeam"> <summary> Deletes a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RemoveTeam.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RemoveTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RemoveTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RemoveTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.RenameTeam"> <summary> Renames a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RenameTeam.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RenameTeam.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RenameTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RenameTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.RenameTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.SetTeam"> <summary> Changes the details of a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Default"> <summary> Sets the specified team as the default team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Description"> <summary> Specifies a new description </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.DefaultAreaPath"> <summary> Specifies the team's default area path (or "team field"). The default area path is assigned automatically to all work items created in a team's backlog and/or board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.AreaPaths"> <summary> Specifies the backlog area path(s) that are associated with this team. Wildcards are supported. When the path ends with an asterisk, all child area paths will be included recursively. Otherwise, only the area itself (without its children) will be included. To include the children of the default area path, use the wildcard character (*) without a path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.OverwriteAreaPaths"> <summary> Replaces the existing area paths with the specified list of area paths. When omitted, the new area paths are added alongside the previously defined ones. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.BacklogIteration"> <summary> Specifies the team's backlog iteration path. When omitted, defaults to the team project's root iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.DefaultIterationMacro"> <summary> Specifies the default iteration macro. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.IterationPaths"> <summary> Specifies the backlog iteration path(s) that are associated with this team. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.OverwriteIterationPaths"> <summary> Replaces the existing iteration paths with the specified list of iteration paths. When omitted, the new iteration paths are added alongside the previously defined ones. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.WorkingDays"> <summary> Specifies the team's Working Days. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.BugsBehavior"> <summary> Specifies how bugs should behave when added to a board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.BacklogVisibilities"> <summary> Specifies which backlog levels (e.g. Epics, Features, Stories) should be visible. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Force"> <summary> Allows the cmdlet to create target area and/or iteration nodes if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin"> <summary> Adds a new administrator to a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.Admin"> <summary> Specifies the administrator to add to the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin"> <summary> Gets the administrators of a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Admin"> <summary> Specifies the administrator to get from the given team. Wildcards are supported. When omitted, all administrators are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin"> <summary> Removes an administrator from a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.Admin"> <summary> Specifies the administrator to remove from the team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember"> <summary> Adds new members to a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.Member"> <summary> Specifies the member (user or group) to add to the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember"> <summary> Gets the members of a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Member"> <summary> Specifies the member (user or group) to get from the given team. Wildcards are supported. When omitted, all team members are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Recurse"> <summary> Recursively expands all member groups, returning the users and/or groups contained in them </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember"> <summary> Removes a member from a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.Member"> <summary> Specifies the member (user or group) to remove from the given team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan"> <summary> Clone a test plan and, optionally, its test suites and test cases. </summary> <remarks> <para>The Copy-TfsTestPlan copies ("clones") a test plan to help duplicate test suites and/or test cases. Cloning is useful if you want to branch your application into two versions. After copying, the tests for the two versions can be changed without affecting each other.</para> <para>When you clone a test suite, the following objects are copied from the source test plan to the destination test plan:</para> <para> * Test cases (note: Each new test case retains its shared steps. A link is made between the source and new test cases. The new test cases do not have test runs, bugs, test results, and build information);</para> <para> * Shared steps referenced by cloned test cases;</para> <para> * Test suites (note: The following data is retained - Names and hierarchical structure of the test suites; Order of the test cases; Assigned testers; Configurations);</para> <para> * Action Recordings linked from a cloned test case;</para> <para> * Links and Attachments;</para> <para> * Test configuration.</para> <para>The items below are only copied when using -CloneRequirements:</para> <para> * Requirements-based suites;</para> <para> * Requirements work items (product backlog items or user stories);</para> <para> * Bug work items, when in a project that uses the Scrum process template or any other project in which the Bug work item type is in the Requirements work item category. In other projects, bugs are not cloned.</para> </remarks> <example> <code>Copy-TfsTestPlan -TestPlan "My test plan" -Project "SourceProject" -Destination "TargetProject" -NewName "My new test plan"</code> </example> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.TestPlan"> <summary> Specifies the name of the test plan to clone. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.NewName"> <summary> Specifies the name of the new test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Destination"> <summary> Specifies the name of the team project where the test plan will be cloned into. When omitted, the test plan is cloned into the same team project of the original test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.AreaPath"> <summary> Specifies the area path where the test plan will be cloned into. When omitted, the test plan is cloned into the same area path of the original test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.IterationPath"> <summary> Specifies the iteration path where the test plan will be cloned into. When omitted, the test plan is cloned into the same iteration path of the original test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.DeepClone"> <summary> Clones all the referenced test cases. When omitted, only the test plan is cloned; the original test cases are only referenced in the new plan, not duplicated. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Recurse"> <summary> Clone all test suites recursively. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.CopyAncestorHierarchy"> <summary> Copies ancestor hierarchy. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.CloneRequirements"> <summary> Clones requirements referenced by the test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.DestinationWorkItemType"> <summary> Specifies the name of the workitem type of the clone. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.SuiteIds"> <summary> Clones only the specified suites. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.RelatedLinkComment"> <summary> Specifies the comment of the Related link that is created ato point to the original test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan"> <summary> Gets the contents of one or more test plans. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.TestPlan"> <summary> Specifies the test plan name. Wildcards are supported. When omitted, returns all test cases in the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.Owner"> <summary> Gets only the plans owned by the specified user. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.NoPlanDetails"> <summary> Get only basic properties of the test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.Active"> <summary> Get only the active plans. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.GetTestPlan.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan"> <summary> Creates a new test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.TestPlan"> <summary> Specifies the test plan name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.AreaPath"> <summary> Specifies the owner of the new test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.IterationPath"> <summary> Specifies the owner of the new test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.StartDate"> <summary> Specifies the start date of the test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.EndDate"> <summary> Specifies the end date of the test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.Owner"> <summary> Specifies the owner of the new test plan. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.NewTestPlan.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan"> <summary> Deletes one or more test plans. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan.TestPlan"> <summary> Specifies one or more test plans to delete. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan.Force"> <summary> Forces the deletion of test plans with test suites and/or test cases. When omitted, only empty test plans can be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RemoveTestPlan.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan"> <summary> Renames a test plans. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan.TestPlan"> <summary> Specifies the test plan name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TestManagement.RenameTestPlan.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Wiki.GetWiki"> <summary> Gets information from one or more Wiki repositories in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.GetWiki.Wiki"> <summary> Specifies the name or ID of a Wiki repository. Wildcards are supported. When omitted, all Wiki repositories in the supplied team project are returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.GetWiki.ProjectWiki"> <summary> Returns only provisioned ("project") Wikis. When omitted, returns all Wikis (both Project wikis and Code wikis). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.GetWiki.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.GetWiki.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.GetWiki.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Wiki.NewWiki"> <summary> Creates a new Wiki repository in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Wiki"> <summary> Specifies the name of the new Wiki </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Repository"> <summary> Specifies the name or ID of the Git repository to publish as a Wiki </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Branch"> <summary> Specifies the name or ID of the source branch to publish as a Wiki. When ommited, the default branch is used. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Path"> <summary> Specifies the path to the folder in the repository to publish as a Wiki. When ommited, defaults to the root folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.ProjectWiki"> <summary> Creates a provisioned ("project") Wiki in the specified Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.NewWiki.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Wiki.RemoveWiki"> <summary> Deletes one or more Git repositories from a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.RemoveWiki.Wiki"> <summary> Specifies the Wiki to be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.RemoveWiki.ProjectWiki"> <summary> Deletes the provisioned ("project") Wiki of the specified Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.RemoveWiki.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.RemoveWiki.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Wiki.RemoveWiki.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea"> <summary> Copies one or more Work Item Areas recursively </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Destination"> <summary> Specifies the name and/or path of the destination parent node. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.DestinationProject"> <summary> Specifies the name and/or path of the destination team project. When omitted, copies the area to the same team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Force"> <summary> Allows the cmdlet to create destination parent node(s) if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Recurse"> <summary> Copies nodes recursively. When omitted, sub-nodes are not copied. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration"> <summary> Copies one or more Iterations recursively </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Destination"> <summary> Specifies the name and/or path of the destination parent node. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.DestinationProject"> <summary> Specifies the name and/or path of the destination team project. When omitted, copies the iteration to the same team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Force"> <summary> Allows the cmdlet to create destination parent node(s) if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Recurse"> <summary> Copies nodes recursively. When omitted, sub-nodes are not copied. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.CopyIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetArea"> <summary> Gets one or more Work Item Areas from a given Team Project. </summary> <example> <code>Get-TfsArea</code> <para>Returns all area paths in the currently connected Team Project (as defined by a previous call to Connect-TfsTeamProject)</para> </example> <example> <code>Get-TfsArea '\**\Support' -Project Tailspin</code> <para>Performs a recursive search and returns all area paths named 'Support' that may exist in a team project called Tailspin</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetIteration"> <summary> Gets one or more Iterations from a given Team Project. </summary> <example> <code>Get-TfsIteration</code> <para>Returns all iterations in the currently connected Team Project (as defined by a previous call to Connect-TfsTeamProject)</para> </example> <example> <code>Get-TfsIteration '\**\Support' -Project Tailspin</code> <para>Performs a recursive search and returns all iterations named 'Support' that may exist in a team project called Tailspin</para> </example> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea"> <summary> Moves one or more Work Item Areas to a new parent node </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Destination"> <summary> Specifies the name and/or path of the destination parent node. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Force"> <summary> Allows the cmdlet to create destination parent node(s) if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration"> <summary> Moves one or more Iterations to a new parent node </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Destination"> <summary> Specifies the name and/or path of the destination parent node. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Force"> <summary> Allows the cmdlet to create destination parent node(s) if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea"> <summary> Creates a new Work Item Area in the given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Node"> <summary> Specifies the path of the new Area. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the area name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Force"> <summary> Allows the cmdlet to create parent nodes if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration"> <summary> Creates a new Iteration in the given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Node"> <summary> Specifies the path of the new Iteration. When supplying a path, use a backslash ("\\") between the path segments. Leading and trailing backslashes are optional. The last segment in the path will be the iteration name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.StartDate"> <summary> Specifies the start date of the iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.FinishDate"> <summary> Sets the finish date of the iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Force"> <summary> Allows the cmdlet to create parent nodes if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea"> <summary> Deletes one or more Work Item Areas from a given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.MoveTo"> <summary> Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.Recurse"> <summary> Removes node(s) recursively. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration"> <summary> Deletes one or more iterations from a given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.MoveTo"> <summary> Specifies the new parent node for the work items currently assigned to the node being deleted, if any. When omitted, defaults to the root node (the "\" node, at the team project level). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.Recurse"> <summary> Removes node(s) recursively. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea"> <summary> Renames an area path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration"> <summary> Renames an iteration path. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration"> <summary> Modifies the dates of an iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.StartDate"> <summary> Specifies the start date of the iteration. To clear the start date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.FinishDate"> <summary> Sets the finish date of the iteration. To clear the finish date, set it to $null. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate and FinishDate to $null). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Length"> <summary> Sets the length (in days) of the iteration. To clear the finish date, set it to 0. Note that when clearing a date, both must be cleared at the same time (i.e. setting both StartDate to $null and Length to 0). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestArea"> <summary> Determines whether the specified Work Area exist. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestArea.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestArea.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestArea.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestArea.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration"> <summary> Determines whether the specified iteration exist. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem"> <summary> Gets the contents of one or more work items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.WorkItem"> <summary> HELP_PARAM_WORKITEM </summary> <seealso cref="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem"> A WorkItem object </seealso> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Title"> <summary> Specifies the title to look up for in a work item. Wildcards are supported. When a wildcard is used, matches a portion of the title (uses the operator "contains" in the WIQL query). Otherwise, matches the whole field with the operator "=", unless -Ever is also specified. In that case, uses the operator "was ever". </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Description"> <summary> Specifies the description to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.AreaPath"> <summary> Specifies the area path to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.IterationPath"> <summary> Specifies the iteration path to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.WorkItemType"> <summary> Specifies the work item type to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.State"> <summary> Specifies the state (field 'System.State') to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Reason"> <summary> Specifies the reason (field 'System.Reason') to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.ValueArea"> <summary> Specifies the Value Area (field 'Microsoft.VSTS.Common.ValueArea') to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.BoardColumn"> <summary> Specifies the board column to look up for in a work item. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.BoardColumnDone"> <summary> Specifies whether the work item is in the sub-column Doing or Done in a board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.CreatedBy"> <summary> Specifies the name or email of the user that created the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.CreatedDate"> <summary> Specifies the date when the work item was created. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.ChangedBy"> <summary> Specifies the name or email of the user that did the latest change to the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.ChangedDate"> <summary> Specifies the date of the latest change to the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.StateChangeDate"> <summary> Specifies the date of the most recent change to the state of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Priority"> <summary> Specifies the priority of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Tags"> <summary> Specifies the tags to look up for in a work item. When multiple tags are supplied, they are combined with an OR operator - in other works, returns work items that contain ANY ofthe supplied tags. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Ever"> <summary> Switches the query to historical query mode, by changing operators to "WAS EVER" where possible. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Revision"> <summary>B Specifies a work item revision number to retrieve. When omitted, returns the latest revision of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.AsOf"> <summary> Returns the field values as they were defined in the work item revision that was the latest revision by the date specified. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Wiql"> <summary> Specifies a query written in WIQL (Work Item Query Language) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.SavedQuery"> <summary> Specifies the path of a saved query to be executed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.QueryParameters"> <summary> Specifies the path of a saved query to be executed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Fields"> <summary> Specifies which fields should be retrieved. When omitted, defaults to a set of standard fields that include Id, Title, Description, some state-related fields and more. To retrive all fields, pass an asterisk ('*') to this argument. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Where"> <summary> Specifies a filter clause (the portion of a WIQL query after the WHERE keyword). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.TimePrecision"> <summary> Fetches work items in "time-precision mode": search criteria in WIQL queries take into account time information as well, not only dates. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.ShowWindow"> <summary> Opens the specified work item in the default web browser. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Deleted"> <summary> Gets deleted work items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.IncludeLinks"> <summary> Gets information about all links and attachments in the work item. When omitted, only fields are retrieved. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.GetWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.History.GetWorkItemHistory"> <summary> Gets the history of changes of a work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.History.GetWorkItemHistory.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.History.GetWorkItemHistory.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink"> <summary> Adds a link between two work items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment"> <summary> Downloads one or more attachments from work items </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.Attachment"> <summary> Specifies the attachment to download. Wildcards are supported. When omitted, all attachments in the specified work item are downloaded. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.WorkItem"> <summary> HELP_PARAM_WORKITEM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.Destination"> <summary> Specifies the directory to save the attachment to. When omitted, defaults to the current directory. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.Force"> <summary> Allows the cmdlet to overwrite an existing file. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLink"> <summary> Gets the links in a work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLink.WorkItem"> <summary> HELP_PARAM_WORKITEM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLink.LinkType"> <summary> Returns only the specified link types. When omitted, returns all link types. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLink.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLink.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLinkType"> <summary> Gets the work item link end types of a team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLinkType.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLinkType.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem"> <summary> Moves a work item to a different team project in the same collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.WorkItem"> <summary> Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Project"> <summary> Specifies the team project where the work item will be moved to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Area"> <summary> Specifies the area path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root area path in the destination project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Iteration"> <summary> Specifies the iteration path in the destination project where the work item will be moved to. When omitted, the work item is moved to the root iteration path in the destination project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.State"> <summary> Specifies a new state for the work item in the destination project. When omitted, it retains the current state. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Comment"> <summary> Specifies a comment to be added to the history </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem"> <summary> Creates a new work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Type"> <summary> Specifies the type of the new work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Title"> <summary> Specifies the title of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Description"> <summary> Specifies the description of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.AreaPath"> <summary> Specifies the area path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.IterationPath"> <summary> Specifies the iteration path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.AssignedTo"> <summary> Specifies the user this work item is assigned to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.State"> <summary> Specifies the state of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Reason"> <summary> Specifies the reason (field 'System.Reason') of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.ValueArea"> <summary> Specifies the Value Area of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.BoardColumn"> <summary> Specifies the board column of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.BoardColumnDone"> <summary> Specifies whether the work item is in the sub-column Doing or Done in a board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.BoardLane"> <summary> Specifies the board lane of the work item </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Priority"> <summary> Specifies the priority of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Tags"> <summary> Specifies the tags of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Fields"> <summary> Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.BypassRules"> <summary> Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery"> <summary> Exports a saved work item query to XML. </summary> <remarks> Work item queries can be exported to XML files (.WIQ extension) in order to be shared and reused. Visual Studio Team Explorer has the ability to open and save WIQ files. Use this cmdlet to generate WIQ files compatible with the format supported by Team Explorer. </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Query"> <summary> Specifies one or more saved queries to export. Wildcards supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Scope"> <summary> Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Destination"> <summary> Specifies the path to the folder where exported queries are saved. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Encoding"> <summary> Specifies the encoding for the exported XML files. When omitted, defaults to UTF-8. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.FlattenFolders"> <summary> Flattens the query folder structure. When omitted, the original query folder structure is recreated in the destination folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Force"> <summary> HELP_PARAM_FORCE_OVERWRITE </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.AsXml"> <summary> Exports the saved query to the standard output stream as a string-encoded XML document. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder"> <summary> Gets the definition of one or more work item saved queries. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Folder"> <summary> Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Scope"> <summary> Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Deleted"> <summary> Returns deleted items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.GetWorkItemQueryFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder"> <summary> Create a new work items query in the given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Folder"> <summary> Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Scope"> <summary> Specifies the scope of the returned item. Personal refers to the "My Queries" folder, whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.Folder.NewWorkItemQueryFolder.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery"> <summary> Gets the definition of one or more work item saved queries. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Query"> <summary> Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Scope"> <summary> Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Deleted"> <summary> Returns deleted items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery"> <summary> Create a new work items query in the given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Query"> <summary> Specifies one or more saved queries to return. Wildcards supported. When omitted, returns all saved queries in the given scope of the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Scope"> <summary> Specifies the scope of the returned item. Personal refers to the "My Queries" folder", whereas Shared refers to the "Shared Queries" folder. When omitted defaults to "Both", effectively searching for items in both scopes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Wiql"> <summary> Specifies the query definition text in WIQL (Work Item Query Language). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem"> <summary> Deletes a work item from a team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem.WorkItem"> <summary> Specifies the work item to remove. </summary> <seealso cref="T:Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem"> A WorkItem object </seealso> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem.Destroy"> <summary> Permanently deletes the work item, without sending it to the recycle bin. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem.Force"> <summary> HELP_PARAM_FORCE_REMOVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.RemoveWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem"> <summary> Gets the contents of one or more work items. </summary> <related>https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax</related> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem.Query"> <summary> Specifies the text to search for. Supports the Quick Filter syntax described in https://docs.microsoft.com/en-us/azure/devops/project/search/advanced-work-item-search-syntax </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem.Results"> <summary> Specifies the maximum quantity of results. Supports between 1 and 1000 results. When omitted, defaults to 100. Currently this cmdlet does not support result pagination. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SearchWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem"> <summary> Sets the contents of one or more work items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.WorkItem"> <summary> Specifies a work item. Valid values are the work item ID or an instance of Microsoft.TeamFoundation.WorkItemTracking.WebApi.Models.WorkItem. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Title"> <summary> Specifies the title of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Description"> <summary> Specifies the description of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.AreaPath"> <summary> Specifies the area path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.IterationPath"> <summary> Specifies the iteration path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.AssignedTo"> <summary> Specifies the user this work item is assigned to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.State"> <summary> Specifies the state of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Reason"> <summary> Specifies the reason (field 'System.Reason') of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.ValueArea"> <summary> Specifies the Value Area of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.BoardColumn"> <summary> Specifies the board column of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.BoardColumnDone"> <summary> Specifies whether the work item is in the sub-column Doing or Done in a board. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.BoardLane"> <summary> Specifies the board lane of the work item </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Priority"> <summary> Specifies the priority of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Tags"> <summary> Specifies the tags of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Fields"> <summary> Specifies the names and the corresponding values for the fields to be set in the work item and whose values were not supplied in the other arguments to this cmdlet. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.BypassRules"> <summary> Bypasses any rule validation when saving the work item. Use it with caution, as this may leave the work item in an invalid state. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag"> <summary> Disables (deactivates) a work item tag. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag.Tag"> <summary> Specifies the tag to disable. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.DisableWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag"> <summary> Enables (activates) a work item tag. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag.Tag"> <summary> Specifies the tag to enable. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.EnableWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag"> <summary> Gets one or more work item tags. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag.Tag"> <summary> Specifies one or more tags to returns. Wildcards are supported. When omitted, returns all existing tags in the given project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag.IncludeInactive"> <summary> Includes tags not associated to any work items. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.GetWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag"> <summary> Creates a new work item tag. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag.Tag"> <summary> Specifies the name of the new tag. </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.NewWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag"> <summary> Deletes one or more work item tags. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag.Tag"> <summary> Specifies one or more tags to delete. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag.Force"> <summary> HELP_PARAM_FORCE_REMOVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RemoveWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag"> <summary> Renames a work item tag. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag.Tag"> <summary> Specifies the name of the work item tag to rename. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Tagging.RenameWorkItemTag.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.UndoWorkItemRemoval"> <summary> Restores a deleted work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.UndoWorkItemRemoval.WorkItem"> <summary> Specifies the ID of the work item to be restored. Can also receive the output of `Get-WorkItem -Deleted`. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.UndoWorkItemRemoval.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.UndoWorkItemRemoval.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType"> <summary> Exports an XML work item type definition from a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Type"> <summary> Specifies one or more work item types to export. Wildcards are supported. When omitted, all work item types in the given project are exported </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.IncludeGlobalLists"> <summary> Exports the definitions of referenced global lists. When omitted, global list definitions are not included in the exported XML document. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Destination"> <summary> Specifies the path to the folder where exported types are saved. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Encoding"> <summary> Specifies the encoding for the exported XML files. When omitted, defaults to UTF-8. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Force"> <summary> HELP_PARAM_FORCE_OVERWRITE </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.AsXml"> <summary> Exports the saved query to the standard output stream as a string-encoded XML document. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType"> <summary> Gets one or more Work Item Type definitions from a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType.Type"> <summary> Specifies one or more work item type names to return. Wildcards are supported. When omitted, returns all work item types in the given team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType.WorkItem"> <summary> Speficies a work item whose corresponding type should be returned. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.GetWorkItemType.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType"> <summary> Imports a work item type definition into a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Controllers.Pipeline.Build.Definition.ResumeBuildDefinitionController"> <summary> Gets one or more build/pipeline definitions in a team project. </summary> </member> <member name="T:TfsCmdlets.Controllers.Pipeline.Build.Definition.SuspendBuildDefinitionController"> <summary> Gets one or more build/pipeline definitions in a team project. </summary> </member> <member name="T:TfsCmdlets.Controllers.Pipeline.ReleaseManagement.GetReleaseDefinitionController"> <summary> Gets information from one or more release definitions in a team project. </summary> </member> <member name="T:TfsCmdlets.Controllers.Pipeline.ReleaseManagement.GetReleaseDefinitionFolderController"> <summary> Gets one or more Release/pipeline definition folders in a team project. </summary> </member> <member name="T:TfsCmdlets.Controllers.Pipeline.ReleaseManagement.RemoveReleaseDefinitionFolderController"> <summary> Deletes one or more release definition folders. </summary> </member> <member name="T:TfsCmdlets.Controllers.ProcessTemplate.GetProcessTemplateController"> <summary> Gets information from one or more process templates. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Linking.AddWorkItemLinkController"> <summary> Adds a link between two work items. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Linking.GetWorkItemLinkTypeController"> <summary> Gets the work item link end types of a team project collection. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Tagging.GetWorkItemTagController"> <summary> Gets one or more work item tags. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Tagging.NewWorkItemTagController"> <summary> Gets one or more work item tags. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Tagging.RemoveWorkItemTagController"> <summary> Gets one or more work item tags. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.Tagging.RenameWorkItemTagController"> <summary> Gets one or more work item tags. </summary> </member> <member name="T:TfsCmdlets.Controllers.WorkItem.WorkItemType.GetWorkItemTypeController"> <summary> Exports an XML work item type definition from a team project. </summary> </member> <member name="T:TfsCmdlets.ModuleInitializer"> <summary> PowerShell module initializer </summary> </member> <member name="M:TfsCmdlets.ModuleInitializer.System#Management#Automation#IModuleAssemblyInitializer#OnImport"> <summary> Method called automatically by PowerShell upon module load/start </summary> </member> <member name="T:JetBrains.Annotations.CanBeNullAttribute"> <summary> Indicates that the value of the marked element could be <c>null</c> sometimes, so checking for <c>null</c> is required before its usage. </summary> <example><code> [CanBeNull] object Test() => null; void UseTest() { var p = Test(); var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' } </code></example> </member> <member name="T:JetBrains.Annotations.NotNullAttribute"> <summary> Indicates that the value of the marked element can never be <c>null</c>. </summary> <example><code> [NotNull] object Foo() { return null; // Warning: Possible 'null' assignment } </code></example> </member> <member name="T:JetBrains.Annotations.ItemNotNullAttribute"> <summary> Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task and Lazy classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can never be null. </summary> <example><code> public void Foo([ItemNotNull]List<string> books) { foreach (var book in books) { if (book != null) // Warning: Expression is always true Console.WriteLine(book.ToUpper()); } } </code></example> </member> <member name="T:JetBrains.Annotations.ItemCanBeNullAttribute"> <summary> Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task and Lazy classes to indicate that the value of a collection item, of the Task.Result property or of the Lazy.Value property can be null. </summary> <example><code> public void Foo([ItemCanBeNull]List<string> books) { foreach (var book in books) { // Warning: Possible 'System.NullReferenceException' Console.WriteLine(book.ToUpper()); } } </code></example> </member> <member name="T:JetBrains.Annotations.StringFormatMethodAttribute"> <summary> Indicates that the marked method builds string by the format pattern and (optional) arguments. The parameter, which contains the format string, should be given in the constructor. The format string should be in <see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>-like form. </summary> <example><code> [StringFormatMethod("message")] void ShowError(string message, params object[] args) { /* do something */ } void Foo() { ShowError("Failed: {0}"); // Warning: Non-existing argument in format string } </code></example> </member> <member name="M:JetBrains.Annotations.StringFormatMethodAttribute.#ctor(System.String)"> <param name="formatParameterName"> Specifies which parameter of an annotated method should be treated as the format string </param> </member> <member name="T:JetBrains.Annotations.StructuredMessageTemplateAttribute"> <summary> Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments in the order in which they appear </summary> <example><code> void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ } void Foo() { LogInfo("User created: {username}"); // Warning: Non-existing argument in format string } </code></example> </member> <member name="T:JetBrains.Annotations.ValueProviderAttribute"> <summary> Use this annotation to specify a type that contains static or const fields with values for the annotated property/field/parameter. The specified type will be used to improve completion suggestions. </summary> <example><code> namespace TestNamespace { public class Constants { public static int INT_CONST = 1; public const string STRING_CONST = "1"; } public class Class1 { [ValueProvider("TestNamespace.Constants")] public int myField; public void Foo([ValueProvider("TestNamespace.Constants")] string str) { } public void Test() { Foo(/*try completion here*/);// myField = /*try completion here*/ } } } </code></example> </member> <member name="T:JetBrains.Annotations.ValueRangeAttribute"> <summary> Indicates that the integral value falls into the specified interval. It's allowed to specify multiple non-intersecting intervals. Values of interval boundaries are inclusive. </summary> <example><code> void Foo([ValueRange(0, 100)] int value) { if (value == -1) { // Warning: Expression is always 'false' ... } } </code></example> </member> <member name="T:JetBrains.Annotations.NonNegativeValueAttribute"> <summary> Indicates that the integral value never falls below zero. </summary> <example><code> void Foo([NonNegativeValue] int value) { if (value == -1) { // Warning: Expression is always 'false' ... } } </code></example> </member> <member name="T:JetBrains.Annotations.InvokerParameterNameAttribute"> <summary> Indicates that the function argument should be a string literal and match one of the parameters of the caller function. For example, ReSharper annotates the parameter of <see cref="T:System.ArgumentNullException"/>. </summary> <example><code> void Foo(string param) { if (param == null) throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol } </code></example> </member> <member name="T:JetBrains.Annotations.NotifyPropertyChangedInvocatorAttribute"> <summary> Indicates that the method is contained in a type that implements <c>System.ComponentModel.INotifyPropertyChanged</c> interface and this method is used to notify that some property value changed. </summary> <remarks> The method should be non-static and conform to one of the supported signatures: <list> <item><c>NotifyChanged(string)</c></item> <item><c>NotifyChanged(params string[])</c></item> <item><c>NotifyChanged{T}(Expression{Func{T}})</c></item> <item><c>NotifyChanged{T,U}(Expression{Func{T,U}})</c></item> <item><c>SetProperty{T}(ref T, T, string)</c></item> </list> </remarks> <example><code> public class Foo : INotifyPropertyChanged { public event PropertyChangedEventHandler PropertyChanged; [NotifyPropertyChangedInvocator] protected virtual void NotifyChanged(string propertyName) { ... } string _name; public string Name { get { return _name; } set { _name = value; NotifyChanged("LastName"); /* Warning */ } } } </code> Examples of generated notifications: <list> <item><c>NotifyChanged("Property")</c></item> <item><c>NotifyChanged(() => Property)</c></item> <item><c>NotifyChanged((VM x) => x.Property)</c></item> <item><c>SetProperty(ref myField, value, "Property")</c></item> </list> </example> </member> <member name="T:JetBrains.Annotations.ContractAnnotationAttribute"> <summary> Describes dependency between method input and output. </summary> <syntax> <p>Function Definition Table syntax:</p> <list> <item>FDT ::= FDTRow [;FDTRow]*</item> <item>FDTRow ::= Input => Output | Output <= Input</item> <item>Input ::= ParameterName: Value [, Input]*</item> <item>Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value}</item> <item>Value ::= true | false | null | notnull | canbenull</item> </list> If the method has a single input parameter, its name could be omitted.<br/> Using <c>halt</c> (or <c>void</c>/<c>nothing</c>, which is the same) for the method output means that the method doesn't return normally (throws or terminates the process).<br/> Value <c>canbenull</c> is only applicable for output parameters.<br/> You can use multiple <c>[ContractAnnotation]</c> for each FDT row, or use single attribute with rows separated by the semicolon. There is no notion of order rows, all rows are checked for applicability and applied per each program state tracked by the analysis engine.<br/> </syntax> <examples><list> <item><code> [ContractAnnotation("=> halt")] public void TerminationMethod() </code></item> <item><code> [ContractAnnotation("null <= param:null")] // reverse condition syntax public string GetName(string surname) </code></item> <item><code> [ContractAnnotation("s:null => true")] public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() </code></item> <item><code> // A method that returns null if the parameter is null, // and not null if the parameter is not null [ContractAnnotation("null => null; notnull => notnull")] public object Transform(object data) </code></item> <item><code> [ContractAnnotation("=> true, result: notnull; => false, result: null")] public bool TryParse(string s, out Person result) </code></item> </list></examples> </member> <member name="T:JetBrains.Annotations.LocalizationRequiredAttribute"> <summary> Indicates whether the marked element should be localized. </summary> <example><code> [LocalizationRequiredAttribute(true)] class Foo { string str = "my string"; // Warning: Localizable string } </code></example> </member> <member name="T:JetBrains.Annotations.CannotApplyEqualityOperatorAttribute"> <summary> Indicates that the value of the marked type (or its derivatives) cannot be compared using '==' or '!=' operators and <c>Equals()</c> should be used instead. However, using '==' or '!=' for comparison with <c>null</c> is always permitted. </summary> <example><code> [CannotApplyEqualityOperator] class NoEquality { } class UsesNoEquality { void Test() { var ca1 = new NoEquality(); var ca2 = new NoEquality(); if (ca1 != null) { // OK bool condition = ca1 == ca2; // Warning } } } </code></example> </member> <member name="T:JetBrains.Annotations.BaseTypeRequiredAttribute"> <summary> When applied to a target attribute, specifies a requirement for any type marked with the target attribute to implement or inherit specific type or types. </summary> <example><code> [BaseTypeRequired(typeof(IComponent)] // Specify requirement class ComponentAttribute : Attribute { } [Component] // ComponentAttribute requires implementing IComponent interface class MyComponent : IComponent { } </code></example> </member> <member name="T:JetBrains.Annotations.UsedImplicitlyAttribute"> <summary> Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), so this symbol will be ignored by usage-checking inspections. <br/> You can use <see cref="T:JetBrains.Annotations.ImplicitUseKindFlags"/> and <see cref="T:JetBrains.Annotations.ImplicitUseTargetFlags"/> to configure how this attribute is applied. </summary> <example><code> [UsedImplicitly] public class TypeConverter {} public class SummaryData { [UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)] public SummaryData() {} } [UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)] public interface IService {} </code></example> </member> <member name="T:JetBrains.Annotations.MeansImplicitUseAttribute"> <summary> Can be applied to attributes, type parameters, and parameters of a type assignable from <see cref="T:System.Type"/> . When applied to an attribute, the decorated attribute behaves the same as <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>. When applied to a type parameter or to a parameter of type <see cref="T:System.Type"/>, indicates that the corresponding type is used implicitly. </summary> </member> <member name="T:JetBrains.Annotations.ImplicitUseKindFlags"> <summary> Specifies the details of implicitly used symbol when it is marked with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>. </summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Access"> <summary>Only entity marked with attribute considered used.</summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.Assign"> <summary>Indicates implicit assignment to a member.</summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature"> <summary> Indicates implicit instantiation of a type with fixed constructor signature. That means any unused constructor parameters won't be reported as such. </summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseKindFlags.InstantiatedNoFixedConstructorSignature"> <summary>Indicates implicit instantiation of a type.</summary> </member> <member name="T:JetBrains.Annotations.ImplicitUseTargetFlags"> <summary> Specifies what is considered to be used implicitly when marked with <see cref="T:JetBrains.Annotations.MeansImplicitUseAttribute"/> or <see cref="T:JetBrains.Annotations.UsedImplicitlyAttribute"/>. </summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.Members"> <summary>Members of the type marked with the attribute are considered used.</summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithInheritors"> <summary> Inherited entities are considered used. </summary> </member> <member name="F:JetBrains.Annotations.ImplicitUseTargetFlags.WithMembers"> <summary>Entity marked with the attribute and all its members considered used.</summary> </member> <member name="T:JetBrains.Annotations.PublicAPIAttribute"> <summary> This attribute is intended to mark publicly available API, which should not be removed and so is treated as used. </summary> </member> <member name="T:JetBrains.Annotations.InstantHandleAttribute"> <summary> Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack. If the parameter is a delegate, indicates that delegate can only be invoked during method execution (the delegate can be invoked zero or multiple times, but not stored to some field and invoked later, when the containing method is no longer on the execution stack). If the parameter is an enumerable, indicates that it is enumerated while the method is executed. If <see cref="P:JetBrains.Annotations.InstantHandleAttribute.RequireAwait"/> is true, the attribute will only takes effect if the method invocation is located under the 'await' expression. </summary> </member> <member name="P:JetBrains.Annotations.InstantHandleAttribute.RequireAwait"> <summary> Require the method invocation to be used under the 'await' expression for this attribute to take effect on code analysis engine. Can be used for delegate/enumerable parameters of 'async' methods. </summary> </member> <member name="T:JetBrains.Annotations.PureAttribute"> <summary> Indicates that a method does not make any observable state changes. The same as <c>System.Diagnostics.Contracts.PureAttribute</c>. </summary> <example><code> [Pure] int Multiply(int x, int y) => x * y; void M() { Multiply(123, 42); // Warning: Return value of pure method is not used } </code></example> </member> <member name="T:JetBrains.Annotations.MustUseReturnValueAttribute"> <summary> Indicates that the return value of the method invocation must be used. </summary> <remarks> Methods decorated with this attribute (in contrast to pure methods) might change state, but make no sense without using their return value. <br/> Similarly to <see cref="T:JetBrains.Annotations.PureAttribute"/>, this attribute will help to detect usages of the method when the return value is not used. Optionally, you can specify a message to use when showing warnings, e.g. <code>[MustUseReturnValue("Use the return value to...")]</code>. </remarks> </member> <member name="T:JetBrains.Annotations.RequireStaticDelegateAttribute"> <summary> This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs. When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter: * When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure has no captures of the containing local variables and the compiler is able to cache the delegate instance to avoid heap allocations. Otherwise the warning is produced. * IDE warns when method name or local function name is passed as an argument as this always results in heap allocation of the delegate instance. </summary> <remarks> In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier to make use of the similar analysis provided by the language/compiler. </remarks> </member> <member name="T:JetBrains.Annotations.ProvidesContextAttribute"> <summary> Indicates the type member or parameter of some type, that should be used instead of all other ways to get the value of that type. This annotation is useful when you have some "context" value evaluated and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. </summary> <example><code> class Foo { [ProvidesContext] IBarService _barService = ...; void ProcessNode(INode node) { DoSomething(node, node.GetGlobalServices().Bar); // ^ Warning: use value of '_barService' field } } </code></example> </member> <member name="T:JetBrains.Annotations.PathReferenceAttribute"> <summary> Indicates that a parameter is a path to a file or a folder within a web project. Path can be relative or absolute, starting from web root (~). </summary> </member> <member name="T:JetBrains.Annotations.SourceTemplateAttribute"> <summary> An extension method marked with this attribute is processed by code completion as a 'Source Template'. When the extension method is completed over some expression, its source code is automatically expanded like a template at call site. </summary> <remarks> Template method body can contain valid source code and/or special comments starting with '$'. Text inside these comments is added as source code when the template is applied. Template parameters can be used either as additional method parameters or as identifiers wrapped in two '$' signs. Use the <see cref="T:JetBrains.Annotations.MacroAttribute"/> attribute to specify macros for parameters. </remarks> <example> In this example, the 'forEach' method is a source template available over all values of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: <code> [SourceTemplate] public static void forEach<T>(this IEnumerable<T> xs) { foreach (var x in xs) { //$ $END$ } } </code> </example> </member> <member name="T:JetBrains.Annotations.MacroAttribute"> <summary> Allows specifying a macro for a parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see>. </summary> <remarks> You can apply the attribute on the whole method or on any of its additional parameters. The macro expression is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Expression"/> property. When applied on a method, the target template parameter is defined in the <see cref="P:JetBrains.Annotations.MacroAttribute.Target"/> property. To apply the macro silently for the parameter, set the <see cref="P:JetBrains.Annotations.MacroAttribute.Editable"/> property value = -1. </remarks> <example> Applying the attribute on a source template method: <code> [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] public static void forEach<T>(this IEnumerable<T> collection) { foreach (var item in collection) { //$ $END$ } } </code> Applying the attribute on a template method parameter: <code> [SourceTemplate] public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { /*$ var $x$Id = "$newguid$" + x.ToString(); x.DoSomething($x$Id); */ } </code> </example> </member> <member name="P:JetBrains.Annotations.MacroAttribute.Expression"> <summary> Allows specifying a macro that will be executed for a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> parameter when the template is expanded. </summary> </member> <member name="P:JetBrains.Annotations.MacroAttribute.Editable"> <summary> Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. </summary> <remarks> If the target parameter is used several times in the template, only one occurrence becomes editable; other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, use values >= 0. To make the parameter non-editable when the template is expanded, use -1. </remarks> </member> <member name="P:JetBrains.Annotations.MacroAttribute.Target"> <summary> Identifies the target parameter of a <see cref="T:JetBrains.Annotations.SourceTemplateAttribute">source template</see> if the <see cref="T:JetBrains.Annotations.MacroAttribute"/> is applied on a template method. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcActionAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC action. If applied to a method, the MVC action name is calculated implicitly from the context. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcAreaAttribute"> <summary> ASP.NET MVC attribute. Indicates that the marked parameter is an MVC area. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcControllerAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC controller. If applied to a method, the MVC controller name is calculated implicitly from the context. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcMasterAttribute"> <summary> ASP.NET MVC attribute. Indicates that the marked parameter is an MVC Master. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcModelTypeAttribute"> <summary> ASP.NET MVC attribute. Indicates that the marked parameter is an MVC model type. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Controller.View(String, Object)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcPartialViewAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC partial view. If applied to a method, the MVC partial view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcSuppressViewErrorAttribute"> <summary> ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcDisplayTemplateAttribute"> <summary> ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcEditorTemplateAttribute"> <summary> ASP.NET MVC attribute. Indicates that the marked parameter is an MVC editor template. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcTemplateAttribute"> <summary> ASP.NET MVC attribute. Indicates that the marked parameter is an MVC template. Use this attribute for custom wrappers similar to <c>System.ComponentModel.DataAnnotations.UIHintAttribute(System.String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcViewAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component. If applied to a method, the MVC view name is calculated implicitly from the context. Use this attribute for custom wrappers similar to <c>System.Web.Mvc.Controller.View(Object)</c>. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcViewComponentAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component name. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcViewComponentViewAttribute"> <summary> ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC view component view. If applied to a method, the MVC view component view name is default. </summary> </member> <member name="T:JetBrains.Annotations.AspMvcActionSelectorAttribute"> <summary> ASP.NET MVC attribute. When applied to a parameter of an attribute, indicates that this parameter is an MVC action name. </summary> <example><code> [ActionName("Foo")] public ActionResult Login(string returnUrl) { ViewBag.ReturnUrl = Url.Action("Foo"); // OK return RedirectToAction("Bar"); // Error: Cannot resolve action } </code></example> </member> <member name="T:JetBrains.Annotations.RazorSectionAttribute"> <summary> Razor attribute. Indicates that the marked parameter or method is a Razor section. Use this attribute for custom wrappers similar to <c>System.Web.WebPages.WebPageBase.RenderSection(String)</c>. </summary> </member> <member name="T:JetBrains.Annotations.CollectionAccessAttribute"> <summary> Indicates how method, constructor invocation, or property access over collection type affects the contents of the collection. When applied to a return value of a method indicates if the returned collection is created exclusively for the caller (CollectionAccessType.UpdatedContent) or can be read/updated from outside (CollectionAccessType.Read | CollectionAccessType.UpdatedContent) Use <see cref="P:JetBrains.Annotations.CollectionAccessAttribute.CollectionAccessType"/> to specify the access type. </summary> <remarks> Using this attribute only makes sense if all collection methods are marked with this attribute. </remarks> <example><code> public class MyStringCollection : List<string> { [CollectionAccess(CollectionAccessType.Read)] public string GetFirstString() { return this.ElementAt(0); } } class Test { public void Foo() { // Warning: Contents of the collection is never updated var col = new MyStringCollection(); string x = col.GetFirstString(); } } </code></example> </member> <member name="T:JetBrains.Annotations.CollectionAccessType"> <summary> Provides a value for the <see cref="T:JetBrains.Annotations.CollectionAccessAttribute"/> to define how the collection method invocation affects the contents of the collection. </summary> </member> <member name="F:JetBrains.Annotations.CollectionAccessType.None"> <summary>Method does not use or modify content of the collection.</summary> </member> <member name="F:JetBrains.Annotations.CollectionAccessType.Read"> <summary>Method only reads content of the collection but does not modify it.</summary> </member> <member name="F:JetBrains.Annotations.CollectionAccessType.ModifyExistingContent"> <summary>Method can change content of the collection but does not add new elements.</summary> </member> <member name="F:JetBrains.Annotations.CollectionAccessType.UpdatedContent"> <summary>Method can add new elements to the collection.</summary> </member> <member name="T:JetBrains.Annotations.AssertionMethodAttribute"> <summary> Indicates that the marked method is assertion method, i.e. it halts the control flow if one of the conditions is satisfied. To set the condition, mark one of the parameters with <see cref="T:JetBrains.Annotations.AssertionConditionAttribute"/> attribute. </summary> </member> <member name="T:JetBrains.Annotations.AssertionConditionAttribute"> <summary> Indicates the condition parameter of the assertion method. The method itself should be marked by <see cref="T:JetBrains.Annotations.AssertionMethodAttribute"/> attribute. The mandatory argument of the attribute is the assertion type. </summary> </member> <member name="T:JetBrains.Annotations.AssertionConditionType"> <summary> Specifies assertion type. If the assertion method argument satisfies the condition, then the execution continues. Otherwise, execution is assumed to be halted. </summary> </member> <member name="F:JetBrains.Annotations.AssertionConditionType.IS_TRUE"> <summary>Marked parameter should be evaluated to true.</summary> </member> <member name="F:JetBrains.Annotations.AssertionConditionType.IS_FALSE"> <summary>Marked parameter should be evaluated to false.</summary> </member> <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NULL"> <summary>Marked parameter should be evaluated to null value.</summary> </member> <member name="F:JetBrains.Annotations.AssertionConditionType.IS_NOT_NULL"> <summary>Marked parameter should be evaluated to not null value.</summary> </member> <member name="T:JetBrains.Annotations.TerminatesProgramAttribute"> <summary> Indicates that the marked method unconditionally terminates control flow execution. For example, it could unconditionally throw exception. </summary> </member> <member name="T:JetBrains.Annotations.LinqTunnelAttribute"> <summary> Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select, .Where). This annotation allows inference of [InstantHandle] annotation for parameters of delegate type by analyzing LINQ method chains. </summary> </member> <member name="T:JetBrains.Annotations.NoEnumerationAttribute"> <summary> Indicates that IEnumerable passed as a parameter is not enumerated. Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection. </summary> <example><code> static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class { // custom check for null but no enumeration } void Foo(IEnumerable<string> values) { ThrowIfNull(values, nameof(values)); var x = values.ToList(); // No warnings about multiple enumeration } </code></example> </member> <member name="T:JetBrains.Annotations.RegexPatternAttribute"> <summary> Indicates that the marked parameter, field, or property is a regular expression pattern. </summary> </member> <member name="T:JetBrains.Annotations.InjectedLanguage"> <summary> Language of injected code fragment inside marked by <see cref="T:JetBrains.Annotations.LanguageInjectionAttribute"/> string literal. </summary> </member> <member name="T:JetBrains.Annotations.LanguageInjectionAttribute"> <summary> Indicates that the marked parameter, field, or property is accepting a string literal containing code fragment in a language specified by the <see cref="P:JetBrains.Annotations.LanguageInjectionAttribute.InjectedLanguage"/>. </summary> <example><code> void Foo([LanguageInjection(InjectedLanguage.CSS, Prefix = "body{", Suffix = "}")] string cssProps) { // cssProps should only contains a list of CSS properties } </code></example> </member> <member name="P:JetBrains.Annotations.LanguageInjectionAttribute.InjectedLanguage"> <summary>Specify a language of injected code fragment.</summary> </member> <member name="P:JetBrains.Annotations.LanguageInjectionAttribute.Prefix"> <summary>Specify a string that "precedes" injected string literal.</summary> </member> <member name="P:JetBrains.Annotations.LanguageInjectionAttribute.Suffix"> <summary>Specify a string that "follows" injected string literal.</summary> </member> <member name="T:JetBrains.Annotations.NoReorderAttribute"> <summary> Prevents the Member Reordering feature from tossing members of the marked class. </summary> <remarks> The attribute must be mentioned in your member reordering patterns. </remarks> </member> <member name="T:JetBrains.Annotations.XamlItemsControlAttribute"> <summary> XAML attribute. Indicates the type that has <c>ItemsSource</c> property and should be treated as <c>ItemsControl</c>-derived type, to enable inner items <c>DataContext</c> type resolve. </summary> </member> <member name="T:JetBrains.Annotations.XamlItemBindingOfItemsControlAttribute"> <summary> XAML attribute. Indicates the property of some <c>BindingBase</c>-derived type, that is used to bind some item of <c>ItemsControl</c>-derived type. This annotation will enable the <c>DataContext</c> type resolve for XAML bindings for such properties. </summary> <remarks> Property should have the tree ancestor of the <c>ItemsControl</c> type or marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute. </remarks> </member> <member name="T:JetBrains.Annotations.XamlItemStyleOfItemsControlAttribute"> <summary> XAML attribute. Indicates the property of some <c>Style</c>-derived type, that is used to style items of <c>ItemsControl</c>-derived type. This annotation will enable the <c>DataContext</c> type resolve for XAML bindings for such properties. </summary> <remarks> Property should have the tree ancestor of the <c>ItemsControl</c> type or marked with the <see cref="T:JetBrains.Annotations.XamlItemsControlAttribute"/> attribute. </remarks> </member> <member name="T:JetBrains.Annotations.XamlOneWayBindingModeByDefaultAttribute"> <summary> XAML attribute. Indicates that DependencyProperty has <c>OneWay</c> binding mode by default. </summary> <remarks> This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise. </remarks> </member> <member name="T:JetBrains.Annotations.XamlTwoWayBindingModeByDefaultAttribute"> <summary> XAML attribute. Indicates that DependencyProperty has <c>TwoWay</c> binding mode by default. </summary> <remarks> This attribute must be applied to DependencyProperty's CLR accessor property if it is present, to DependencyProperty descriptor field otherwise. </remarks> </member> <member name="T:JetBrains.Annotations.RouteTemplateAttribute"> <summary> Indicates that the marked parameter, field, or property is a route template. </summary> <remarks> This attribute allows IDE to recognize the use of web frameworks' route templates to enable syntax highlighting, code completion, navigation, rename and other features in string literals. </remarks> </member> <member name="T:JetBrains.Annotations.RouteParameterConstraintAttribute"> <summary> Indicates that the marked type is custom route parameter constraint, which is registered in application's Startup with name <c>ConstraintName</c> </summary> <remarks> You can specify <c>ProposedType</c> if target constraint matches only route parameters of specific type, it will allow IDE to create method's parameter from usage in route template with specified type instead of default <c>System.String</c> and check if constraint's proposed type conflicts with matched parameter's type </remarks> </member> <member name="T:JetBrains.Annotations.UriStringAttribute"> <summary> Indicates that the marked parameter, field, or property is an URI string. </summary> <remarks> This attribute enables code completion, navigation, rename and other features in URI string literals assigned to annotated parameter, field or property. </remarks> </member> <member name="T:JetBrains.Annotations.CodeTemplateAttribute"> <summary> <para> Defines the code search template using the Structural Search and Replace syntax. It allows you to find and, if necessary, replace blocks of code that match a specific pattern. Search and replace patterns consist of a textual part and placeholders. Textural part must contain only identifiers allowed in the target language and will be matched exactly (white spaces, tabulation characters, and line breaks are ignored). Placeholders allow matching variable parts of the target code blocks. A placeholder has the following format: $placeholder_name$- where placeholder_name is an arbitrary identifier. </para> <para> Available placeholders: <list type="bullet"> <item>$this$ - expression of containing type</item> <item>$thisType$ - containing type</item> <item>$member$ - current member placeholder</item> <item>$qualifier$ - this placeholder is available in the replace pattern and can be used to insert qualifier expression matched by the $member$ placeholder. (Note that if $qualifier$ placeholder is used, then $member$ placeholder will match only qualified references)</item> <item>$expression$ - expression of any type</item> <item>$identifier$ - identifier placeholder</item> <item>$args$ - any number of arguments</item> <item>$arg$ - single argument</item> <item>$arg1$ ... $arg10$ - single argument</item> <item>$stmts$ - any number of statements</item> <item>$stmt$ - single statement</item> <item>$stmt1$ ... $stmt10$ - single statement</item> <item>$name{Expression, 'Namespace.FooType'}$ - expression with 'Namespace.FooType' type</item> <item>$expression{'Namespace.FooType'}$ - expression with 'Namespace.FooType' type</item> <item>$name{Type, 'Namespace.FooType'}$ - 'Namespace.FooType' type</item> <item>$type{'Namespace.FooType'}$ - 'Namespace.FooType' type</item> <item>$statement{1,2}$ - 1 or 2 statements</item> </list> </para> <para> Note that you can also define your own placeholders of the supported types and specify arguments for each placeholder type. This can be done using the following format: $name{type, arguments}$. Where 'name' - is the name of your placeholder, 'type' - is the type of your placeholder (one of the following: Expression, Type, Identifier, Statement, Argument, Member), 'arguments' - arguments list for your placeholder. Each placeholder type supports it's own arguments, check examples below for mode details. Placeholder type may be omitted and determined from the placeholder name, if name has one of the following prefixes: <list type="bullet"> <item>expr, expression - expression placeholder, e.g. $exprPlaceholder{}$, $expressionFoo{}$</item> <item>arg, argument - argument placeholder, e.g. $argPlaceholder{}$, $argumentFoo{}$</item> <item>ident, identifier - identifier placeholder, e.g. $identPlaceholder{}$, $identifierFoo{}$</item> <item>stmt, statement - statement placeholder, e.g. $stmtPlaceholder{}$, $statementFoo{}$</item> <item>type - type placeholder, e.g. $typePlaceholder{}$, $typeFoo{}$</item> <item>member - member placeholder, e.g. $memberPlaceholder{}$, $memberFoo{}$</item> </list> </para> <para> Expression placeholder arguments: <list type="bullet"> <item>expressionType - string value in single quotes, specifies full type name to match (empty string by default)</item> <item>exactType - boolean value, specifies if expression should have exact type match (false by default)</item> </list> Examples: <list type="bullet"> <item>$myExpr{Expression, 'Namespace.FooType', true}$ - defines expression placeholder, matching expressions of the 'Namespace.FooType' type with exact matching.</item> <item>$myExpr{Expression, 'Namespace.FooType'}$ - defines expression placeholder, matching expressions of the 'Namespace.FooType' type or expressions which can be implicitly converted to 'Namespace.FooType'.</item> <item>$myExpr{Expression}$ - defines expression placeholder, matching expressions of any type.</item> <item>$exprFoo{'Namespace.FooType', true}$ - defines expression placeholder, matching expressions of the 'Namespace.FooType' type with exact matching.</item> </list> </para> <para> Type placeholder arguments: <list type="bullet"> <item>type - string value in single quotes, specifies full type name to match (empty string by default)</item> <item>exactType - boolean value, specifies if expression should have exact type match (false by default)</item> </list> Examples: <list type="bullet"> <item>$myType{Type, 'Namespace.FooType', true}$ - defines type placeholder, matching 'Namespace.FooType' types with exact matching.</item> <item>$myType{Type, 'Namespace.FooType'}$ - defines type placeholder, matching 'Namespace.FooType' types or types, which can be implicitly converted to 'Namespace.FooType'.</item> <item>$myType{Type}$ - defines type placeholder, matching any type.</item> <item>$typeFoo{'Namespace.FooType', true}$ - defines types placeholder, matching 'Namespace.FooType' types with exact matching.</item> </list> </para> <para> Identifier placeholder arguments: <list type="bullet"> <item>nameRegex - string value in single quotes, specifies regex to use for matching (empty string by default)</item> <item>nameRegexCaseSensitive - boolean value, specifies if name regex is case sensitive (true by default)</item> <item>type - string value in single quotes, specifies full type name to match (empty string by default)</item> <item>exactType - boolean value, specifies if expression should have exact type match (false by default)</item> </list> Examples: <list type="bullet"> <item>$myIdentifier{Identifier, 'my.*', false, 'Namespace.FooType', true}$ - defines identifier placeholder, matching identifiers (ignoring case) starting with 'my' prefix with 'Namespace.FooType' type.</item> <item>$myIdentifier{Identifier, 'my.*', true, 'Namespace.FooType', true}$ - defines identifier placeholder, matching identifiers (case sensitively) starting with 'my' prefix with 'Namespace.FooType' type.</item> <item>$identFoo{'my.*'}$ - defines identifier placeholder, matching identifiers (case sensitively) starting with 'my' prefix.</item> </list> </para> <para> Statement placeholder arguments: <list type="bullet"> <item>minimalOccurrences - minimal number of statements to match (-1 by default)</item> <item>maximalOccurrences - maximal number of statements to match (-1 by default)</item> </list> Examples: <list type="bullet"> <item>$myStmt{Statement, 1, 2}$ - defines statement placeholder, matching 1 or 2 statements.</item> <item>$myStmt{Statement}$ - defines statement placeholder, matching any number of statements.</item> <item>$stmtFoo{1, 2}$ - defines statement placeholder, matching 1 or 2 statements.</item> </list> </para> <para> Argument placeholder arguments: <list type="bullet"> <item>minimalOccurrences - minimal number of arguments to match (-1 by default)</item> <item>maximalOccurrences - maximal number of arguments to match (-1 by default)</item> </list> Examples: <list type="bullet"> <item>$myArg{Argument, 1, 2}$ - defines argument placeholder, matching 1 or 2 arguments.</item> <item>$myArg{Argument}$ - defines argument placeholder, matching any number of arguments.</item> <item>$argFoo{1, 2}$ - defines argument placeholder, matching 1 or 2 arguments.</item> </list> </para> <para> Member placeholder arguments: <list type="bullet"> <item>docId - string value in single quotes, specifies XML documentation id of the member to match (empty by default)</item> </list> Examples: <list type="bullet"> <item>$myMember{Member, 'M:System.String.IsNullOrEmpty(System.String)'}$ - defines member placeholder, matching 'IsNullOrEmpty' member of the 'System.String' type.</item> <item>$memberFoo{'M:System.String.IsNullOrEmpty(System.String)'}$ - defines member placeholder, matching 'IsNullOrEmpty' member of the 'System.String' type.</item> </list> </para> <para> For more information please refer to the <a href="https://www.jetbrains.com/help/resharper/Navigation_and_Search__Structural_Search_and_Replace.html">Structural Search and Replace</a> article. </para> </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.SearchTemplate"> <summary> Structural search pattern to use in the code template. Pattern includes textual part, which must contain only identifiers allowed in the target language, and placeholders, which allow matching variable parts of the target code blocks. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.Message"> <summary> Message to show when the search pattern was found. You can also prepend the message text with "Error:", "Warning:", "Suggestion:" or "Hint:" prefix to specify the pattern severity. Code patterns with replace template produce suggestions by default. However, if replace template is not provided, then warning severity will be used. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.ReplaceTemplate"> <summary> Structural search replace pattern to use in code template replacement. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.ReplaceMessage"> <summary> Replace message to show in the light bulb. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.FormatAfterReplace"> <summary> Apply code formatting after code replacement. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.MatchSimilarConstructs"> <summary> Whether similar code blocks should be matched. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.ShortenReferences"> <summary> Automatically insert namespace import directives or remove qualifiers that become redundant after the template is applied. </summary> </member> <member name="P:JetBrains.Annotations.CodeTemplateAttribute.SuppressionKey"> <summary> String to use as a suppression key. By default the following suppression key is used 'CodeTemplate_SomeType_SomeMember', where 'SomeType' and 'SomeMember' are names of the associated containing type and member to which this attribute is applied. </summary> </member> </members> </doc> |