Lib/Desktop/TfsCmdlets.PSDesktop.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>TfsCmdlets.PSDesktop</name> </assembly> <members> <member name="T:TfsCmdlets.AssemblyResolver"> <summary> Custom assembly resolver </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.TeamProjectCollection.DismountTeamProjectCollection"> <summary> Detaches a team project collection database from a Team Foundation Server installation. </summary> <remarks> Before you move a collection, you must first detach it from the deployment of TFS on which it is running. It's very important that you do not skip this step. When you detach a collection, all jobs and services are stopped, and then the collection database is stopped. In addition, the detach process copies over the collection-specific data from the configuration database and saves it as part of the team project collection database. This configuration data is what allows the collection database to be attached to a different deployment of TFS. If that data is not present, you cannot attach the collection to any deployment of TFS except the one from which it originated. If detachment succeeds, this cmdlets returns the original database connection string. It is required to re-attach the collection to TFS. </remarks> <example> <code>Dismount-TfsTeamProjectCollection -Collection http://vsalm:8080/tfs/DefaultCollection -Reason "Collection DefaultCollecton is down for maintenance"</code> <para>Detaches the project collection specified by the URL provided in the Collection argument, defining a Maintenance Message to be shown to users when they try to connect to that collection while it is detached</para> </example> <related>https://www.visualstudio.com/en-us/docs/setup-admin/tfs/admin/move-project-collection#1-detach-the-collection</related> <notes> Detaching a collection prevents users from accessing any projects in that collection. </notes> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.DismountTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.DismountTeamProjectCollection.Collection"> <summary> Specifies the collection to detach. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.DismountTeamProjectCollection.Reason"> <summary> Speficies a Servicing Message (optional), to provide a message for users who might try to connect to projects in this collection while it is offline. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.DismountTeamProjectCollection.Timeout"> <summary> Specifies the maximum period of time this cmdlet should wait for the detach procedure to complete. By default, it waits indefinitely until the collection servicing completes. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.DismountTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection"> <summary> Attaches a team project collection database to a Team Foundation Server installation. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.Collection"> <summary> Specifies the name of the collection to attach. It can be different from the original name - in that case, it is attached under a new name. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.Description"> <summary> Specifies a new description for the collection. When omitted, it retains the original description. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.DatabaseServer"> <summary> Specifies the name of the SQL Server instance where the database is stored. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.DatabaseName"> <summary> Specifies the name of the collection database. </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.ConnectionString"> <summary> Specifies the connection string of the collection database. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.InitialState"> <summary> Specifies whether the collection will be started ou stopped after being attached. When omitted, the collection is automatically started and goes online after being attached. </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.Clone"> <summary> Changes the internal collection IDs upon attaching to that a "clone" of the original collection can be attached to the same server. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.PollingInterval"> <summary> Specifies the polling interval (in seconds) to get an updated status from the server. When omitted, defaults to 5 seconds. </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.Timeout"> <summary> Specifies the maximum period of time this cmdlet should wait for the attach procedure to complete. By default, it waits indefinitely until the collection servicing completes. </summary> </member> <member name="F:TfsCmdlets.Cmdlets.TeamProjectCollection.MountTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.StartTeamProjectCollection"> <summary> Starts an offline team project collection and make it online. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.StartTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.StopTeamProjectCollection"> <summary> Stops a team project collection and make it offline. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.StopTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.GetRegisteredTeamProjectCollection"> <summary> Gets one or more Team Project Collection addresses registered in the current computer. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.GetRegisteredTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </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.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.Credential"> <summary> HELP_PARAM_CREDENTIAL </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="M:TfsCmdlets.Cmdlets.TeamProjectCollection.GetTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.NewTeamProjectCollection"> <summary> Creates a new team project collection. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.NewTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.TeamProjectCollection.RemoveTeamProjectCollection"> <summary> Deletes a team project collection. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TeamProjectCollection.RemoveTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.StartIdentitySync"> <summary> Triggers an Identity Sync server job. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Admin.StartIdentitySync.DoProcessRecord"> <inheritdoc/> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.StartIdentitySync.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.StartIdentitySync.Wait"> <summary> Waits until the job finishes running. If omitted, the identity sync job will run asynchronously. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.StartIdentitySync.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Admin.GetConfigurationServerConnectionString"> <summary> Gets the configuration server database connection string. </summary> <related uri="https://tfscmdlets.dev/admin/get-tfsconfigurationserverconnectionstring/">Online version:</related> <related>Get-TfsInstallationPath</related> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.GetConfigurationServerConnectionString.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.GetConfigurationServerConnectionString.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.GetConfigurationServerConnectionString.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.GetConfigurationServerConnectionString.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="M:TfsCmdlets.Cmdlets.Admin.GetConfigurationServerConnectionString.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Admin.GetInstallationPath.DoProcessRecord"> <summary> Performs execution of the command </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="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="M:TfsCmdlets.Cmdlets.Admin.Registry.GetRegistryValue.DoProcessRecord"> <summary> Performs execution of the command </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.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Admin.Registry.SetRegistryValue.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ConfigServer.GetRegisteredConfigurationServer"> <summary> Gets one or more Team Foundation Server addresses registered in the current computer. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ConfigServer.GetRegisteredConfigurationServer.DoProcessRecord"> <inheritdoc/> </member> <member name="P:TfsCmdlets.Cmdlets.ConfigServer.GetRegisteredConfigurationServer.Server"> <summary> Specifies the name of a registered server. Wildcards are supported. When omitted, all registered servers are returned. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.ConfigServer.GetConfigurationServer"> <summary> Gets information about a configuration server. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ConfigServer.GetConfigurationServer.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ConfigServer.GetConfigurationServer.Current"> <summary> Returns the configuration server specified in the last call to Connect-TfsConfigurationServer (i.e. the "current" configuration server) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.ConfigServer.GetConfigurationServer.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ConfigServer.GetConfigurationServer.DoProcessRecord"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer"> <summary> Connects to a configuration server. </summary> <remarks> A TFS Configuration Server represents the server that is running Team Foundation Server. On a database level, it is represented by the Tfs_Configuration database. Operations that should be performed on a server level (such as setting server-level permissions) require a connection to a TFS configuration server. Internally, this connection is represented by an instance of the Microsoft.TeamFoundation.Client.TfsConfigurationServer. NOTE: Currently it is only supported in Windows PowerShell. </remarks> <example> <code>Connect-TfsConfigurationServer -Server http://vsalm:8080/tfs</code> <para>Connects to the TFS server specified by the URL in the Server argument</para> </example> <example> <code>Connect-TfsConfigurationServer -Server vsalm</code> <para>Connects to a previously registered TFS server by its user-defined name "vsalm". For more information, see Get-TfsRegisteredConfigurationServer</para> </example> <para type="input">Microsoft.TeamFoundation.Client.TfsConfigurationServer</para> <para type="input">System.String</para> <para type="input">System.Uri</para> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.DoProcessRecord"> <inheritdoc/> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Server"> <summary> Specifies either a URL/name of the Team Foundation Server to connect to, or a previously initialized TfsConfigurationServer object. When using a URL, it must be fully qualified. To connect to a Team Foundation Server instance by using its name, it must have been previously registered. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectConfigurationServer.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.ConnectTeam"> <summary> Connects to a team. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.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.Connection.ConnectTeam.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeam.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.ConnectTeam.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject"> <summary> Connects to a Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.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.Connection.ConnectTeamProject.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.ConnectTeamProject.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.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.Connection.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.Connection.ConnectTeamProjectCollection.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.ConnectTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.DisconnectConfigurationServer"> <summary> Disconnects from the currently connected configuration server. </summary> <remarks> The Disconnect-TfsConfigurationServer cmdlet removes the connection previously set by its counterpart Connect-TfsConfigurationServer. Therefore, cmdlets relying on a "default server" as provided by "Get-TfsConfigurationServer -Current" will no longer work after a call to this cmdlet, unless their -Server argument is provided or a new call to Connect-TfsConfigurationServer is made. </remarks> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.DisconnectConfigurationServer.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.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="M:TfsCmdlets.Cmdlets.Connection.DisconnectTeam.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.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="M:TfsCmdlets.Cmdlets.Connection.DisconnectTeamProject.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.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="M:TfsCmdlets.Cmdlets.Connection.DisconnectTeamProjectCollection.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Connection.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.Connection.NewCredential.Url"> <summary> Specifies the URL of the server, collection or organization to connect to. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.Cached"> <summary> HELP_PARAM_CACHED_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.UserName"> <summary> HELP_PARAM_USER_NAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.Password"> <summary> HELP_PARAM_PASSWORD </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.Credential"> <summary> HELP_PARAM_CREDENTIAL </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.PersonalAccessToken"> <summary> HELP_PARAM_PERSONAL_ACCESS_TOKEN </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Connection.NewCredential.Interactive"> <summary> HELP_PARAM_INTERACTIVE </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Connection.NewCredential.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.ProcessTemplate.ExportProcessTemplate.DoProcessRecord"> <inheritdoc/> </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="T:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate"> <summary> Imports a process template definition from disk. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ProcessTemplate.ImportProcessTemplate.DoProcessRecord"> <inheritdoc/> </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="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="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="T:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType"> <summary> Exports an XML work item type definition from a team project. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ExportWorkItemType.DoProcessRecord"> <summary> Performs execution of the command </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.Force"> <summary> Allows the cmdlet to overwrite an existing file in the destination folder. </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="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="T:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType"> <summary> Imports a work item type definition into a team project. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.WorkItemType.ImportWorkItemType.DoProcessRecord"> <summary> Performs execution of the command </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.StructureGroup"> <inheritdoc/> </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.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetClassificationNode"> <summary> Base implementation for Get-Area and Get-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetClassificationNode.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.GetClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration) </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveArea"> <summary> Gets one or more Work Item Areas from a given Team Project. </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.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration"> <summary> Gets one or more Iterations from a given Team Project. </summary> <example> <code>Get-TfsIteration</code> <para>Returns all aiterations 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.MoveIteration.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveIteration.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode"> <summary> Base implementation for Move-Area and Move-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Destination"> <summary> Specifies the name and/or path of the destination parent node. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Force"> <summary> Allows the cmdlet to create destination parent node(s) if they're missing. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.MoveClassificationNode.DoProcessRecord"> <summary> Performs execution of the command </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.StructureGroup"> <inheritdoc/> </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.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewClassificationNode"> <summary> Base implementation for New-Area and New-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.NewClassificationNode.Force"> <summary> Allows the cmdlet to create parent nodes if they're missing. </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.StructureGroup"> <inheritdoc/> </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.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode"> <summary> Base implementation for Remove-Area and Remove-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.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.RemoveClassificationNode.Recurse"> <summary> Removes node(s) recursively. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RemoveClassificationNode.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameAreaNode"> <summary> Renames a Work Area. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameAreaNode.Node"> <summary> HELP_PARAM_AREA </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameAreaNode.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIterationNode"> <summary> Renames a Iteration. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIterationNode.Node"> <summary> HELP_PARAM_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameIterationNode.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode"> <summary> Base implementation for Rename-Area and Rename-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.RenameClassificationNode.DoProcessRecord"> <summary> Performs execution of the command </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.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetClassificationNode"> <summary> Base implementation for Set-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.SetClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration) </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.StructureGroup"> <inheritdoc/> </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_ITERATION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestIteration.StructureGroup"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode"> <summary> Base implementation for Test-Area and Test-Iteration </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode.Node"> <summary> Specifies the name and/or path of the node (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode.StructureGroup"> <summary> Indicates the type of structure (area or iteration) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.AreasIterations.TestClassificationNode.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem"> <summary> Creates a copy of a work item, optionally changing its type. </summary> <remarks> Use this cmdlet to create a copy of a work item (using its latest saved state/revision data) that is of the specified work item type. <br/> By default, the copy retains the same type of the original work item, unless the Type argument is specified </remarks> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.WorkItem"> <summary> HELP_PARAM_WORKITEM </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.NewType"> <summary> Specifies the type of the new work item. When omitted, the type of the original work item is preserved. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.IncludeAttachments"> <summary> Creates a duplicate of all attachments present in the source work item and adds them to the new work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.IncludeLinks"> <summary> Creates a copy of all links present in the source work item and adds them to the new work item. Only the links are copied; linked artifacts themselves are not copied. In other words, both the original and the copy work items point to the same linked artifacts. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.DestinationProject"> <summary> Specifies the team project where the work item will be copied into. When omitted, the copy will be created in the same team project of the source work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.Project"> <summary> Specifies the source team project from where the work item will be copied. When omitted, it defaults to the team project of the piped work item (if any), or to the connection set by Connect-TfsTeamProject. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.Passthru"> <summary> Returns the results of the command. It takes one of the following values: Original (returns the original work item), Copy (returns the newly created work item copy) or None. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.CopyWorkItem.DoProcessRecord"> <summary> Performs execution of the command </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> 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.Query"> <summary> Specifies a query written in WIQL (Work Item Query Language) </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. </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="T:TfsCmdlets.Cmdlets.WorkItem.History.GetWorkItemHistory"> <summary> Gets the history of changes of a work item. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.History.GetWorkItemHistory.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink"> <summary> Adds a link between two work items. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.Linking.AddWorkItemLink.DoProcessRecord"> <summary> Performs execution of the command </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 exported. </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="M:TfsCmdlets.Cmdlets.WorkItem.Linking.ExportWorkItemAttachment.DoProcessRecord"> <summary> Performs execution of the command </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.IncludeAttachments"> <summary> Includes attachment information alongside links. When omitted, only links are retrieved. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLinkEndType"> <summary> Gets the work item link end types of a team project collection. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.Linking.GetWorkItemLinkEndType.DoProcessRecord"> <summary> Performs execution of the command </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.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.WorkItem.MoveWorkItem.DoProcessRecord"> <summary> Performs execution of the command </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.Area"> <summary> Specifies the area path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.NewWorkItem.Iteration"> <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.Team"> <summary> HELP_PARAM_TEAM </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> Allows the cmdlet to overwrite an existing file in the destination folder. </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="M:TfsCmdlets.Cmdlets.WorkItem.Query.ExportWorkItemQuery.DoProcessRecord"> <summary> Performs execution of the command </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.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQuery.ItemType"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryFolder"> <summary> Gets the definition of one or more work item saved queries. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.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> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryFolder.ItemType"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryItemCmdletBase"> <summary> Base implementation for Get-WorkItemQuery and Get-WorkItemQueryFolder </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryItemCmdletBase.ItemType"> <summary> Indicates the type of item (query or folder) </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.GetWorkItemQueryItemCmdletBase.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.GetWorkItemQueryItemCmdletBase.Deleted"> <summary> Returns deleted items. </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.Wiql"> <summary> Specifies the query definition text in WIQL (Work Item Query Language). </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQuery.ItemType"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQueryFolder"> <summary> Create a new work items query in the given Team Project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.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.NewWorkItemQueryFolder.ItemType"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQueryItemCmdletBase"> <summary> Base implementation for New-WorkItemQuery and New-WorkItemQueryFolder </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQueryItemCmdletBase.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.NewWorkItemQueryItemCmdletBase.Force"> <summary> Allow the cmdlet to overwrite an existing item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.Query.NewWorkItemQueryItemCmdletBase.ItemType"> <summary> Indicates the type of item (query or folder) </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="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="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.Area"> <summary> Specifies the area path of the work item. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.WorkItem.SetWorkItem.Iteration"> <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.Team"> <summary> HELP_PARAM_TEAM </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> <value></value> </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="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="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="T:TfsCmdlets.Cmdlets.CmdletBase"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.CmdletBase.Provider"> <summary> The service provider injected in this cmdlet instance </summary> </member> <member name="P:TfsCmdlets.Cmdlets.CmdletBase.CommandName"> <summary> Returns the PowerShell command name of this cmdlet </summary> <value>The name of the this, as defined by the [Cmdlet] attribute. If the attribute is missing, returns the class name.</value> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.BeginProcessing"> <summary> Performs initialization of the command execution, logs the supplied parameters and check whether the current this is tagged as "Windows-only". If so, throws an exception </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.ProcessRecord"> <summary> Performs execution of the command. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.InvokeScript(System.String,System.Object[])"> <summary> Executes a PowerShell script in the current session context </summary> <param name="script">A string containing a valid PS script</param> <param name="arguments">Arguments passed to the script, represented as an array named <c>$args</c></param> <returns>The output of the script, if any</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.InvokeScript(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Executes a PowerShell script in the current session context </summary> <param name="script">A string containing a valid PS script</param> <param name="variables">Variables passed to the script</param> <returns>The output of the script, if any</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.InvokeScript``1(System.String,System.Object[])"> <summary> Executes a PowerShell script in the current session context </summary> <param name="script">A string containing a valid PS script</param> <param name="arguments">Arguments passed to the script, represented as an array named <c>$args</c></param> <typeparam name="T">The expected type of the objects outputted by the script</typeparam> <returns>The output of the script, if any</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetServer(TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Returns a "server" Connection object built from the arguments currently supplied to this cmdlet </summary> <param name="parameters">If specified, the values in this parameter will override the values originally supplied to the this</param> <returns>An instance of Connection containing either a TfsConfigurationServer (Windows) or VssConnection (Core) object</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetCollection(TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Returns a "collection" Connection object built from the arguments currently supplied to this cmdlet </summary> <param name="parameters">If specified, the values in this parameter will override the values originally supplied to the this</param> <returns>An instance of Connection containing either a TfsTeamProjectCollection (Windows) or VssConnection (Core) object</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetCollectionAndProject(TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Returns a tuple containing a "collection" Connection and a TeamProject objects, built from the arguments currently supplied to this cmdlet </summary> <param name="parameters">If specified, the values in this parameter will override the values originally supplied to the this</param> <returns>A tuple consisting of an instance of Connection (containing either a TfsTeamProjectCollection (Windows) or VssConnection (Core) object) and an instance of TeamProject</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetCollectionProjectAndTeam(TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Returns a tuple containing a "collection" Connectionn, a TeamProject and a WebApiTeam objects, built from the arguments currently supplied to this cmdlet </summary> <param name="parameters">If specified, the values in this parameter will override the values originally supplied to the this</param> <returns>A tuple consisting of an instance of Connection (containing either a TfsTeamProjectCollection (Windows) or VssConnection (Core) object), an instance of TeamProject and an instance of WebApiTeam</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetClient``1(TfsCmdlets.ClientScope,TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Returns an API Client from the underlying connection </summary> <param name="scope">The scope from which to retrieve the client. Supported scopes are Server, Collection</param> <param name="parameters">If specified, the values in this parameter will override the values originally supplied to the this</param> <typeparam name="T">The type of the API client</typeparam> <returns>An instance of the requested API client</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetService``1"> <summary> Returns an instance of the specified service </summary> <typeparam name="T">The type of the requested service.static Must derive from IService</typeparam> <returns>An instance of T, as provided by the current service provider</returns> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetItem``1(System.Object)"> <summary> Gets one item of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.TestItem``1(System.Object)"> <summary> Checks if specified item exists </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetItems``1(System.Object)"> <summary> Gets one or more items of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.NewItem``1(System.Object)"> <summary> Creates a new item of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.RemoveItem``1(System.Object)"> <summary> Removes an item of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.RenameItem``1(System.Object)"> <summary> Renames an item of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.SetItem``1(System.Object)"> <summary> Renames an item of the specified type </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.GetCurrentDirectory"> <summary> Gets the current directory in PowerShell </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.ResolvePath(System.String,System.String)"> <summary> Gets the current directory in PowerShell </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.WriteItems``1(System.Object)"> <summary> Outputs items to PowerShell </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.Log(System.String,System.String,System.Boolean)"> <summary> Log a message </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.LogParameters"> <summary> Log the parameters passed to the cmdlet </summary> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.CheckWindowsOnly"> <summary> Check whether the currently executing environment is Windows PowerShell </summary> <throws>For cmdlets which are "Windows-only", a call to this method will throw a NotSupportedException when running on PowerShell Core.</throws> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.CheckRequiredVersion"> <summary> Check whether the currently connected server is of a minimum version </summary> <throws> For cmdlets which require a certain version of TFS, a call to this method will throw a NotSupportedException when connected to an older server. </throws> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.ShouldContinue(System.String,System.String,System.Boolean)"> <inheritdoc/> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.ShouldContinue(System.String,System.Boolean@,System.Boolean@,System.String,System.Boolean)"> <inheritdoc/> </member> <member name="M:TfsCmdlets.Cmdlets.CmdletBase.DoProcessRecord"> <summary> Performs execution of the command. Must be overriden in derived classes. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GetCmdletBase`1"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GetCmdletBase`1.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GetCmdletBase`1.DoProcessRecord"> <summary> Performs execution of the command. </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="M:TfsCmdlets.Cmdlets.Git.Branch.GetGitBranch.DoProcessRecord"> <summary> Performs execution of the command </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.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Git.GitRepositoryDataService.DoNewItem"> <summary> Performs execution of the command </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="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="F: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="M:TfsCmdlets.Cmdlets.Git.Policy.GetGitBranchPolicy.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Git.Policy.GetGitPolicyType.DoProcessRecord"> <summary> Performs execution of the command </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="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="T:TfsCmdlets.Cmdlets.GlobalList.ExportGlobalList"> <summary> Exports the contents of one or more Global Lists to XML. </summary> <remarks> This cmdlets generates an XML containing one or more global lists and their respective items, in the same format used by witadmin. It is functionally equivalent to "witadmin exportgloballist" </remarks> <example> <code>Export-TfsGlobalList | Out-File "gl.xml"</code> <para>Exports all global lists in the current project collection to a file called gl.xml.</para> </example> <example> <code>Export-TfsGlobalList -Name "Builds - *"</code> <para>Exports all build-related global lists (with names starting with "Build - ") and return the resulting XML document.</para> </example> <notes> To export or list global lists, you must be a member of the Project Collection Valid Users group or have your View collection-level information permission set to Allow. </notes> <input>Microsoft.TeamFoundation.Client.TfsTeamProjectCollection</input> <input>System.String</input> <input>System.Uri</input> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.ExportGlobalList.GlobalList"> <summary> Specifies the name of the global list to be exported. Wildcards are supported. When omitted, it defaults to all global lists in the supplied team project collection. When using wilcards, a single XML document will be producer containing all matching global lists. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.ExportGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.ExportGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.GetGlobalList"> <summary> Gets the contents of one or more Global Lists. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.GetGlobalList.GlobalList"> <summary> Specifies the name of the global list. Wildcards are supported. When omitted, defaults to all global lists in the supplied team project collection. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.GetGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.GetGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.ImportGlobalList"> <summary> Imports one or more Global Lists from an XML document </summary> <remarks> This cmdletsimports an XML containing one or more global lists and their respective items, in the same format used by witadmin. It is functionally equivalent to "witadmin importgloballist" </remarks> <example> <code>Get-Content gl.xml | Import-GlobalList</code> <para>Imports the contents of an XML document called gl.xml to the current project collection</para> </example> <notes> To import global lists, you must be a member of the Project Collection Administrators security group. </notes> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.ImportGlobalList.InputObject"> <summary> XML document object containing one or more global list definitions. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.ImportGlobalList.Force"> <summary> Allows the cmdlet to import a global list that already exists. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.ImportGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.ImportGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList"> <summary> Creates a new Global List. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.GlobalList"> <summary> Specifies the name of the new global list. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.Items"> <summary> Specifies the contents (items) of the new global list. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.Force"> <summary> Allows the cmdlet to overwrite an existing global list. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.NewGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.RemoveGlobalList"> <summary> Deletes one or more Global Lists. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.RemoveGlobalList.GlobalList"> <summary> Specifies the name of global list to be deleted. Wildcards are supported. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.RemoveGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.RemoveGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.RenameGlobalList"> <summary> Changes either the name or the contents of a Global List. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.RenameGlobalList.GlobalList"> <summary> Specifies the name of the global lsit to be renamed. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.RenameGlobalList.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.RenameGlobalList.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.GlobalList.RenameGlobalList.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList"> <summary> Changes the contents of a Global List. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList.GlobalList"> <summary> Specifies the name of the global list to be changed. </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList.Add"> <summary> Specifies a list of items to be added to the global list. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList.Remove"> <summary> Specifies a list of items to be removed from the global list. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList.Force"> <summary> Creates a new list if the specified one does not exist. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.GlobalList.SetGlobalList.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Identity.GetIdentity"> <summary> Gets one or more identities that represents either users or groups in Azure DevOps. </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.Server"> <summary> HELP_PARAM_SERVER </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Identity.GetIdentity.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Identity.Group.AddGroupMember.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Identity.Group.GetGroupMember.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Identity.Group.RemoveGroupMember.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.NewCmdletBase`1"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.NewCmdletBase`1.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.NewCmdletBase`1.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.NewCmdletBase`1.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.NewCmdletBase`1.DoProcessRecord"> <summary> Performs execution of the command. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.GetBuildDefinitionFolder"> <summary> Gets one or more build/pipeline definition folders in a team project. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.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.GetBuildDefinitionFolder.QueryOrder"> <summary> Specifies the query order. When omitted, defaults to None. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.GetBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> <value></value> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.GetBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> <value></value> </member> <member name="M:TfsCmdlets.Cmdlets.Pipeline.Build.GetBuildDefinitionFolder.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.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.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.NewBuildDefinitionFolder.Description"> <summary> Specifies the description of the new build/pipeline folder. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.NewBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.NewBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.NewBuildDefinitionFolder.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Pipeline.Build.NewBuildDefinitionFolder.DoProcessRecord"> <inheritdoc/> </member> <member name="T:TfsCmdlets.Cmdlets.Pipeline.Build.RemoveBuildDefinitionFolder"> <summary> Deletes one or more build/pipeline definition folders. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.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.RemoveBuildDefinitionFolder.Recurse"> <summary> Removes folders recursively. When omitted, folders with subfolders cannot be deleted. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.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.RemoveBuildDefinitionFolder.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Pipeline.Build.RemoveBuildDefinitionFolder.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Pipeline.Build.RemoveBuildDefinitionFolder.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Pipeline.ReleaseManagement.GetReleaseDefinition.DoProcessRecord"> <summary> Performs execution of the command </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="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="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="T:TfsCmdlets.Cmdlets.Pipeline.XamlBuild.StartXamlBuild"> <summary> Queues a XAML Build. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Pipeline.XamlBuild.StartXamlBuild.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.RemoveCmdletBase`1"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RemoveCmdletBase`1.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RemoveCmdletBase`1.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.RemoveCmdletBase`1.DoProcessRecord"> <summary> Performs execution of the command. </summary> </member> <member name="T:TfsCmdlets.Cmdlets.RenameCmdletBase`1"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RenameCmdletBase`1.NewName"> <summary> HELP_PARAM_NEWNAME </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RenameCmdletBase`1.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RenameCmdletBase`1.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.RenameCmdletBase`1.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.RenameCmdletBase`1.DoProcessRecord"> <summary> Performs execution of the command. </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="M:TfsCmdlets.Cmdlets.RestApi.GetRestClient.DoProcessRecord"> <summary> Performs execution of the command </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.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.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="M:TfsCmdlets.Cmdlets.RestApi.InvokeRestApi.DoProcessRecord"> <summary> Performs execution of the command </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> <value></value> </member> <member name="M:TfsCmdlets.Cmdlets.ServiceHook.GetServiceHookConsumer.DoProcessRecord"> <summary> Performs execution of the command </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="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="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="T:TfsCmdlets.Cmdlets.SetCmdletBase`1"> <summary> Abstract class from which and TfsCmdlets cmdlets derive </summary> </member> <member name="P:TfsCmdlets.Cmdlets.SetCmdletBase`1.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.SetCmdletBase`1.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="P:TfsCmdlets.Cmdlets.SetCmdletBase`1.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.SetCmdletBase`1.DoProcessRecord"> <summary> Performs execution of the command. </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="M:TfsCmdlets.Cmdlets.Shell.EnterShell.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Shell.ExitShell"> <summary> Deactivates the Azure DevOps Shell </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Shell.ExitShell.DoProcessRecord"> <summary> Performs execution of the command </summary> </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.Collection"> <summary> HELP_PARAM_COLLECTION </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="M:TfsCmdlets.Cmdlets.TeamProject.GetTeamProject.DoProcessRecord"> <summary> Performs execution of the command </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="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="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="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.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 $null to this argument. </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="M:TfsCmdlets.Cmdlets.TeamProject.UndoTeamProjectRemoval.DoProcessRecord"> <summary> Performs execution of the command </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="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="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="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.Board"> <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.Team"> <summary> HELP_PARAM_TEAM </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.Board.SetTeamBoardCardRule.DoProcessRecord"> <summary> Performs execution of the command </summary> </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.QueryMembership"> <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 the team's backlog settings (fills the Settings property with a Microsoft.TeamFoundation.Work.WebApi.TeamSetting object) </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.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="M:TfsCmdlets.Cmdlets.Team.GetTeam.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.TeamDataService.DoRemoveItem"> <summary> Performs execution of the command </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.TeamDataService.DoRenameItem"> <summary> Performs execution of the command </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.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.IterationPaths"> <summary> Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'. </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.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="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="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="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.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 paths that are associated with this team. Provide a list of area paths in the form '/path1/path2/[*]'. When the path ends with an asterisk, all child area path will be included recursively. Otherwise, only the area itself (without its children) will be included. </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.IterationPaths"> <summary> Specifies the backlog iteration paths that are associated with this team. Provide a list of iteration paths in the form '/path1/path2'. </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.SetTeam.DefaultIterationMacro"> <summary> Specifies the default iteration macro. When omitted, defaults to "@CurrentIteration". </summary> </member> <member name="F:TfsCmdlets.Cmdlets.Team.SetTeam.WorkingDays"> <summary> Specifies the team's Working Days. When omitted, defaults to Monday thru Friday </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.Default"> <summary> Sets the supplied team as the default team project team. </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.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.TeamAdmin.AddTeamAdmin.DoProcessRecord"> <summary> Performs execution of the command </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.Team"> <summary> HELP_PARAM_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.Project"> <summary> HELP_PARAM_PROJECT </summary> </member> <member name="P:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.TeamAdmin.GetTeamAdmin.DoProcessRecord"> <summary> Performs execution of the command </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="M:TfsCmdlets.Cmdlets.Team.TeamAdmin.RemoveTeamAdmin.DoProcessRecord"> <summary> Performs execution of the command </summary> </member> <member name="T:TfsCmdlets.Cmdlets.Team.TeamAdmin.TeamAdmin"> <summary> Represents a Team Adminstrator </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> Specifies the team to which the member is added. </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="M:TfsCmdlets.Cmdlets.Team.TeamMember.AddTeamMember.DoProcessRecord"> <summary> Performs execution of the command </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.Team"> <summary> Specifies the team from which to get its members. </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.Collection"> <summary> HELP_PARAM_COLLECTION </summary> </member> <member name="M:TfsCmdlets.Cmdlets.Team.TeamMember.GetTeamMember.DoProcessRecord"> <summary> Performs execution of the command </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> Specifies the team from which the member is removed. </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="M:TfsCmdlets.Cmdlets.Team.TeamMember.RemoveTeamMember.DoProcessRecord"> <summary> Performs execution of the command </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.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.Passthru"> <summary> HELP_PARAM_PASSTHRU </summary> </member> <member name="M:TfsCmdlets.Cmdlets.TestManagement.CopyTestPlan.DoProcessRecord"> <summary> Performs execution of the command </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> <value></value> </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="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="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="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="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.ProjectWiki"> <summary> Creates a provisioned ("project") Wiki in the specified Team Project. </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="T:TfsCmdlets.Cmdlets.ParameterDictionary"> <summary> Represents a collection of cmdlet arguments </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ParameterDictionary.#ctor"> <summary> Creates an empty dictionary </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ParameterDictionary.#ctor(System.Object)"> <summary> Creates a new dictionary, copying the properties of supplied object </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ParameterDictionary.#ctor(System.Object,System.Object)"> <summary> Creates a new dictionary, copying the properties of supplied object and merging it with another. </summary> <see cref="M:TfsCmdlets.Cmdlets.ParameterDictionary.Merge(TfsCmdlets.Cmdlets.ParameterDictionary)"/> </member> <member name="M:TfsCmdlets.Cmdlets.ParameterDictionary.Get``1(System.String,``0)"> <summary> Returns the value of a property. When the property is missing, returns an optionally supplied default value. </summary> </member> <member name="M:TfsCmdlets.Cmdlets.ParameterDictionary.Merge(TfsCmdlets.Cmdlets.ParameterDictionary)"> <summary> Merges this instance with another one. Only parameters present in the other collection that are also missing from this one are merged, i.e conflicting properties are skipped. </summary> </member> <member name="T:TfsCmdlets.Models.Connection"> <summary> Encapsulates the platform-specific connection object </summary> </member> <member name="M:TfsCmdlets.Models.Connection.op_Implicit(TfsCmdlets.Models.Connection)~Microsoft.TeamFoundation.Client.TfsConnection"> <summary> Converts a Connection object to a TfsConnection-derived object </summary> </member> <member name="M:TfsCmdlets.Models.Connection.op_Implicit(Microsoft.TeamFoundation.Client.TfsConnection)~TfsCmdlets.Models.Connection"> <summary> Converts a TfsConnection-derived object to a Connection object </summary> </member> <member name="M:TfsCmdlets.Models.Connection.GetClientFromType(System.Type)"> <summary> Gets a client of the given type </summary> </member> <member name="T:TfsCmdlets.Models.Identity"> <summary> Encapsulates the platform-specific identity object </summary> </member> <member name="T:TfsCmdlets.Models.BacklogLevelConfiguration"> <summary> Encapsulates the backlog level configuration object </summary> </member> <member name="T:TfsCmdlets.Models.Board"> <summary> Encapsulates the team board object </summary> </member> <member name="T:TfsCmdlets.Models.CardRule"> <summary> Azure Boards card rule </summary> </member> <member name="M:TfsCmdlets.Models.CardRule.#ctor(Microsoft.TeamFoundation.Work.WebApi.Rule,Microsoft.TeamFoundation.Work.WebApi.Board)"> <summary> Creates a new instance from the given object </summary> <param name="original">The original object to copy settings from</param> <param name="board">The board to apply this rule to</param> </member> <member name="P:TfsCmdlets.Models.CardRule.Board"> <summary> The board linked to this rule </summary> </member> <member name="P:TfsCmdlets.Models.CardRule.BoardName"> <summary> The name of the board linked to this rule </summary> </member> <member name="P:TfsCmdlets.Models.CardRule.RuleType"> <summary> The type of the rule </summary> </member> <member name="T:TfsCmdlets.Models.ClassificationNode"> <summary> Encapsulates the area/iteration node object </summary> </member> <member name="P:TfsCmdlets.Models.ClassificationNode.RelativePath"> <summary> Get a node's relative path </summary> </member> <member name="M:TfsCmdlets.Models.ClassificationNode.FixNodePath"> <summary> Fill a missing node path. Older versions of the REST API don't populate the Path property. </summary> </member> <member name="T:TfsCmdlets.Models.GlobalList"> <summary> Represents a Team Foundation Server global lists </summary> </member> <member name="M:TfsCmdlets.Models.GlobalList.op_Implicit(TfsCmdlets.Models.GlobalList)~System.Xml.Linq.XElement"> <summary> Converts a GlobalList to an XElement </summary> </member> <member name="M:TfsCmdlets.Models.GlobalList.op_Implicit(System.Xml.Linq.XElement)~TfsCmdlets.Models.GlobalList"> <summary> Converts an XElement to a GlobalList </summary> </member> <member name="M:TfsCmdlets.Models.GlobalList.#ctor"> <summary> Creates an empty instance of GlobalList </summary> </member> <member name="M:TfsCmdlets.Models.GlobalList.#ctor(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> Creates a new instance from the given name and items </summary> <param name="name">The name of the global list</param> <param name="items">The items (content) of the global list</param> </member> <member name="M:TfsCmdlets.Models.GlobalList.#ctor(System.Xml.Linq.XElement)"> <summary> Creates an instance of GlobalList from an XElement containing a <GLOBALLIST> element </summary> <param name="el">An XML element containing a global list definition</param> <returns>An instance of GlobalList</returns> </member> <member name="P:TfsCmdlets.Models.GlobalList.Name"> <summary> Gets the name of the global list. </summary> </member> <member name="P:TfsCmdlets.Models.GlobalList.Items"> <summary> Gets the contents (items) of the global list. </summary> </member> <member name="M:TfsCmdlets.Models.GlobalList.ToString"> <inheritdoc/> </member> <member name="M:TfsCmdlets.Models.GlobalList.ToXml"> <summary> Returns this global list in its original XML representation </summary> <returns>A XElement object representing a <GLOBALLIST> element</returns> </member> <member name="T:TfsCmdlets.Models.GlobalListCollection"> <summary> Represents a collection of global lists. </summary> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.op_Implicit(TfsCmdlets.Models.GlobalListCollection)~System.Xml.Linq.XDocument"> <summary> Converts a collection of global lists to a well-formed <gl:GLOBALLISTS> document </summary> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.op_Implicit(System.Xml.Linq.XDocument)~TfsCmdlets.Models.GlobalListCollection"> <summary> Converts a well-formed <gl:GLOBALLISTS> document to a collection of global lists </summary> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.#ctor"> <summary> Creates an empty collection </summary> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.#ctor(System.Collections.Generic.IEnumerable{TfsCmdlets.Models.GlobalList})"> <summary> Creates a collection and adds the given global lists to it </summary> <param name="items">Collection of global lists to add to this instance</param> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.#ctor(TfsCmdlets.Models.GlobalList)"> <summary> Creates a collection and adds the given global list to it </summary> <param name="item">A single global list to add to this instance</param> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.#ctor(System.String)"> <summary> Creates a collection from the given <gl:GLOBALLISTS> document </summary> <param name="xml">A well-formed <gl:GLOBALLISTS> document</param> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.#ctor(System.Xml.Linq.XDocument)"> <summary> Creates a collection from the given <gl:GLOBALLISTS> document </summary> <param name="doc">A well-formed <gl:GLOBALLISTS> document</param> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.ToString"> <summary> Returns the XML representation of the contents of this collection, in the form of a <gl:GLOBALLISTS> document </summary> </member> <member name="M:TfsCmdlets.Models.GlobalListCollection.ToXml"> <summary> Returns the XML representation of the contents of this collection, in the form of a <gl:GLOBALLISTS> document, as a XDocument object </summary> </member> <member name="T:TfsCmdlets.Models.Team"> <summary> Encapsulates a WebApiTeam object </summary> </member> <member name="M:TfsCmdlets.Models.Team.op_Implicit(TfsCmdlets.Models.Team)~Microsoft.TeamFoundation.Core.WebApi.WebApiTeam"> <summary> Converts to WebApiTeam </summary> </member> <member name="M:TfsCmdlets.Models.Team.op_Implicit(Microsoft.TeamFoundation.Core.WebApi.WebApiTeam)~TfsCmdlets.Models.Team"> <summary> Converts from WebApiTeam </summary> </member> <member name="M:TfsCmdlets.Services.BaseService.GetService``1"> <summary> Returns an instance of the specified service </summary> <typeparam name="T">The type of the requested service.static Must derive from IService</typeparam> <returns>An instance of T, as provided by the current service provider</returns> </member> <member name="T:TfsCmdlets.TfsComponent"> <summary> Indicates a TFS component </summary> </member> <member name="F:TfsCmdlets.TfsComponent.BaseInstallation"> <summary> The root folder of a TFS installation </summary> </member> <member name="F:TfsCmdlets.TfsComponent.ApplicationTier"> <summary> The "ApplicationTier" folder of a TFS installation </summary> </member> <member name="F:TfsCmdlets.TfsComponent.SharePointExtensions"> <summary> The "SharePointExtensions" folder of a TFS installation </summary> </member> <member name="F:TfsCmdlets.TfsComponent.TeamBuild"> <summary> The "TeamBuild" folder of a TFS installation </summary> </member> <member name="F:TfsCmdlets.TfsComponent.Tools"> <summary> The "Tools" folder of a TFS installation </summary> </member> <member name="F:TfsCmdlets.TfsComponent.VersionControlProxy"> <summary> The "VersionControlProxy" folder of a TFS installation </summary> </member> <member name="T:TfsCmdlets.ClientScope"> <summary> Client scope for Invoke-RestApi </summary> </member> <member name="F:TfsCmdlets.ClientScope.Server"> <summary> Server-level scope </summary> </member> <member name="F:TfsCmdlets.ClientScope.Collection"> <summary> Collection-level scope </summary> </member> <member name="T:TfsCmdlets.CardRuleType"> <summary> Board card rule </summary> </member> <member name="F:TfsCmdlets.CardRuleType.CardColor"> <summary> Card color rule type </summary> </member> <member name="F:TfsCmdlets.CardRuleType.TagColor"> <summary> Tag color rule type </summary> </member> <member name="F:TfsCmdlets.CardRuleType.All"> <summary> All card rules (card and tag color) </summary> </member> <member name="T:TfsCmdlets.RegistryScope"> <summary> TFS Registry scope </summary> </member> <member name="F:TfsCmdlets.RegistryScope.User"> <summary> User </summary> </member> <member name="F:TfsCmdlets.RegistryScope.Collection"> <summary> Collection </summary> </member> <member name="F:TfsCmdlets.RegistryScope.Server"> <summary> Server </summary> </member> <member name="T:TfsCmdlets.WorkItemLinkType"> <summary> Work Item Link Type </summary> </member> <member name="T:TfsCmdlets.Extensions.DocumentExtensions"> <summary> Linq to XML extension methods </summary> </member> <member name="M:TfsCmdlets.Extensions.DocumentExtensions.ToXmlDocument(System.Xml.Linq.XDocument)"> <summary> Converts a LINQ-based XDocument to a "legacy" XmlDocument </summary> <param name="xDocument">The document to be converted</param> <returns>The converted document</returns> </member> <member name="M:TfsCmdlets.Extensions.DocumentExtensions.ToXDocument(System.Xml.XmlDocument)"> <summary> Converts a "legacy" XmlDocument to a LINQ-based XDocument </summary> <param name="xmlDocument">The document to be converted</param> <returns>The converted document</returns> </member> <member name="T:TfsCmdlets.HttpClient.GenericHttpClient"> <summary> Generic HTTP Client, used by the Invoke-TfsRestApi cmdlet </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials)"> <summary> Creates a new instance of the GenericHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,Microsoft.VisualStudio.Services.Common.VssHttpRequestSettings)"> <summary> Creates a new instance of the GenericHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Creates a new instance of the GenericHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.#ctor(System.Uri,System.Net.Http.HttpMessageHandler,System.Boolean)"> <summary> Creates a new instance of the GenericHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,Microsoft.VisualStudio.Services.Common.VssHttpRequestSettings,System.Net.Http.DelegatingHandler[])"> <summary> Creates a new instance of the GenericHttpClient class </summary> </member> <member name="P:TfsCmdlets.HttpClient.GenericHttpClient.Uri"> <summary> Gets the API URL </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.UseHost(System.String)"> <summary> Specifies an alternate host name for APIs not hosted in "dev.azure.com" </summary> <param name="host">An alternate host, such as "vsaex.dev.azure.com" or "vssps.dev.azure.com".</param> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.Get``1(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Sends a GET request to an Azure DevOps API </summary> <typeparam name="T">The typed model (JSON proxy class) corresponding to the API result</typeparam> <param name="apiPath">The path to the API, relative to the collection/organization URL</param> <param name="apiVersion">The version of the requested API (e.g. "5.1")</param> <param name="additionalHeaders">Any additional HTTP headers that must be sent along the request</param> <param name="queryParameters">Any query parameters ("query string") that are part of the request</param> <param name="mediaType">The MIME content type of the response</param> <param name="userState">User-defined, arbitrary data sent as a "userstate" HTTP header</param> <returns>The response of the API, converted to the model type T</returns> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.Get(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Sends a GET request to an Azure DevOps API </summary> <param name="apiPath">The path to the API, relative to the collection/organization URL</param> <param name="apiVersion">The version of the requested API (e.g. "5.1")</param> <param name="additionalHeaders">Any additional HTTP headers that must be sent along the request</param> <param name="queryParameters">Any query parameters ("query string") that are part of the request</param> <param name="mediaType">The MIME content type of the response</param> <param name="userState">User-defined, arbitrary data sent as a "userstate" HTTP header</param> <returns>The response of the API as an HttpResponseMessage object</returns> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.Post``2(System.String,``0,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Sends a POST request to an Azure DevOps API </summary> <typeparam name="T">The typed model (JSON proxy class) corresponding to the API parameter (content) object</typeparam> <typeparam name="TResult">The typed model (JSON proxy class) corresponding to the API result</typeparam> <param name="apiPath">The path to the API, relative to the collection/organization URL</param> <param name="value">The API parameters sent as the request body</param> <param name="apiVersion">The version of the requested API (e.g. "5.1")</param> <param name="additionalHeaders">Any additional HTTP headers that must be sent along the request</param> <param name="queryParameters">Any query parameters ("query string") that are part of the request</param> <param name="mediaType">The MIME content type of the response</param> <param name="userState">User-defined, arbitrary data sent as a "userstate" HTTP header</param> <returns>The response of the API as an HttpResponseMessage object</returns> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.Post(System.String,System.Net.Http.HttpContent,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Sends a POST request to an Azure DevOps API </summary> <param name="apiPath">The path to the API, relative to the collection/organization URL</param> <param name="content">The API parameters sent as the request body</param> <param name="apiVersion">The version of the requested API (e.g. "5.1")</param> <param name="additionalHeaders">Any additional HTTP headers that must be sent along the request</param> <param name="queryParameters">Any query parameters ("query string") that are part of the request</param> <param name="mediaType">The MIME content type of the response</param> <param name="userState">User-defined, arbitrary data sent as a "userstate" HTTP header</param> <returns>The response of the API as an HttpResponseMessage object</returns> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.InvokeAsync(System.Net.Http.HttpMethod,System.String,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Invokes a REST API asynchronously </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.InvokeAsync``1(System.Net.Http.HttpMethod,System.String,System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Invokes a REST API asynchronously </summary> </member> <member name="M:TfsCmdlets.HttpClient.GenericHttpClient.PostForm``1(System.String,System.Collections.Generic.Dictionary{System.String,System.String},System.Boolean,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.Object)"> <summary> Invokes a REST API asynchronously </summary> </member> <member name="T:TfsCmdlets.HttpClient.TeamAdminHttpClient"> <summary> Custom HTTP Client to handle team administrator management </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.AddTeamAdmin(System.Guid,System.Guid,System.Guid)"> <summary> Adds an administrator to a team </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.AddTeamAdmin(System.String,System.Guid,System.Guid)"> <summary> Adds an administrator to a team </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.RemoveTeamAdmin(System.Guid,System.Guid,System.Guid)"> <summary> Removes an administrator from a team </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.RemoveTeamAdmin(System.String,System.Guid,System.Guid)"> <summary> Removes an administrator from a team </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials)"> <summary> Creates a new instance of the TeamAdminHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,Microsoft.VisualStudio.Services.Common.VssHttpRequestSettings)"> <summary> Creates a new instance of the TeamAdminHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Creates a new instance of the TeamAdminHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.#ctor(System.Uri,System.Net.Http.HttpMessageHandler,System.Boolean)"> <summary> Creates a new instance of the TeamAdminHttpClient class </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdminHttpClient.#ctor(System.Uri,Microsoft.VisualStudio.Services.Common.VssCredentials,Microsoft.VisualStudio.Services.Common.VssHttpRequestSettings,System.Net.Http.DelegatingHandler[])"> <summary> Creates a new instance of the TeamAdminHttpClient class </summary> </member> <member name="T:TfsCmdlets.HttpClient.TeamAdmins"> <summary> Represents a collection of team administrators </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmins.Admins"> <summary> Collection of team administrators </summary> </member> <member name="T:TfsCmdlets.HttpClient.TeamAdmin"> <summary> Represents a team administrator </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.IdentityType"> <summary> Identity Type </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.FriendlyDisplayName"> <summary> Friendly Display Name </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.DisplayName"> <summary> Display Name </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.SubHeader"> <summary> Sub-header </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.TeamFoundationId"> <summary> Team Foundation Id </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.EntityId"> <summary> Entity Id </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.Errors"> <summary> List of Errors </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.Warnings"> <summary> List of Warnings </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.Domain"> <summary> User Domain </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.AccountName"> <summary> User Account Name </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.IsWindowsUser"> <summary> Is Windows User </summary> </member> <member name="P:TfsCmdlets.HttpClient.TeamAdmin.MailAddress"> <summary> Email Address </summary> </member> <member name="M:TfsCmdlets.HttpClient.TeamAdmin.ToString"> <inheritdoc/> </member> <member name="T:TfsCmdlets.HttpClient.AddTeamAdminRequestData"> <summary> The request body to submit to the "Add Admin" service </summary> </member> <member name="P:TfsCmdlets.HttpClient.AddTeamAdminRequestData.Team"> <summary> TeamId </summary> </member> <member name="P:TfsCmdlets.HttpClient.AddTeamAdminRequestData.NewUsers"> <summary> List of New Users </summary> </member> <member name="P:TfsCmdlets.HttpClient.AddTeamAdminRequestData.ExistingUsers"> <summary> List of Existing Users </summary> </member> <member name="T:TfsCmdlets.HttpClient.RemoveTeamAdminResult"> <summary> The request body to submit to the "Remove Admin" service </summary> </member> <member name="P:TfsCmdlets.HttpClient.RemoveTeamAdminResult.Success"> <summary> Indicates the success of the operation </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:TfsCmdlets.Util.LazyProperty"> <summary> Supports the creation of lazy-loaded ScriptProperty properties </summary> </member> <member name="M:TfsCmdlets.Util.LazyProperty.Get(System.Management.Automation.PSObject,System.String,System.Management.Automation.ScriptBlock)"> <summary> Gets the value of the specified lazy-loaded property </summary> <param name="obj">The source PSObject that owns the property</param> <param name="property">The property name</param> <param name="sb">The scriptblock that is evaluated when the property needs to be loaded. It must return the value to be assigned to the property.</param> <returns>The value of the property</returns> </member> <member name="T:TfsCmdlets.Util.ServerVersion"> <summary> Represents the version of a Team Foundation / Azure DevOps Server installation, and/or the currently deployed version of Azure DevOps in an Azure DevOps Services organization </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.Version"> <summary> Gets the "four-part" version of TFS / Azure DevOps </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.LongVersion"> <summary> Gets the "long" version of TFS / Azure DevOps </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.FriendlyVersion"> <summary> Gets the "friendly" version of TFS / Azure DevOps </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.IsHosted"> <summary> Indicates whether it's a "hosted" (Azure DevOps Services) deployment or not (TFS/Azure DevOps Server) </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.Update"> <summary> Gets the version number of the Update installed on a server, or number of the sprint currently deployed in an Azure DevOps Services organization </summary> </member> <member name="P:TfsCmdlets.Util.ServerVersion.YearVersion"> <summary> Gets the version of the server as its corresponding year (e.g. 2019 for version 17.*) </summary> </member> </members> </doc> |