en-US/VSTeam-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeam</command:name> <command:verb>Add</command:verb> <command:noun>VSTeam</command:noun> <maml:description> <maml:para>Adds a team to a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a team to a team project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="TeamName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="TeamName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the team.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------- Example 1: Add a team --------------------</maml:title> <dev:code>Add-VSTeam -ProjectName Scrum -Name 'Testing'</dev:code> <dev:remarks> <maml:para>This command adds a team named 'Testing' to the project named 'Scrum'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 2: Add a team with description ------------</maml:title> <dev:code>Add-VSTeam 'Scrum' 'Testing2' 'Test team'</dev:code> <dev:remarks> <maml:para>This command adds a team named 'Testing2' with description 'Test team' to the project named 'Scrum'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Show-VSTeam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Show-VSTeam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeam</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamAccessControlEntry</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamAccessControlEntry</command:noun> <maml:description> <maml:para>Add or update ACEs in the ACL for the provided token. The request contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.</maml:para> <maml:para>Note: This is a low-level function. You should really use a high level function (Add-VSTeam Permission / Set-VSTeam Permission / Get-VSTeam*Permission) unless you know what you are doing.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add or update ACEs in the ACL for the provided token. The request contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.</maml:para> <maml:para>Note: This is a low-level function. You should really use a high level function (Add-VSTeam Permission / Set-VSTeam Permission / Get-VSTeam*Permission) unless you know what you are doing.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamAccessControlEntry</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the token to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AllowMask</maml:name> <maml:description> <maml:para>Bitmask for Allow Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DenyMask</maml:name> <maml:description> <maml:para>Bitmask for Deny Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamAccessControlEntry</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> <maml:para>Valid IDs are:</maml:para> <maml:para>AzD:</maml:para> <maml:para>- Analytics (58450c49-b02d-465a-ab12-59ae512d6531)</maml:para> <maml:para>- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba)</maml:para> <maml:para>- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd)</maml:para> <maml:para>- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de)</maml:para> <maml:para>- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866)</maml:para> <maml:para>- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f)</maml:para> <maml:para>- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba)</maml:para> <maml:para>- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680)</maml:para> <maml:para>- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87)</maml:para> <maml:para>- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e)</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f)</maml:para> <maml:para>- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23)</maml:para> <maml:para>- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c)</maml:para> <maml:para>- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046)</maml:para> <maml:para>- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18)</maml:para> <maml:para>- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7)</maml:para> <maml:para>- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb)</maml:para> <maml:para>- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8)</maml:para> <maml:para>- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02)</maml:para> <maml:para>- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4)</maml:para> <maml:para>- Library (b7e84409-6553-448a-bbb2-af228e07cbeb)</maml:para> <maml:para>- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20)</maml:para> <maml:para>- Project (52d39943-cb85-4d7f-8fa8-c6baac873819)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b)</maml:para> <maml:para>- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3)</maml:para> <maml:para>- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1)</maml:para> <maml:para>- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67)</maml:para> <maml:para>- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2)</maml:para> <maml:para>- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436)</maml:para> <maml:para>- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1)</maml:para> <maml:para>- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e)</maml:para> <maml:para>- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999)</maml:para> <maml:para>- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400)</maml:para> <maml:para>- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418)</maml:para> <maml:para>- BuildAdministration (302acaca-b667-436d-a946-87133492041c)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f)</maml:para> <maml:para>- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e)</maml:para> <maml:para>- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d)</maml:para> <maml:para>- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6)</maml:para> <maml:para>- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3)</maml:para> <maml:para>- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c)</maml:para> <maml:para>- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63)</maml:para> <maml:para>- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0)</maml:para> <maml:para>- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12)</maml:para> <maml:para>- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956)</maml:para> <maml:para>- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729)</maml:para> <maml:para>- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9)</maml:para> <maml:para>- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7)</maml:para> <maml:para>- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052)</maml:para> <maml:para> </maml:para> <maml:para>VSSPS:</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS)</maml:para> <maml:para>- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS)</maml:para> <maml:para>- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS)</maml:para> <maml:para>- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS)</maml:para> <maml:para>- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS)</maml:para> <maml:para>- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the token to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AllowMask</maml:name> <maml:description> <maml:para>Bitmask for Allow Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DenyMask</maml:name> <maml:description> <maml:para>Bitmask for Deny Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> <maml:para>Valid IDs are:</maml:para> <maml:para>AzD:</maml:para> <maml:para>- Analytics (58450c49-b02d-465a-ab12-59ae512d6531)</maml:para> <maml:para>- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba)</maml:para> <maml:para>- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd)</maml:para> <maml:para>- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de)</maml:para> <maml:para>- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866)</maml:para> <maml:para>- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f)</maml:para> <maml:para>- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba)</maml:para> <maml:para>- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680)</maml:para> <maml:para>- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87)</maml:para> <maml:para>- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e)</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f)</maml:para> <maml:para>- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23)</maml:para> <maml:para>- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c)</maml:para> <maml:para>- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046)</maml:para> <maml:para>- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18)</maml:para> <maml:para>- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7)</maml:para> <maml:para>- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb)</maml:para> <maml:para>- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8)</maml:para> <maml:para>- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02)</maml:para> <maml:para>- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4)</maml:para> <maml:para>- Library (b7e84409-6553-448a-bbb2-af228e07cbeb)</maml:para> <maml:para>- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20)</maml:para> <maml:para>- Project (52d39943-cb85-4d7f-8fa8-c6baac873819)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b)</maml:para> <maml:para>- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3)</maml:para> <maml:para>- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1)</maml:para> <maml:para>- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67)</maml:para> <maml:para>- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2)</maml:para> <maml:para>- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436)</maml:para> <maml:para>- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1)</maml:para> <maml:para>- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e)</maml:para> <maml:para>- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999)</maml:para> <maml:para>- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400)</maml:para> <maml:para>- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418)</maml:para> <maml:para>- BuildAdministration (302acaca-b667-436d-a946-87133492041c)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f)</maml:para> <maml:para>- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e)</maml:para> <maml:para>- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d)</maml:para> <maml:para>- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6)</maml:para> <maml:para>- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3)</maml:para> <maml:para>- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c)</maml:para> <maml:para>- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63)</maml:para> <maml:para>- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0)</maml:para> <maml:para>- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12)</maml:para> <maml:para>- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956)</maml:para> <maml:para>- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729)</maml:para> <maml:para>- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9)</maml:para> <maml:para>- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7)</maml:para> <maml:para>- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052)</maml:para> <maml:para> </maml:para> <maml:para>VSSPS:</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS)</maml:para> <maml:para>- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS)</maml:para> <maml:para>- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS)</maml:para> <maml:para>- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS)</maml:para> <maml:para>- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS)</maml:para> <maml:para>- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the token to be added.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AllowMask</maml:name> <maml:description> <maml:para>Bitmask for Allow Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DenyMask</maml:name> <maml:description> <maml:para>Bitmask for Deny Permissions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.AccessControlEntry</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a low-level function. You should really use a high level function (Add-VSTeam...Permission / Set-VSTeam...Permission / Get-VSTeam...Permission) unless you know what you are doing.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamAccessControlEntry -SecurityNamespaceId "2bf24a2b-70ba-43d3-ad97-3d9e1f75622f" -Token "MySecurityToken" -AllowMask 15 -DenyMask 2 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command adds an Access Control Entry (ACE) for the provided token in the project named "MyProject" using the specified security namespace identifier. The ACE has an allow mask of 15 and a deny mask of 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamAccessControlEntry -SecurityNamespace "vsteam_lib.SecurityNamespace" -Token "MySecurityToken" -AllowMask 7 -DenyMask 0 -OverwriteMask -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example adds an ACE using a `vsteam_lib.SecurityNamespace` object instead of a security namespace identifier. The allow mask is set to 7, and the deny mask is set to 0. The `-OverwriteMask` switch is used, which means the mask values will be overwritten rather than merged.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$aceParams = @{ SecurityNamespaceId = "2bf24a2b-70ba-43d3-ad97-3d9e1f75622f"; Token = "MySecurityToken"; AllowMask = 31; DenyMask = 8; ProjectName = "MyProject"; } Add-VSTeamAccessControlEntry @aceParams</dev:code> <dev:remarks> <maml:para>This example uses a hashtable to define the parameters for the `Add-VSTeamAccessControlEntry` cmdlet. The ACE is added with an allow mask of 31 and a deny mask of 8 for the provided token in the project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$namespace = Get-VSTeamSecurityNamespace -Name "VersionControlItems" Add-VSTeamAccessControlEntry -SecurityNamespace $namespace -Token "MyToken" -AllowMask 3 -DenyMask 1 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example first retrieves the security namespace object for "VersionControlItems" and then uses this object to add an ACE. The ACE is added with an allow mask of 3 and a deny mask of 1 for the token "MyToken" in the project "MyProject".</maml:para> <maml:para>Remember, managing permissions and access control entries in a DevOps environment is a crucial task, ensuring that users and services have the appropriate permissions for their roles and responsibilities. Always be careful when modifying permissions to avoid unintentionally giving or restricting access to critical resources.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamArea</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamArea</command:noun> <maml:description> <maml:para>Adds a new area to the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new area to the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamArea</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing area under where the new one will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing area under where the new one will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Add-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamArea -ProjectName Demo -Name "NewArea" -Path "MyArea/Path"</dev:code> <dev:remarks> <maml:para>This command adds a new area named NewArea to the Demo project under the area path MyArea/Path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamArea -ProjectName Demo -Name "NewArea"</dev:code> <dev:remarks> <maml:para>This command adds a new area named NewArea to the Demo project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamArea "NewArea"</dev:code> <dev:remarks> <maml:para>This command adds a new area named NewArea to the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamAzureRMServiceEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamAzureRMServiceEndpoint</command:noun> <maml:description> <maml:para>Adds a new Azure Resource Manager service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new connection between TFS/AzD and Azure using the Azure Resource Manager connection type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamAzureRMServiceEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="displayName"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the Azure Subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The id of the Azure subscription to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="none"> <maml:name>SubscriptionTenantId</maml:name> <maml:description> <maml:para>The id of the Azure tenant to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The ID of the Azure Service Principal to use with this service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ServicePrincipalKey</maml:name> <maml:description> <maml:para>The key of the Azure Service Principal to use with this service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="displayName"> <maml:name>SubscriptionName</maml:name> <maml:description> <maml:para>The name of the Azure Subscription.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The id of the Azure subscription to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="none"> <maml:name>SubscriptionTenantId</maml:name> <maml:description> <maml:para>The id of the Azure tenant to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ServicePrincipalId</maml:name> <maml:description> <maml:para>The ID of the Azure Service Principal to use with this service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ServicePrincipalKey</maml:name> <maml:description> <maml:para>The key of the Azure Service Principal to use with this service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="4" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the service endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamAzureRMServiceEndpoint -SubscriptionName "MyAzureSubscription" -SubscriptionId "1234abcd-5678-efgh-9012-ijklmn345678" -SubscriptionTenantId "abcd1234-efgh-5678-ijkl-9012mn345678" -ServicePrincipalId "efgh1234-5678-abcd-9012-ijklmn345678" -ServicePrincipalKey "my-service-principal-key" -EndpointName "MyAzureEndpoint" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command adds a new Azure Resource Manager service endpoint in the project named "MyProject" using the provided Azure subscription name, subscription ID, tenant ID, service principal ID, and service principal key. The service endpoint will be named "MyAzureEndpoint".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$params = @{ SubscriptionName = "MyAzureSubscription"; SubscriptionId = "1234abcd-5678-efgh-9012-ijklmn345678"; SubscriptionTenantId = "abcd1234-efgh-5678-ijkl-9012mn345678"; ServicePrincipalId = "efgh1234-5678-abcd-9012-ijklmn345678"; ServicePrincipalKey = "my-service-principal-key"; EndpointName = "MyAzureEndpoint"; ProjectName = "MyProject"; } Add-VSTeamAzureRMServiceEndpoint @params</dev:code> <dev:remarks> <maml:para>This example does the same as the previous one but uses a hashtable to define the parameters for the `Add-VSTeamAzureRMServiceEndpoint` cmdlet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$endpoint = @{ SubscriptionName = "MyAzureSubscription"; SubscriptionId = "1234abcd-5678-efgh-9012-ijklmn345678"; SubscriptionTenantId = "abcd1234-efgh-5678-ijkl-9012mn345678"; ServicePrincipalId = "efgh1234-5678-abcd-9012-ijklmn345678"; ServicePrincipalKey = "my-service-principal-key"; } Add-VSTeamAzureRMServiceEndpoint @endpoint -EndpointName "MyAzureEndpoint" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example demonstrates how you can separate the Azure-related parameters and the Azure DevOps-related parameters. The Azure parameters are stored in the `$endpoint` hashtable, and the Azure DevOps parameters are provided directly to the cmdlet.</maml:para> <maml:para>Remember that when working with Azure, Service Principals are a way to give applications permissions in Azure Active Directory. This allows those applications to manage resources in Azure. The Service Principal ID and Key are used to authenticate and authorize the application. Always handle the Service Principal Key with care as it is a sensitive piece of information.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamBanner</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamBanner</command:noun> <maml:description> <maml:para>Adds a new banner message to an Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new banner message to an Azure DevOps organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamBanner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of the banner message. The acceptable values for this parameter are:</maml:para> <maml:para>- info</maml:para> <maml:para>- warning</maml:para> <maml:para>- error</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message content to be displayed on the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The expiration date of the banner in the format `yyyy-mm-ddThh:mm`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of the banner message. The acceptable values for this parameter are:</maml:para> <maml:para>- info</maml:para> <maml:para>- warning</maml:para> <maml:para>- error</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message content to be displayed on the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The expiration date of the banner in the format `yyyy-mm-ddThh:mm`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamBanner -Level info -Message 'Test Message' -ExpirationDate '2024-01-01T04:00' -Id '9547ed55-66e1-403d-95aa-9e628726861c'</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBanner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamBanner</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamBuild</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Queues a new build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add-VSTeamBuild will queue a new build.</maml:para> <maml:para>You can override the queue in the build definition by using the QueueName parameter. You can override the default source branch by using the SourceBranch parameter. You can also set specific build parameters by using the BuildParameters parameter.</maml:para> <maml:para>To have the BuildDefinition and QueueNames tab complete you must set a default project by calling Set-VSTeamDefaultProject before you call Add-VSTeamBuild.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinition"> <maml:name>BuildDefinitionName</maml:name> <maml:description> <maml:para>The name of the build definition to use to queue to build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to use for this build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>Which source branch to use for this build. Overrides default branch in build definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildParameters</maml:name> <maml:description> <maml:para>A hashtable with build parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collection.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collection.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to use for this build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>BuildDefinitionId</maml:name> <maml:description> <maml:para>The Id of the build definition to use to queue to build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>Which source branch to use for this build. Overrides default branch in build definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildParameters</maml:name> <maml:description> <maml:para>A hashtable with build parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collection.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collection.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinition"> <maml:name>BuildDefinitionName</maml:name> <maml:description> <maml:para>The name of the build definition to use to queue to build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>The name of the queue to use for this build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>BuildDefinitionId</maml:name> <maml:description> <maml:para>The Id of the build definition to use to queue to build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>Which source branch to use for this build. Overrides default branch in build definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TemplateParameters</maml:name> <maml:description> <maml:para>Allows the user to pass in dynamic values to the build pipeline when queuing a new build, potentially influencing how the build runs based on the values of these parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildParameters</maml:name> <maml:description> <maml:para>A hashtable with build parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Collection.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collection.Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> <maml:para>BuildDefinitionName</maml:para> <maml:para>QueueName</maml:para> <maml:para>SourceBranch</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>BuildDefinitionId</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> <maml:description> <maml:para>Build Parameters</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Build</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>BuildDefinition and QueueName are dynamic parameters and use the default project value to query their validate set.</maml:para> <maml:para>If you do not set the default project by called Set-VSTeamDefaultProject you must pass in -ProjectName or you will have to type in the names.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Add-VSTeamBuild -BuildDefinition Demo-CI Build Definition Build Number Status Result ---------------- ------------ ------ ------ Demo-CI Demo-CI-45 notStarted</dev:code> <dev:remarks> <maml:para>This example sets the default project so you can tab complete the BuildDefinition parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Add-VSTeamBuild -BuildDefinition Demo-CI -SourceBranch refs/heads/develop Build Definition Build Number Status Result ---------------- ------------ ------ ------ Demo-CI Demo-CI-45 notStarted</dev:code> <dev:remarks> <maml:para>This example queues the build for the 'develop' branch, overriding the default branch in the build definition.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Add-VSTeamBuild -BuildDefinition Demo-CI -BuildParameters @{msg="hello world!"; 'system.debug'='true'} Build Definition Build Number Status Result ---------------- ------------ ------ ------ Demo-CI Demo-CI-45 notStarted</dev:code> <dev:remarks> <maml:para>This example queues the build and sets the system.debug variable to true and msg to 'hello world!'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamBuildDefinition</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamBuildDefinition</command:noun> <maml:description> <maml:para>Creates a new build definition from a JSON file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads a JSON file off disk and uses that file to create a new build definition in the provided project.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be created. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be created. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamBuildDefinition -ProjectName Demo -InFile build.json</dev:code> <dev:remarks> <maml:para>This command reads build.json and creates a new build definition from it on the demo team project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamBuildPermission</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamBuildPermission</command:noun> <maml:description> <maml:para>Add Permissions to builds and multi staging pipelines</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add Permissions to builds and multi staging pipelines</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamBuildPermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildID</maml:name> <maml:description> <maml:para>The build ID of the build pipeline to permit the identity object to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the user or group to permit to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user or service account to permit to. Service accounts are handled like normal users. The descriptor differs a little bit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to permit to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Permissions that should be allowed. If no permissions are needed, then leave this parameter out.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Permissions that should be denied. If no permissions are needed, then leave this parameter out.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProjectID</maml:name> <maml:description> <maml:para>ID of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildID</maml:name> <maml:description> <maml:para>The build ID of the build pipeline to permit the identity object to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the user or group to permit to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user or service account to permit to. Service accounts are handled like normal users. The descriptor differs a little bit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The group to permit to</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Permissions that should be allowed. If no permissions are needed, then leave this parameter out.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Permissions that should be denied. If no permissions are needed, then leave this parameter out.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$project = Get-VSTeamProject -Name MyProject $user = Get-VSTeamUser -Descriptor "Microsoft.IdentityModel.Claims.ClaimsIdentity;788df857-dcd8-444d-885e-bff359bc1982\\test@testuser.com" Add-VSTeamBuildPermission -Project $project -User $user -Allow DestroyBuilds, DeleteBuildDefinition, AdministerBuildPermissions -Deny StopBuilds, QueueBuilds, EditBuildDefinition</dev:code> <dev:remarks> <maml:para>Adds the user 'test@testuser.com' with the given descriptor to the build pipelines on project level. Permits the user to destroy builds, delete build definitions and administer them. Also denies to stop or queue builds as well as editing build definitions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$project = Get-VSTeamProject -Name MyProject $user = Get-VSTeamUser -Descriptor "Microsoft.IdentityModel.Claims.ClaimsIdentity;788df857-dcd8-444d-885e-bff359bc1982\\test@testuser.com" Add-VSTeamBuildPermission -Project $project -User $user Warning: Permission masks for Allow and Deny do not inlude any permission. No Permission will change!</dev:code> <dev:remarks> <maml:para>Tries to the user 'test@testuser.com' with the given descriptor to the build pipelines on project level. No permissions (allow and deny) are given, it is possible but a warning is thrown.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$project = Get-VSTeamProject -Name MyProject $user = Get-VSTeamUser -Descriptor "Microsoft.IdentityModel.Claims.ClaimsIdentity;788df857-dcd8-444d-885e-bff359bc1982\\test@testuser.com" Add-VSTeamBuildPermission -Project $project -BuildID 5 -User $user -Allow DestroyBuilds -Deny StopBuilds</dev:code> <dev:remarks> <maml:para>Allows the user 'test@testuser.com' to the build with ID 5 to destry builds and deny to stop builds.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamBuildTag</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamBuildTag</command:noun> <maml:description> <maml:para>Adds a tag to a build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a tag to a build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamBuildTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>One or more tags. To specify multiple, use commas to separate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>One or more tags. To specify multiple, use commas to separate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamBuildTag -Id 12345 -Tags "QA_Passed" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command adds the tag "QA_Passed" to the build with ID 12345 in the project named "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$builds = Get-VSTeamBuild -ProjectName "MyProject" -Result Succeeded $builds | Add-VSTeamBuildTag -Tags "ProductionReady"</dev:code> <dev:remarks> <maml:para>This example first retrieves all builds in the "MyProject" project that have succeeded. It then adds the tag "ProductionReady" to each of these builds.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamBuildTag -Id 67890,12345 -Tags "Reviewed,ReadyForDeploy" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command adds the tags "Reviewed" and "ReadyForDeploy" to the builds with IDs 67890 and 12345 in the project named "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$tags = "Version2.0", "ReleaseCandidate" Add-VSTeamBuildTag -Id 98765 -Tags $tags -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example adds the tags "Version2.0" and "ReleaseCandidate" to the build with ID 98765 in the project named "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamBuildTag -Id 11223 -Tags "RegressionTested" -ProjectName "MyProject" -Confirm</dev:code> <dev:remarks> <maml:para>This command adds the tag "RegressionTested" to the build with ID 11223 in the project named "MyProject". It will prompt for confirmation before adding the tag.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>$buildId = 44556 $myTags = "UI_Passed", "Backend_Tested" Add-VSTeamBuildTag -Id $buildId -Tags $myTags -ProjectName "MyProject" -Force</dev:code> <dev:remarks> <maml:para>This example adds the tags "UI_Passed" and "Backend_Tested" to the build with ID 44556 in the project named "MyProject". The `-Force` parameter ensures the tags are added without any confirmation prompt.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamClassificationNode</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamClassificationNode</command:noun> <maml:description> <maml:para>Adds either a new iteration or area to the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds either a new iteration or area to the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamClassificationNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">iterations</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">areas</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is the base function for Add-VSTeamArea and Add-VSTeamIteration.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamClassificationNode -ProjectName Demo -Name "NewIteration" -StructureGroup "iterations" -Path "MyIteration/Path"</dev:code> <dev:remarks> <maml:para>This command adds a new iteration named NewIteration to the Demo project under the iteration path MyIteration/Path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamClassificationNode -ProjectName "Demo" -FinishDate (Get-Date "31.01.2020") -StartDate (Get-Date "01.01.2020") -Name "NewIteration" -StructureGroup "iterations"</dev:code> <dev:remarks> <maml:para>This command adds a new iteration named NewIteration to the Demo project with the start date 01.01.2020 and finish date 31.01.2020.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamExtension</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamExtension</command:noun> <maml:description> <maml:para>Install the specified extension into the account / project collection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Install the specified extension into the account / project collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the extension. Example: "0.1.35".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the extension. Example: "0.1.35".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamExtension -PublisherId "MyPublisher" -ExtensionId "MyExtension"</dev:code> <dev:remarks> <maml:para>This command installs the specified extension "MyExtension" from the publisher "MyPublisher" into the account/project collection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamExtension -PublisherId "AnotherPublisher" -ExtensionId "AnotherExtension" -Version "1.2.3"</dev:code> <dev:remarks> <maml:para>This command installs version "1.2.3" of the extension "AnotherExtension" from the publisher "AnotherPublisher" into the account/project collection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$myExtensionDetails = @{ PublisherId = "SamplePublisher"; ExtensionId = "SampleExtension"; Version = "2.0.0"; } Add-VSTeamExtension @myExtensionDetails</dev:code> <dev:remarks> <maml:para>This example uses a hashtable to specify the details of the extension and installs version "2.0.0" of the extension "SampleExtension" from the publisher "SamplePublisher" into the account/project collection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$extensions = Import-Csv -Path "C:\path\to\extensions.csv" foreach ($ext in $extensions) { Add-VSTeamExtension -PublisherId $ext.PublisherId -ExtensionId $ext.ExtensionId -Version $ext.Version }</dev:code> <dev:remarks> <maml:para>This example reads a CSV file containing a list of extensions with their PublisherId, ExtensionId, and Version, and installs each extension into the account/project collection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamExtension -PublisherId "DevOpsTools" -ExtensionId "CI_CD_Tool"</dev:code> <dev:remarks> <maml:para>This command installs the specified extension "CI_CD_Tool" from the publisher "DevOpsTools" into the account/project collection. If there are multiple versions available, the latest version will be installed by default.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamExtension</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamFeed</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamFeed</command:noun> <maml:description> <maml:para>Adds a new feed to package management.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new feed to package management.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamFeed</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the feed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the feed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnableUpstreamSources</maml:name> <maml:description> <maml:para>Enables npm and nuget upstream sources for the feed</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>showDeletedPackageVersions</maml:name> <maml:description> <maml:para>The feed will show deleted version in the feed</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the feed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the feed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnableUpstreamSources</maml:name> <maml:description> <maml:para>Enables npm and nuget upstream sources for the feed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>showDeletedPackageVersions</maml:name> <maml:description> <maml:para>The feed will show deleted version in the feed</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamFeed -Name test -Description 'Test Description'</dev:code> <dev:remarks> <maml:para>This command adds a new package feed to the account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamFeed -Name test -Description 'Test Description' -ProjectName 'MyProject'</dev:code> <dev:remarks> <maml:para>This command adds a new package feed to the project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamGitRepository</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamGitRepository</command:noun> <maml:description> <maml:para>Adds a Git repository to your Azure DevOps or Team Foundation Server account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add-VSTeamGitRepository adds a Git repository to your Azure DevOps or Team Foundation Server account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamGitRepository</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamGitRepository -ProjectName Demo -Name Temp</dev:code> <dev:remarks> <maml:para>This command adds a new repository named Temp to the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamGitRepositoryPermission</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamGitRepositoryPermission</command:noun> <maml:description> <maml:para>Add permissions to a git repository, all repositories in a project, or a specific branch</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add permissions to a git repository, all repositories in a project, or a specific branch</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamGitRepositoryPermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>ID of the repository for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryName</maml:name> <maml:description> <maml:para>Name of the repository for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BranchName</maml:name> <maml:description> <maml:para>Name of the branch for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGitRepositoryPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamGitRepositoryPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGitRepositoryPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamGitRepositoryPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>ID of the repository for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryName</maml:name> <maml:description> <maml:para>Name of the repository for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BranchName</maml:name> <maml:description> <maml:para>Name of the branch for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGitRepositoryPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamGitRepositoryPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGitRepositoryPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamGitRepositoryPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$descriptorUser = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMA" $descriptorGroup = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMQ" Add-VSTeamGitRepositoryPermission -RepositoryId "1a2b3c4d" -RepositoryName "MyRepo" -BranchName "main" -Descriptor $descriptorUser -User $descriptorUser -Group $descriptorGroup -Allow "Read,Contribute" -Deny "Delete" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command adds read and contribute permissions to the "main" branch of the "MyRepo" repository for the specified user and group while denying the delete permission. The user and group are specified using their respective descriptors.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$descriptorUser = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMA" Add-VSTeamGitRepositoryPermission -RepositoryId "2b3c4d5e" -RepositoryName "AnotherRepo" -BranchName "dev" -Descriptor $descriptorUser -User $descriptorUser -Allow "Read" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>Here, read permission is granted to the "dev" branch of the "AnotherRepo" repository for the specified user using the user descriptor.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$descriptorGroup = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMQ" Add-VSTeamGitRepositoryPermission -RepositoryId "3c4d5e6f" -RepositoryName "ThirdRepo" -BranchName "feature" -Descriptor $descriptorGroup -Group $descriptorGroup -Allow "Read,Contribute,Manage" -ProjectName "DataAnalytics"</dev:code> <dev:remarks> <maml:para>In this example, read, contribute, and manage permissions are granted to the "feature" branch of the "ThirdRepo" repository for the specified group using the group descriptor.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$descriptorUser = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMA" Add-VSTeamGitRepositoryPermission -RepositoryId "4d5e6f7g" -RepositoryName "FourthRepo" -BranchName "hotfix" -Descriptor $descriptorUser -User $descriptorUser -Allow "Read" -Deny "Contribute,Delete" -ProjectName "MobileApp"</dev:code> <dev:remarks> <maml:para>This command grants read permission and denies contribute and delete permissions to the "hotfix" branch of the "FourthRepo" repository for the specified user using the user descriptor.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$descriptorGroup = "vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzM4Mzc4Njg5LTE5MzM0NTM5NjYtMzQ3NzU4NjI4OS0yNTA2ODc2NTA5LTAuMQ" Add-VSTeamGitRepositoryPermission -RepositoryId "5e6f7g8h" -RepositoryName "FifthRepo" -BranchName "release" -Descriptor $descriptorGroup -Group $descriptorGroup -Allow "Read,Contribute" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>This example grants read and contribute permissions to the "release" branch of the "FifthRepo" repository for the specified group using the group descriptor.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamIteration</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamIteration</command:noun> <maml:description> <maml:para>Adds a new iteration to the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new iteration to the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamIteration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing iteration under where the new one will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the new iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing iteration under where the new one will be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Add-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamIteration -ProjectName Demo -Name "NewIteration" -Path "MyIteration/Path"</dev:code> <dev:remarks> <maml:para>This command adds a new iteration named NewIteration to the Demo project under the iteration path MyIteration/Path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamIteration -ProjectName "Demo" -FinishDate "31.01.2020" -StartDate "01.01.2020" -Name "NewIteration"</dev:code> <dev:remarks> <maml:para>This command adds a new iteration named NewIteration to the Demo project with the start date 01.01.2020 and finish date 31.01.2020.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamClassificationNode</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamKubernetesEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamKubernetesEndpoint</command:noun> <maml:description> <maml:para>Adds connections to Kubernetes clusters</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new connection between TFS/AzD and a Kubernetes cluster using kubeconfig json.</maml:para> <maml:para>This is only used when using the Kubernetes tasks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamKubernetesEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Kubeconfig</maml:name> <maml:description> <maml:para>kubeconfig as JSON string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>KubernetesUrl</maml:name> <maml:description> <maml:para>URL of Kubernetes cluster</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ClientCertificateData</maml:name> <maml:description> <maml:para>Client certificate from Kubeconfig</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ClientKeyData</maml:name> <maml:description> <maml:para>Client private key from Kubeconfig</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AcceptUntrustedCerts</maml:name> <maml:description> <maml:para>Accept untrusted certificates for cluster</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>GeneratePfx</maml:name> <maml:description> <maml:para>Generate pfx file</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Kubeconfig</maml:name> <maml:description> <maml:para>kubeconfig as JSON string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>KubernetesUrl</maml:name> <maml:description> <maml:para>URL of Kubernetes cluster</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ClientCertificateData</maml:name> <maml:description> <maml:para>Client certificate from Kubeconfig</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ClientKeyData</maml:name> <maml:description> <maml:para>Client private key from Kubeconfig</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AcceptUntrustedCerts</maml:name> <maml:description> <maml:para>Accept untrusted certificates for cluster</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>GeneratePfx</maml:name> <maml:description> <maml:para>Generate pfx file</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$kubeconfig = Get-Content -Path "C:\path\to\kubeconfig.json" -Raw Add-VSTeamKubernetesEndpoint -Kubeconfig $kubeconfig -KubernetesUrl "https://k8s-cluster.example.com:6443" -EndpointName "MyK8sCluster" -ClientCertificateData "CERTIFICATE_DATA" -ClientKeyData "KEY_DATA" -AcceptUntrustedCerts -GeneratePfx -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command creates a new connection to a Kubernetes cluster using the provided kubeconfig file and details. The connection is named "MyK8sCluster" and is associated with the "WebAppProject". It accepts untrusted certificates and generates a pfx file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$kubeconfig = Get-Content -Path "C:\path\to\another\kubeconfig.json" -Raw Add-VSTeamKubernetesEndpoint -Kubeconfig $kubeconfig -KubernetesUrl "https://another-k8s-cluster.example.org:6443" -EndpointName "AnotherK8sCluster" -ClientCertificateData "ANOTHER_CERTIFICATE_DATA" -ClientKeyData "ANOTHER_KEY_DATA" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>Here, a new Kubernetes connection named "AnotherK8sCluster" is created for the "BackendServices" project using the provided kubeconfig file and details.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$kubeconfig = Get-Content -Path "C:\path\to\third\kubeconfig.json" -Raw Add-VSTeamKubernetesEndpoint -Kubeconfig $kubeconfig -KubernetesUrl "https://third-k8s-cluster.example.net:6443" -EndpointName "ThirdK8sCluster" -ClientCertificateData "THIRD_CERTIFICATE_DATA" -ClientKeyData "THIRD_KEY_DATA" -GeneratePfx -ProjectName "DataAnalytics"</dev:code> <dev:remarks> <maml:para>In this example, a connection to a third Kubernetes cluster is created with the name "ThirdK8sCluster" for the "DataAnalytics" project. It uses the provided kubeconfig file and details and generates a pfx file.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$kubeconfig = Get-Content -Path "C:\path\to\fourth\kubeconfig.yaml" -Raw Add-VSTeamKubernetesEndpoint -Kubeconfig $kubeconfig -KubernetesUrl "https://fourth-k8s-cluster.example.io:6443" -EndpointName "FourthK8sCluster" -ClientCertificateData "FOURTH_CERTIFICATE_DATA" -ClientKeyData "FOURTH_KEY_DATA" -AcceptUntrustedCerts -ProjectName "MobileApp"</dev:code> <dev:remarks> <maml:para>This command creates a new Kubernetes connection named "FourthK8sCluster" for the "MobileApp" project. It uses the provided kubeconfig file, details, and accepts untrusted certificates.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$kubeconfig = Get-Content -Path "C:\path\to\fifth\kubeconfig.yaml" -Raw Add-VSTeamKubernetesEndpoint -Kubeconfig $kubeconfig -KubernetesUrl "https://fifth-k8s-cluster.example.co:6443" -EndpointName "FifthK8sCluster" -ClientCertificateData "FIFTH_CERTIFICATE_DATA" -ClientKeyData "FIFTH_KEY_DATA" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>This example demonstrates the creation of a new Kubernetes connection named "FifthK8sCluster" for the "FrontendUI" project using the provided kubeconfig file and details.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamMembership</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamMembership</command:noun> <maml:description> <maml:para>Adds a membership to a container.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a membership to a container.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$user = Get-VSTeamUser | ? DisplayName -eq 'Test User' $group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators' Add-VSTeamMembership -MemberDescriptor $user.Descriptor -ContainerDescriptor $group.Descriptor</dev:code> <dev:remarks> <maml:para>Adds Test User to the Endpoint Administrators group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VsTeamUser</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Test-VsTeamMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamNuGetEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamNuGetEndpoint</command:noun> <maml:description> <maml:para>Adds a new NuGet service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new connection between TFS/AzD and a NuGet server using the NuGet connection type.</maml:para> <maml:para>This is only used when using the NuGet tasks.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamNuGetEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Authentication Token generated by NuGet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamNuGetEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>Authentication ApiKey generated by NuGet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamNuGetEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePassword</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to use with basic authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamNuGetEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecureApiKey</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> <maml:para>This will allow you to provide your information without displaying it in plain text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamNuGetEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> <maml:para>You must provide on the command line. You will not be prompted for this value.</maml:para> <maml:para>You can use $p = Read-Host -AsSecureString to capture to pass in as parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>NuGetUrl</maml:name> <maml:description> <maml:para>URL of the NuGet server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Authentication Token generated by NuGet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>Authentication ApiKey generated by NuGet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Username</maml:name> <maml:description> <maml:para>Username to use with basic authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecureApiKey</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> <maml:para>This will allow you to provide your information without displaying it in plain text.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> <maml:para>You must provide on the command line. You will not be prompted for this value.</maml:para> <maml:para>You can use $p = Read-Host -AsSecureString to capture to pass in as parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePassword</maml:name> <maml:description> <maml:para>A secured string to capture your sensitive information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$apikey = Read-Host -Prompt 'ApiKey' -AsSecureString ApiKey: ************************************ Add-NuGetEndpoint -EndpointName 'PowerShell Gallery' -NuGetUrl 'https://www.powershellgallery.com/api/v2/package' -SecureApiKey $apikey</dev:code> <dev:remarks> <maml:para>This will add a project name MyProject with no description using the Scrum process template and Git source control.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamPolicy</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamPolicy</command:noun> <maml:description> <maml:para>Adds a new policy to the specified project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new policy to the specified project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>Specifies the id of the type of policy to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Enables the policy</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>blocking</maml:name> <maml:description> <maml:para>Determines if the policy will block pushes to the branch if the policy is not adhered to.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>settings</maml:name> <maml:description> <maml:para>The settings for the policy.</maml:para> <maml:para>Each policy type has it's own settings that will need to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>Specifies the id of the type of policy to be created.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Enables the policy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>blocking</maml:name> <maml:description> <maml:para>Determines if the policy will block pushes to the branch if the policy is not adhered to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>settings</maml:name> <maml:description> <maml:para>The settings for the policy.</maml:para> <maml:para>Each policy type has it's own settings that will need to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamPolicy -ProjectName Demo -type 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 -enabled -blocking -settings @{MinimumApproverCount = 1;Scope=@(@{repositoryId=b87c5af8-1a82-4e59-9a86-13d5cbc4a8d5; matchKind="Exact"; refName="refs/heads/trunk"})}</dev:code> <dev:remarks> <maml:para>This command adds a new policy to the Demo project's repository specified. The policy added requires a minimum number of reviewers and applies to the trunk branch. Specifying `-blocking` will block pushes to trunk directly.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicyType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicyType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamPool</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamPool</command:noun> <maml:description> <maml:para>Adds a new agent pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a new agent pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoProvision</maml:name> <maml:description> <maml:para>Auto-provision this agent pool in new projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoAuthorize</maml:name> <maml:description> <maml:para>Grant access permission to all pipelines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoAutoUpdates</maml:name> <maml:description> <maml:para>Turn off automatic updates of agents in the pool. Default is turned on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the pool to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoProvision</maml:name> <maml:description> <maml:para>Auto-provision this agent pool in new projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoAuthorize</maml:name> <maml:description> <maml:para>Grant access permission to all pipelines.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoAutoUpdates</maml:name> <maml:description> <maml:para>Turn off automatic updates of agents in the pool. Default is turned on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamPool -Name "TestPool" -Description "Test Description" -AutoProvision -AutoAuthorize -NoAutoUpdates</dev:code> <dev:remarks> <maml:para>It's creating an agent pool with the name "TestPool" that is auto provisioning to every project and also pre-authorized to be used with every pipeline. Agent software is not updated automatically.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPool</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamProfile</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamProfile</command:noun> <maml:description> <maml:para>Stores your account name and personal access token as a profile for use with the Add-TeamAccount function in this module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile. If this parameter is not provided the account will also serve as the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Add-VSTeamProfile command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile. If this parameter is not provided the account will also serve as the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile. If this parameter is not provided the account will also serve as the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseWindowsAuthentication</maml:name> <maml:description> <maml:para>Allows the use of the current user's Windows credentials to authenticate against a local TFS.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Add-VSTeamProfile command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseWindowsAuthentication</maml:name> <maml:description> <maml:para>Allows the use of the current user's Windows credentials to authenticate against a local TFS.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile. If this parameter is not provided the account will also serve as the name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamProfile</dev:code> <dev:remarks> <maml:para>You will be prompted for the account name and personal access token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamProfile -Account mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga -Version TFS2018</dev:code> <dev:remarks> <maml:para>Allows you to provide all the information on the command line.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamProfile -Account http://localtfs:8080/tfs/DefaultCollection -UseWindowsAuthentication</dev:code> <dev:remarks> <maml:para>On Windows, allows you use to use Windows authentication against a local TFS server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamProject</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamProject</command:noun> <maml:description> <maml:para>Adds a Team Project to your account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This will create a new Team Project in your Team Foundation Server or Team Services account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>The name of the process template to use for the project.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Scrum</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the team project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TFVC</maml:name> <maml:description> <maml:para>Switches the source control from Git to TFVC.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>The visibility of the project.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">private</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">public</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProcessTemplate</maml:name> <maml:description> <maml:para>The name of the process template to use for the project.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Scrum</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the team project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TFVC</maml:name> <maml:description> <maml:para>Switches the source control from Git to TFVC.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>The visibility of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamProject 'MyProject'</dev:code> <dev:remarks> <maml:para>This will add a project name MyProject with no description using the Scrum process template and Git source control.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamProject 'MyProject' -TFVC -ProcessTemplate Agile</dev:code> <dev:remarks> <maml:para>This will add a project name MyProject with no description using the Agile process template and TFVC source control.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamProcess</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamProcess</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamProjectPermission</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamProjectPermission</command:noun> <maml:description> <maml:para>Add Permissions on Project Level</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add Permissions on Project Level</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamProjectPermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamProjectPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamProjectPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$user = Get-VSTeamUser -Id "john.doe@example.com" $group = Get-VSTeamGroup -ProjectName "WebAppProject" -GroupName "Contributors" Add-VSTeamProjectPermission -Descriptor $user.Descriptor -User $user -Group $group -Allow "CreateWorkItems" -Deny "DeleteRepository" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command grants the user "john.doe@example.com" the permission to "CreateWorkItems" and denies the permission to "DeleteRepository" within the "WebAppProject" project, specifically assigning these permissions to the "Contributors" group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$group = Get-VSTeamGroup -ProjectName "BackendServices" -GroupName "Readers" Add-VSTeamProjectPermission -Descriptor $group.Descriptor -Group $group -Allow "ReadWorkItems" -Deny "EditCode" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>Here, the "Readers" group in the "BackendServices" project is given the permission to "ReadWorkItems" but is denied the permission to "EditCode".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$user = Get-VSTeamUser -Id "alice.smith@example.org" $group = Get-VSTeamGroup -ProjectName "DataAnalytics" -GroupName "DataScientists" Add-VSTeamProjectPermission -Descriptor $user.Descriptor -User $user -Group $group -Allow "RunQueries" -Deny "DeleteQueries" -ProjectName "DataAnalytics"</dev:code> <dev:remarks> <maml:para>In this example, the user "alice.smith@example.org" is granted the permission to "RunQueries" and is denied the permission to "DeleteQueries" within the "DataAnalytics" project. These permissions are associated with the "DataScientists" group.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$group = Get-VSTeamGroup -ProjectName "MobileApp" -GroupName "Developers" Add-VSTeamProjectPermission -Descriptor $group.Descriptor -Group $group -Allow "CommitChanges" -Deny "DeleteBranch" -ProjectName "MobileApp"</dev:code> <dev:remarks> <maml:para>The "Developers" group in the "MobileApp" project is given the permission to "CommitChanges" but is denied the permission to "DeleteBranch".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$user = Get-VSTeamUser -Id "robert.jones@example.net" $group = Get-VSTeamGroup -ProjectName "FrontendUI" -GroupName "Designers" Add-VSTeamProjectPermission -Descriptor $user.Descriptor -User $user -Group $group -Allow "EditDesigns" -Deny "DeleteDesigns" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>This command allows the user "robert.jones@example.net" to "EditDesigns" and denies the permission to "DeleteDesigns" within the "FrontendUI" project. These permissions are linked to the "Designers" group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamPullRequest</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamPullRequest</command:noun> <maml:description> <maml:para>Creates a new Pull Request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new Pull Request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceRefName</maml:name> <maml:description> <maml:para>A source reference, like a branch or commit Needs to be in ref format like refs/heads/MyBranch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetRefName</maml:name> <maml:description> <maml:para>A target reference, like a branch or commit Needs to be in ref format like refs/heads/MyBranch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Draft</maml:name> <maml:description> <maml:para>Mark the new pull request as a draft</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceRefName</maml:name> <maml:description> <maml:para>A source reference, like a branch or commit Needs to be in ref format like refs/heads/MyBranch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetRefName</maml:name> <maml:description> <maml:para>A target reference, like a branch or commit Needs to be in ref format like refs/heads/MyBranch</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Draft</maml:name> <maml:description> <maml:para>Mark the new pull request as a draft</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.PullRequest</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken $r = Get-VSTeamGitRepository -ProjectName project -Name demorepo Add-VSTeamPullRequest -ProjectName project -RepositoryId $r.RepositoryId -SourceRefName "refs/heads/mybranch" -TargetRefName "refs/heads/trunk" -Title "My PR" -Description "My Description" -Draft</dev:code> <dev:remarks> <maml:para>Create a new pull request as a draft</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamRelease</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamRelease</command:noun> <maml:description> <maml:para>Queues a new release.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add-VSTeamRelease will queue a new release.</maml:para> <maml:para>The environments will deploy according to how the release definition is configured in the Triggers tab.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DefinitionId</maml:name> <maml:description> <maml:para>The id of the release definition to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to use on the release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ArtifactAlias</maml:name> <maml:description> <maml:para>The alias of the artifact to use with this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildId</maml:name> <maml:description> <maml:para>The id of the build to use with this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>The branch of the artifact</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to use on the release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the release definition to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>The branch of the artifact</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>The number of the build to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DefinitionId</maml:name> <maml:description> <maml:para>The id of the release definition to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to use on the release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ArtifactAlias</maml:name> <maml:description> <maml:para>The alias of the artifact to use with this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildId</maml:name> <maml:description> <maml:para>The id of the build to use with this release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>DefinitionName</maml:name> <maml:description> <maml:para>The name of the release definition to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranch</maml:name> <maml:description> <maml:para>The branch of the artifact</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>The number of the build to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuild | ft id,name id name -- ---- 44 Demo-CI-44 Get-VSTeamReleaseDefinition -Expand artifacts | ft id,name,@{l='Alias';e={$_.artifacts[0].alias}} id name Alias -- ---- ----- 1 Demo-CD Demo-CI Add-VSTeamRelease -DefinitionId 1 -Description Test -ArtifactAlias Demo-CI -BuildId 44</dev:code> <dev:remarks> <maml:para>This example shows how to find the Build ID, Artifact Alias, and Release definition ID required to start a release. If you call Set-VSTeamDefaultProject you can use Example 2 which is much easier.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamRelease -DefinitionName Demo-CD -Description Test -BuildNumber Demo-CI-44</dev:code> <dev:remarks> <maml:para>This command starts a new release using the Demo-CD release definition and the build with build number Demo-CI-44.</maml:para> <maml:para>You must set a default project to tab complete DefinitionName and BuildNumber.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamReleaseDefinition</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamReleaseDefinition</command:noun> <maml:description> <maml:para>Creates a new release definition from a JSON file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads a JSON file off disk and uses that file to create a new release definition in the provided project.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be created. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be created. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamReleaseDefinition -ProjectName demo -inFile release.json</dev:code> <dev:remarks> <maml:para>This command reads release.json and creates a new release definition from it on the demo team project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamServiceEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamServiceEndpoint</command:noun> <maml:description> <maml:para>Adds a generic service connection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new generic connection between TFS/AzD and a third party service (see AzD for available connections).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamServiceEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointType</maml:name> <maml:description> <maml:para>Type of endpoint (eg. `kubernetes`, `sonarqube`). See AzD service page for supported endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>Hashtable of Payload for REST call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>Hashtable of Payload for REST call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointType</maml:name> <maml:description> <maml:para>Type of endpoint (eg. `kubernetes`, `sonarqube`). See AzD service page for supported endpoints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.ServiceEndpoint</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$payload = @{ url = "https://api.example.com"; username = "apiuser"; password = "apipassword"; } Add-VSTeamServiceEndpoint -Object $payload -EndpointName "ExampleAPI" -EndpointType "generic" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command creates a new generic service connection named "ExampleAPI" for the "WebAppProject" project. The service connection connects to "https://api.example.com" using the username "apiuser" and password "apipassword".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$payload = @{ url = "https://k8s-cluster.example.org"; token = "k8s-access-token"; } Add-VSTeamServiceEndpoint -Object $payload -EndpointName "K8sCluster" -EndpointType "kubernetes" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>In this example, a new Kubernetes service connection named "K8sCluster" for the "BackendServices" project is created. The service connection connects to the Kubernetes cluster at "https://k8s-cluster.example.org" using the provided token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$payload = @{ url = "https://sonarqube.example.net"; token = "sonar-access-token"; } Add-VSTeamServiceEndpoint -Object $payload -EndpointName "SonarQubeDev" -EndpointType "sonarqube" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>This command sets up a SonarQube service connection named "SonarQubeDev" for the "FrontendUI" project. The SonarQube server's URL is "https://sonarqube.example.net", and it authenticates using the specified token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$payload = @{ url = "https://db.example.co"; username = "dbadmin"; password = "dbpassword"; } Add-VSTeamServiceEndpoint -Object $payload -EndpointName "DatabaseEndpoint" -EndpointType "generic" -ProjectName "DataServices"</dev:code> <dev:remarks> <maml:para>Here, a generic service connection named "DatabaseEndpoint" for the "DataServices" project is created. The service connection connects to the database at "https://db.example.co" using the given username and password.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>$payload = @{ url = "https://storage.example.com"; accessKey = "storage-access-key"; } Add-VSTeamServiceEndpoint -Object $payload -EndpointName "StorageService" -EndpointType "generic" -ProjectName "FileStorage"</dev:code> <dev:remarks> <maml:para>This command constructs a generic service connection named "StorageService" for the project "FileStorage". The service connection links to the storage service at "https://storage.example.com" and uses the provided access key for authentication.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamServiceFabricEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamServiceFabricEndpoint</command:noun> <maml:description> <maml:para>Adds a new Service Fabric service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new Service Fabric service endpoint to an existing project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamServiceFabricEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>url</maml:name> <maml:description> <maml:para>The url of the Service Fabric management endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>useWindowsSecurity</maml:name> <maml:description> <maml:para>If windows integrated authentication should be enabled. If set to false, all authentication is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="displayName"> <maml:name>endpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>clusterSpn</maml:name> <maml:description> <maml:para>Specify the cluster service principal name, for use with windows integrated authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>serverCertThumbprint</maml:name> <maml:description> <maml:para>The server certificate thumbprint, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>username</maml:name> <maml:description> <maml:para>The Azure AD Username, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>password</maml:name> <maml:description> <maml:para>The Password for the Azure AD User, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamServiceFabricEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>url</maml:name> <maml:description> <maml:para>The url of the Service Fabric management endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>useWindowsSecurity</maml:name> <maml:description> <maml:para>If windows integrated authentication should be enabled. If set to false, all authentication is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="displayName"> <maml:name>endpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>clusterSpn</maml:name> <maml:description> <maml:para>Specify the cluster service principal name, for use with windows integrated authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>serverCertThumbprint</maml:name> <maml:description> <maml:para>The server certificate thumbprint, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>certificate</maml:name> <maml:description> <maml:para>The certificate used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>certificatePassword</maml:name> <maml:description> <maml:para>The Password for the certificate used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>url</maml:name> <maml:description> <maml:para>The url of the Service Fabric management endpoint.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>useWindowsSecurity</maml:name> <maml:description> <maml:para>If windows integrated authentication should be enabled. If set to false, all authentication is disabled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>clusterSpn</maml:name> <maml:description> <maml:para>Specify the cluster service principal name, for use with windows integrated authentication.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>serverCertThumbprint</maml:name> <maml:description> <maml:para>The server certificate thumbprint, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>username</maml:name> <maml:description> <maml:para>The Azure AD Username, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>password</maml:name> <maml:description> <maml:para>The Password for the Azure AD User, used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>certificate</maml:name> <maml:description> <maml:para>The certificate used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>certificatePassword</maml:name> <maml:description> <maml:para>The Password for the certificate used for communicating with the Service Fabric cluster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases="displayName"> <maml:name>endpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.ServiceEndpoint</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "NoAuthTest" -url "tcp://10.0.0.1:19000" -useWindowsSecurity $false</dev:code> <dev:remarks> <maml:para>Adds a Service Fabric Endpoint for a non-secure cluster</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$password = '00000000-0000-0000-0000-000000000000' | ConvertTo-SecureString -AsPlainText -Force Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "AzureAdAuthTest" -url "tcp://10.0.0.1:19000" -serverCertThumbprint "SOMECERTTHUMBPRINT" -username "someUser@someplace.com" -password $password</dev:code> <dev:remarks> <maml:para>Adds a Service Fabric Endpoint for an Azure AD secured cluster.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$password = '00000000-0000-0000-0000-000000000000' | ConvertTo-SecureString -AsPlainText -Force $pathToPFX = "C:\someFolder\theCertificateFile.pfx" $base64Cert = [System.Convert]::ToBase64String([System.IO.File]::ReadAllBytes($pathToPFX)) Add-VSTeamServiceFabricEndpoint -ProjectName "SomeProjectName" -endpointName "CertificateAuthTest" -url "tcp://10.0.0.1:19000" -serverCertThumbprint "SOMECERTTHUMBPRINT" -certificate $base64Cert -certificatePassword $password</dev:code> <dev:remarks> <maml:para>Adds a Service Fabric Endpoint for a certificate secured cluster.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamSonarQubeEndpoint</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamSonarQubeEndpoint</command:noun> <maml:description> <maml:para>Adds a new SonarQube service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The cmdlet adds a new connection between TFS/AzD and a SonarQube server using the SonarQube connection type.</maml:para> <maml:para>This is only used when using the SonarQube tasks.</maml:para> <maml:para>Using SonarQube with the Maven tasks uses a Generic Connection type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamSonarQubeEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>SonarQubeUrl</maml:name> <maml:description> <maml:para>URL of the sonarqube server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Authentication Token generated by SonarQube.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamSonarQubeEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>SonarQubeUrl</maml:name> <maml:description> <maml:para>URL of the sonarqube server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Set-VSTeamAccount command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>SonarQubeUrl</maml:name> <maml:description> <maml:para>URL of the sonarqube server.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>Authentication Token generated by SonarQube.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>EndpointName</maml:name> <maml:description> <maml:para>The name displayed on the services page. In AzD this is the Connection Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Set-VSTeamAccount command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamSonarQubeEndpoint -SonarQubeUrl "https://sonarqube.example.com" -PersonalAccessToken "your_token_here" -EndpointName "SonarQube-Prod" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command creates a new SonarQube service endpoint named "SonarQube-Prod" for the "WebAppProject" project. The SonarQube server's URL is "https://sonarqube.example.com", and authentication is done using the provided personal access token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$SecureToken = ConvertTo-SecureString "your_token_here" -AsPlainText -Force Add-VSTeamSonarQubeEndpoint -SonarQubeUrl "https://sonarqube.example.com" -SecurePersonalAccessToken $SecureToken -EndpointName "SonarQube-Dev" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>In this example, a secure string is created first to hold the personal access token. The SonarQube service endpoint named "SonarQube-Dev" for the "BackendServices" project is then created using this secure string. The SonarQube server's URL is "https://sonarqube.example.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamSonarQubeEndpoint -SonarQubeUrl "https://sonar.example.org" -PersonalAccessToken "another_token_here" -EndpointName "SonarQube-Staging" -ProjectName "MobileAppProject"</dev:code> <dev:remarks> <maml:para>This command sets up a SonarQube service endpoint named "SonarQube-Staging" for the "MobileAppProject". The SonarQube server's URL is "https://sonar.example.org", and it authenticates using the specified personal access token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$Token = ConvertTo-SecureString "unique_token_here" -AsPlainText -Force Add-VSTeamSonarQubeEndpoint -SonarQubeUrl "https://sonarqube.example.net" -SecurePersonalAccessToken $Token -EndpointName "SonarQube-Test" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>Here, a secure string is made initially to house the personal access token. The SonarQube service endpoint named "SonarQube-Test" for the "FrontendUI" project is subsequently created using this secure token. The URL for the SonarQube server is "https://sonarqube.example.net".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamSonarQubeEndpoint -SonarQubeUrl "https://sonarqube.example.co" -PersonalAccessToken "different_token_here" -EndpointName "SonarQube-Alpha" -ProjectName "DataAnalytics"</dev:code> <dev:remarks> <maml:para>This command constructs a SonarQube service endpoint named "SonarQube-Alpha" for the project "DataAnalytics". The URL for the SonarQube server is "https://sonarqube.example.co", and authentication is achieved using the given personal access token.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamTaskGroup</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamTaskGroup</command:noun> <maml:description> <maml:para>Adds a task group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a task group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamTaskGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>The path to the json file that represents the task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamTaskGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>The path to the json file that represents the task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$taskGroup = Get-VSTeamTaskGroup -Name "taskGroupName" -ProjectName "sourceProjectName" # Set the ID and revision to null, so AzD is happy. $taskGroup.id = $null $taskGroup.revision = $null $taskGroupJson = ConvertTo-Json -InputObject $taskGroup -Depth 10 Add-VSTeamTaskGroup -Body $taskGroupJson -ProjectName "destinationProjectName"</dev:code> <dev:remarks> <maml:para>This example is useful for when one wants to copy an existing task group in one project into another project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamTaskGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamUserEntitlement</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamUserEntitlement</command:noun> <maml:description> <maml:para>Add a user, assign license and extensions and make them a member of a project group in an account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add a user, assign license and extensions and make them a member of a project group in an account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="UserEmail"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address of the user to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Type of Account License. The acceptable values for this parameter are:</maml:para> <maml:para>- Advanced</maml:para> <maml:para>- EarlyAdopter</maml:para> <maml:para>- Express</maml:para> <maml:para>- None</maml:para> <maml:para>- Professional</maml:para> <maml:para>- StakeHolder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EarlyAdopter</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Custom</maml:para> <maml:para>- ProjectAdministrator</maml:para> <maml:para>- ProjectContributor</maml:para> <maml:para>- ProjectReader</maml:para> <maml:para>- ProjectStakeholder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ProjectContributor</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicensingSource</maml:name> <maml:description> <maml:para>Licensing Source (e.g. Account. MSDN etc.). The acceptable values for this parameter are:</maml:para> <maml:para>- account</maml:para> <maml:para>- auto</maml:para> <maml:para>- msdn</maml:para> <maml:para>- none</maml:para> <maml:para>- profile</maml:para> <maml:para>- trial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>account</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MSDNLicenseType</maml:name> <maml:description> <maml:para>Type of MSDN License (e.g. Visual Studio Professional, Visual Studio Enterprise etc.). The acceptable values for this parameter are:</maml:para> <maml:para>- eligible</maml:para> <maml:para>- enterprise</maml:para> <maml:para>- none</maml:para> <maml:para>- platforms</maml:para> <maml:para>- premium</maml:para> <maml:para>- professional</maml:para> <maml:para>- testProfessional</maml:para> <maml:para>- ultimate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="UserEmail"> <maml:name>Email</maml:name> <maml:description> <maml:para>Email address of the user to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Type of Account License. The acceptable values for this parameter are:</maml:para> <maml:para>- Advanced</maml:para> <maml:para>- EarlyAdopter</maml:para> <maml:para>- Express</maml:para> <maml:para>- None</maml:para> <maml:para>- Professional</maml:para> <maml:para>- StakeHolder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EarlyAdopter</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>The acceptable values for this parameter are:</maml:para> <maml:para>- Custom</maml:para> <maml:para>- ProjectAdministrator</maml:para> <maml:para>- ProjectContributor</maml:para> <maml:para>- ProjectReader</maml:para> <maml:para>- ProjectStakeholder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>ProjectContributor</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicensingSource</maml:name> <maml:description> <maml:para>Licensing Source (e.g. Account. MSDN etc.). The acceptable values for this parameter are:</maml:para> <maml:para>- account</maml:para> <maml:para>- auto</maml:para> <maml:para>- msdn</maml:para> <maml:para>- none</maml:para> <maml:para>- profile</maml:para> <maml:para>- trial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>account</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MSDNLicenseType</maml:name> <maml:description> <maml:para>Type of MSDN License (e.g. Visual Studio Professional, Visual Studio Enterprise etc.). The acceptable values for this parameter are:</maml:para> <maml:para>- eligible</maml:para> <maml:para>- enterprise</maml:para> <maml:para>- none</maml:para> <maml:para>- platforms</maml:para> <maml:para>- premium</maml:para> <maml:para>- professional</maml:para> <maml:para>- testProfessional</maml:para> <maml:para>- ultimate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamUserEntitlement -License "Advanced" -Group "ProjectAdministrator" -LicensingSource "account" -MSDNLicenseType "professional" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command adds a user to the "WebAppProject" with an "Advanced" license type. The user is made a member of the "ProjectAdministrator" group. The licensing source for this user is set as "account" and the MSDN license type is set as "professional".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamUserEntitlement -License "StakeHolder" -Group "ProjectReader" -LicensingSource "msdn" -MSDNLicenseType "enterprise" -ProjectName "MobileAppProject"</dev:code> <dev:remarks> <maml:para>This example adds a user to the "MobileAppProject" with a "StakeHolder" license type. The user is assigned to the "ProjectReader" group. The licensing source is set to "msdn" and the MSDN license type is "enterprise".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamUserEntitlement -License "Professional" -Group "ProjectContributor" -LicensingSource "profile" -MSDNLicenseType "premium" -ProjectName "BackendServices"</dev:code> <dev:remarks> <maml:para>In this command, a user is added to the "BackendServices" project with a "Professional" license type. The user is added to the "ProjectContributor" group. The licensing source is set to "profile" and the MSDN license type is "premium".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Add-VSTeamUserEntitlement -License "Express" -Group "Custom" -LicensingSource "trial" -MSDNLicenseType "testProfessional" -ProjectName "FrontendUI"</dev:code> <dev:remarks> <maml:para>This example adds a user to the "FrontendUI" project with an "Express" license type. The user is made a member of a custom group. The licensing source is set as "trial" and the MSDN license type is "testProfessional".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamUserEntitlement -License "None" -Group "ProjectStakeholder" -LicensingSource "none" -MSDNLicenseType "eligible" -ProjectName "DataAnalytics"</dev:code> <dev:remarks> <maml:para>This command adds a user to the "DataAnalytics" project without assigning any specific license (set to "None"). The user is assigned to the "ProjectStakeholder" group. Both the licensing source and the MSDN license type are set to "none" and "eligible" respectively.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamVariableGroup</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamVariableGroup</command:noun> <maml:description> <maml:para>Adds a variable group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a variable group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The variable group description</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProviderData</maml:name> <maml:description> <maml:para>The variable group ProviderData. This parameter is not available in TFS2017. This should be $null for Vsts types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The variable group type. This parameter is not available in TFS2017; all variable groups are type Vsts in this case.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Vsts</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureKeyVault</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>The variable group variables.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-VSTeamVariableGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the variable group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The variable group description</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProviderData</maml:name> <maml:description> <maml:para>The variable group ProviderData. This parameter is not available in TFS2017. This should be $null for Vsts types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The variable group type. This parameter is not available in TFS2017; all variable groups are type Vsts in this case.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>The variable group variables.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the variable group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.Collections.Hashtable</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "new_variable_group" Description = "Describe the Variable Group" Type = "Vsts" Variables = @{ key1 = @{ value = "value1" } key2 = @{ value = "value2" isSecret = $true } } } Add-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "new_variable_group" Description = "Describe the Variable Group" Type = "AzureKeyVault" Variables = @{ name_of_existing_secret = @{ enabled = $true contentType = "" value = "" isSecret = $true } } ProviderData = @{ serviceEndpointId = "AzureRMServiceEndpointGuid" vault = "name_of_existing_key_vault" } } Add-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code># Copy variable group varGroupName from project sourceProjectName to project targetProjectName. If varGroupName already exists, we'll update it; else, we'll add it. $Name = "varGroupName" $FromProject = "sourceProjectName" $ToProject = "targetProjectName" $FromVariableGroupObject = Get-VSTeamVariableGroup -Name $Name -ProjectName $FromProject $body = ConvertTo-Json -InputObject $FromVariableGroupObject -Depth 100 -Compress $toVariableGroupObject = Get-VSTeamVariableGroup -Name $Name -ProjectName $ToProject if ($toVariableGroupObject) { Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id } else { Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject }</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamVariableGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamWiki</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamWiki</command:noun> <maml:description> <maml:para>Publish a project or code wiki in the project provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publish a code or project wiki in to the selected repo</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name or ID of the Wiki to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>ID of the repository to publish from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Name of the branch in the repo to publish from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>mappedPath</maml:name> <maml:description> <maml:para>Path inside the repo to publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name or ID of the Wiki to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>ID of the repository to publish from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Name of the branch in the repo to publish from</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>mappedPath</maml:name> <maml:description> <maml:para>Path inside the repo to publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamWiki -ProjectName myProject -Name myProjectWiki</dev:code> <dev:remarks> <maml:para>This will create a project wiki</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamWiki -ProjectName myProject -Name myCodeWiki -repositoryId 00000000-0000-0000-0000-000000000000 -branch main -mappedPath '/.Docs'</dev:code> <dev:remarks> <maml:para>This will create a code wiki from main branch and publish '.Docs' folder</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamWiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamWiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamWorkItem</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamWorkItem</command:noun> <maml:description> <maml:para>Adds a work item to your project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add-VSTeamWorkItem will add a new work item to your project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamWorkItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>The IterationPath of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>The email address of the user this work item will be assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>The type of work item to add.</maml:para> <maml:para>You can tab complete from a list of available work item types.</maml:para> <maml:para>You must use Set-VSTeamDefaultProject to set a default project to enable the tab completion.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The Id of the parent work item that this work item will be related to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalFields</maml:name> <maml:description> <maml:para>Hashtable which contains a key value pair of any field that should be filled with values. Key is the internal name of the field and the value is the content of the field being filled. E.g. the internal name for the area path is 'System.AreaPath'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>The IterationPath of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>The email address of the user this work item will be assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>The type of work item to add.</maml:para> <maml:para>You can tab complete from a list of available work item types.</maml:para> <maml:para>You must use Set-VSTeamDefaultProject to set a default project to enable the tab completion.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ParentId</maml:name> <maml:description> <maml:para>The Id of the parent work item that this work item will be related to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalFields</maml:name> <maml:description> <maml:para>Hashtable which contains a key value pair of any field that should be filled with values. Key is the internal name of the field and the value is the content of the field being filled. E.g. the internal name for the area path is 'System.AreaPath'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> <maml:para>WorkItemType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>WorkItemType is a dynamic parameter and uses the project value to query their validate set.</maml:para> <maml:para>If you do not set the default project by calling Set-VSTeamDefaultProject before calling Add-VSTeamWorkItem you need to provide the -ProjectName before -WorkItemType or will have to type in the names.</maml:para> <maml:para>Any of the basic work item parameters defined in this method, will cause an exception if also added to the parameter AdditionalFields, since it is redundant. Either only use the parameter or define them in the AdditionalFields parameter.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Add-VSTeamWorkItem -Title "New Work Item" -WorkItemType Task ID Title Status -- ----- ------ 6 New Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Add-VSTeamWorkItem -Title "New Work Item" -WorkItemType Task -Description "This is a description" ID Title Status -- ----- ------ 6 New Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo $additionalFields = @{"System.Tags"= "TestTag"; "System.AreaPath" = "Project\\MyPath"} Add-VSTeamWorkItem -Title "New Work Item" -WorkItemType Task -Description "This is a description" -AdditionalFields $additionalFields ID Title Status -- ----- ------ 6 New Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamWorkItemAreaPermission</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamWorkItemAreaPermission</command:noun> <maml:description> <maml:para>Add Permissions to a Work Item Area</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add Permissions to a Work Item Area</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamWorkItemAreaPermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AreaID</maml:name> <maml:description> <maml:para>Area ID of the work item area for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Area path of the work item area for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemAreaPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemAreaPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemAreaPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemAreaPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AreaID</maml:name> <maml:description> <maml:para>Area ID of the work item area for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AreaPath</maml:name> <maml:description> <maml:para>Area path of the work item area for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemAreaPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemAreaPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemAreaPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemAreaPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemAreaPermission -AreaID 201 -AreaPath "Features\Authentication" -Descriptor "vssgp.User1D3nt1f13r" -User "vssa.User1D3nt1f13r" -Group "vssgp.Group1D3nt1f13r" -Allow "Read,Write" -Deny "Delete" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This command adds read and write permissions to the work item area with ID 201 and path "Features\Authentication" for a user with the descriptor "vssa.User1D3nt1f13r" and a group with the descriptor "vssgp.Group1D3nt1f13r" in the "WebAppProject". It denies the delete permission for the same.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemAreaPermission -AreaID 202 -AreaPath "Features\Registration" -Descriptor "vssgp.User2D3nt1f13r" -User "vssa.User2D3nt1f13r" -Group "vssgp.Group2D3nt1f13r" -Allow "Read" -ProjectName "WebAppProject"</dev:code> <dev:remarks> <maml:para>This example grants read permission to the work item area with ID 202 and path "Features\Registration" for a user with the descriptor "vssa.User2D3nt1f13r" and a group with the descriptor "vssgp.Group2D3nt1f13r" in the "WebAppProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemAreaPermission -AreaID 203 -AreaPath "Features\Payments" -Descriptor "vssgp.User3D3nt1f13r" -User "vssa.User3D3nt1f13r" -Group "vssgp.Group3D3nt1f13r" -Allow "Read,Write,Delete" -ProjectName "WebAppProject" -OverwriteMask</dev:code> <dev:remarks> <maml:para>In this command, permissions for the work item area with ID 203 and path "Features\Payments" are set for a user with the descriptor "vssa.User3D3nt1f13r" and a group with the descriptor "vssgp.Group3D3nt1f13r" in the "WebAppProject". The permissions are read, write, and delete. The `-OverwriteMask` switch indicates that these permissions will overwrite any existing permissions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$permissions = @{ AreaID = 204 AreaPath = "Features\Reporting" Descriptor = "vssgp.User4D3nt1f13r" User = "vssa.User4D3nt1f13r" Group = "vssgp.Group4D3nt1f13r" Allow = "Read" ProjectName = "WebAppProject" } Add-VSTeamWorkItemAreaPermission @permissions</dev:code> <dev:remarks> <maml:para>This example uses a hashtable to define the permissions and then splats those values to the `Add-VSTeamWorkItemAreaPermission` command. The command grants read permission to the work item area with ID 204 and path "Features\Reporting" for a user with the descriptor "vssa.User4D3nt1f13r" and a group with the descriptor "vssgp.Group4D3nt1f13r" in the "WebAppProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemAreaPermission -AreaID 205 -AreaPath "Features\Analytics" -Descriptor "vssgp.User5D3nt1f13r" -User "vssa.User5D3nt1f13r" -Group "vssgp.Group5D3nt1f13r" -Allow "Read,Write" -Deny "Delete" -ProjectName "WebAppProject" -Confirm</dev:code> <dev:remarks> <maml:para>This command prompts for confirmation before adding read and write permissions and denying delete permission to the work item area with ID 205 and path "Features\Analytics" for a user with the descriptor "vssa.User5D3nt1f13r" and a group with the descriptor "vssgp.Group5D3nt1f13r" in the "WebAppProject".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-VSTeamWorkItemIterationPermission</command:name> <command:verb>Add</command:verb> <command:noun>VSTeamWorkItemIterationPermission</command:noun> <maml:description> <maml:para>Add Permissions to an Iteration</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add Permissions to an Iteration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-VSTeamWorkItemIterationPermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationID</maml:name> <maml:description> <maml:para>Iteration ID for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Iteration path for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemIterationPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemIterationPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemIterationPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemIterationPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationID</maml:name> <maml:description> <maml:para>Iteration ID for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>Iteration path for which the permissions are to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of the user or group to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>User descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Group</maml:name> <maml:description> <maml:para>Group descriptor to add permissions for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamGroup</command:parameterValue> <dev:type> <maml:name>VSTeamGroup</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Allow permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemIterationPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemIterationPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Deny permissions to add.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamWorkItemIterationPermissions</command:parameterValue> <dev:type> <maml:name>VSTeamWorkItemIterationPermissions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OverwriteMask</maml:name> <maml:description> <maml:para>Switch to overwrite the mask values rather than merge them.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemIterationPermission -IterationID 101 -IterationPath "Sprint 5" -Descriptor "vssgp.Uz3r1D3nt1f13r" -User "vssa.Uz3r1D3nt1f13rForUser" -Group "vssgp.Uz3r1D3nt1f13rForGroup" -Allow "Read,Write" -Deny "Delete" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command adds read and write permissions to the iteration with ID 101 and path "Sprint 5" for a user with the descriptor "vssa.Uz3r1D3nt1f13rForUser" and a group with the descriptor "vssgp.Uz3r1D3nt1f13rForGroup" in the "MyProject". It denies the delete permission for the same.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemIterationPermission -IterationID 102 -IterationPath "Sprint 6" -Descriptor "vssgp.An0th3r1D3nt1f13r" -User "vssa.An0th3r1D3nt1f13rForUser" -Group "vssgp.An0th3r1D3nt1f13rForGroup" -Allow "Read" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example gives read permission to the iteration with ID 102 and path "Sprint 6" for a user with the descriptor "vssa.An0th3r1D3nt1f13rForUser" and a group with the descriptor "vssgp.An0th3r1D3nt1f13rForGroup" in the "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemIterationPermission -IterationID 103 -IterationPath "Sprint 7" -Descriptor "vssgp.Th1rd1D3nt1f13r" -User "vssa.Th1rd1D3nt1f13rForUser" -Group "vssgp.Th1rd1D3nt1f13rForGroup" -Allow "Read,Write,Delete" -ProjectName "MyProject" -OverwriteMask</dev:code> <dev:remarks> <maml:para>In this command, permissions for the iteration with ID 103 and path "Sprint 7" are set for a user with the descriptor "vssa.Th1rd1D3nt1f13rForUser" and a group with the descriptor "vssgp.Th1rd1D3nt1f13rForGroup" in the "MyProject". The permissions are read, write, and delete. The `-OverwriteMask` switch indicates that these permissions will overwrite any existing permissions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$permissions = @{ IterationID = 104 IterationPath = "Sprint 8" Descriptor = "vssgp.F0urth1D3nt1f13r" User = "vssa.F0urth1D3nt1f13rForUser" Group = "vssgp.F0urth1D3nt1f13rForGroup" Allow = "Read" ProjectName = "MyProject" } Add-VSTeamWorkItemIterationPermission @permissions</dev:code> <dev:remarks> <maml:para>This example uses a hashtable to define the permissions and then splats those values to the `Add-VSTeamWorkItemIterationPermission` command. The command gives read permission to the iteration with ID 104 and path "Sprint 8" for a user with the descriptor "vssa.F0urth1D3nt1f13rForUser" and a group with the descriptor "vssgp.F0urth1D3nt1f13rForGroup" in the "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Add-VSTeamWorkItemIterationPermission -IterationID 105 -IterationPath "Sprint 9" -Descriptor "vssgp.F1fth1D3nt1f13r" -User "vssa.F1fth1D3nt1f13rForUser" -Group "vssgp.F1fth1D3nt1f13rForGroup" -Allow "Read,Write" -Deny "Delete" -ProjectName "MyProject" -Confirm</dev:code> <dev:remarks> <maml:para>This command prompts for confirmation before adding read and write permissions and denying delete permission to the iteration with ID 105 and path "Sprint 9" for a user with the descriptor "vssa.F1fth1D3nt1f13rForUser" and a group with the descriptor "vssgp.F1fth1D3nt1f13rForGroup" in the "MyProject".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-VSTeamDefaultAPITimeout</command:name> <command:verb>Clear</command:verb> <command:noun>VSTeamDefaultAPITimeout</command:noun> <maml:description> <maml:para>Clears the value stored in the default timeout parameter value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the value stored in the default timeout parameter value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-VSTeamDefaultAPITimeout</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default timeout at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default timeout at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-VSTeamDefaultAPITimeout</dev:code> <dev:remarks> <maml:para>This will clear the default timeout parameter value.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-VSTeamDefaultProject</command:name> <command:verb>Clear</command:verb> <command:noun>VSTeamDefaultProject</command:noun> <maml:description> <maml:para>Clears the value stored in the default project parameter value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the value stored in the default project parameter value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-VSTeamDefaultProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default project at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default project at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-VSTeamDefaultProject</dev:code> <dev:remarks> <maml:para>This will clear the default project parameter value. You will now have to provide a project for any functions that require a project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Clear-VSTeamDefaultProjectCount</command:name> <command:verb>Clear</command:verb> <command:noun>VSTeamDefaultProjectCount</command:noun> <maml:description> <maml:para>Clears the value stored in the default project count parameter value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the value stored in the default project count parameter value.</maml:para> <maml:para>Clearing this value will only return the top 100 projects. This could have a negative effect on project name tab completion and validation if you have more than 100 projects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-VSTeamDefaultProjectCount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default project at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your default project at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Clear-VSTeamDefaultProjectCount</dev:code> <dev:remarks> <maml:para>This will clear the default project count parameter value. You will now only get the top 100 projects back.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-VSTeamAgent</command:name> <command:verb>Disable</command:verb> <command:noun>VSTeamAgent</command:noun> <maml:description> <maml:para>Disables an agent in a pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disables an agent in a pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-VSTeamAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to disable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Disable-VSTeamAgent -PoolId 4 -Id 23</dev:code> <dev:remarks> <maml:para>This command disables the agent with the ID 23 in the pool with the ID 4.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Disable-VSTeamAgent -PoolId 2 -Id 10, 11, 12</dev:code> <dev:remarks> <maml:para>This example disables multiple agents with the IDs 10, 11, and 12 in the pool with the ID 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$agentIDs = @(33,34,35) Disable-VSTeamAgent -PoolId 5 -Id $agentIDs</dev:code> <dev:remarks> <maml:para>In this example, agents with IDs 33, 34, and 35 in the pool with the ID 5 are disabled using an array variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamAgent -PoolId 3 | Where-Object { $_.status -eq "Online" } | ForEach-Object { Disable-VSTeamAgent -PoolId 3 -Id $_.id }</dev:code> <dev:remarks> <maml:para>This command retrieves all agents in the pool with the ID 3, filters to get only the online agents, and then disables each of those online agents.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Disable-VSTeamAgent -PoolId 6 -Id 40 -Force</dev:code> <dev:remarks> <maml:para>This example disables the agent with ID 40 in the pool with ID 6 without prompting for confirmation by using the `-Force` switch.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Disable-VSTeamAgent -PoolId 7 -Id 45 -WhatIf</dev:code> <dev:remarks> <maml:para>This command shows what would happen if the agent with ID 45 in the pool with ID 7 was disabled, without actually disabling the agent.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-VSTeamAgent</command:name> <command:verb>Enable</command:verb> <command:noun>VSTeamAgent</command:noun> <maml:description> <maml:para>Enables an agent in a pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Enables an agent in a pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-VSTeamAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to enable.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Enable-VSTeamAgent -PoolId 4 -Id 23</dev:code> <dev:remarks> <maml:para>This command enables the agent with the ID 23 in the pool with the ID 4.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Enable-VSTeamAgent -PoolId 2 -Id 10, 11, 12</dev:code> <dev:remarks> <maml:para>This example enables multiple agents with the IDs 10, 11, and 12 in the pool with the ID 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$agentIDs = @(33,34,35) Enable-VSTeamAgent -PoolId 5 -Id $agentIDs</dev:code> <dev:remarks> <maml:para>In this example, agents with IDs 33, 34, and 35 in the pool with the ID 5 are enabled using an array variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamAgent -PoolId 3 | Where-Object { $_.status -eq "Offline" } | ForEach-Object { Enable-VSTeamAgent -PoolId 3 -Id $_.id }</dev:code> <dev:remarks> <maml:para>This command retrieves all agents in the pool with the ID 3, filters to get only the offline agents, and then enables each of those offline agents.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeam</command:name> <command:verb>Get</command:verb> <command:noun>VSTeam</command:noun> <maml:description> <maml:para>Returns a team.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a team.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeam</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TeamId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TeamId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the team to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Team</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Get team by name -----------------</maml:title> <dev:code>Get-VSTeamProject | Get-VSTeam 'Test Team'</dev:code> <dev:remarks> <maml:para>This command pipes the project name to Get-VSTeam and returns the team with the name 'Test Team'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAccessControlList</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAccessControlList</command:noun> <maml:description> <maml:para>Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAccessControlList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>Security token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptors</maml:name> <maml:description> <maml:para>An optional filter string containing a list of identity descriptors whose ACEs should be retrieved. If this is not set entire ACLs will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeExtendedInfo</maml:name> <maml:description> <maml:para>If set, populate the extended information properties for the access control entries contained in the returned lists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, return child ACLs of the specified token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamAccessControlList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>Security token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptors</maml:name> <maml:description> <maml:para>An optional filter string containing a list of identity descriptors whose ACEs should be retrieved. If this is not set entire ACLs will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeExtendedInfo</maml:name> <maml:description> <maml:para>If set, populate the extended information properties for the access control entries contained in the returned lists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, return child ACLs of the specified token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>Security token</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptors</maml:name> <maml:description> <maml:para>An optional filter string containing a list of identity descriptors whose ACEs should be retrieved. If this is not set entire ACLs will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeExtendedInfo</maml:name> <maml:description> <maml:para>If set, populate the extended information properties for the access control entries contained in the returned lists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, return child ACLs of the specified token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.AccessControlList</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamSecurityNamespace | Select-Object -First 1 | Get-VSTeamAccessControlList</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAccountBilling</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAccountBilling</command:noun> <maml:description> <maml:para>Gets the current account billing setup.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the current account billing setup. This includes what subscription the organization is connected. It also shows when the organization is not connected to a subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAccountBilling</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Beware that these operations are potentially producing costs. This is why you need to confirm or force the command.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Set Microsoft hosted pipeline jobs --------</maml:title> <dev:code>Get-VSTeamAccountBilling</dev:code> <dev:remarks> <maml:para>Gets the current organization billing setup.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamPipelineBilling</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamPipelineBilling</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAccounts</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAccounts</command:noun> <maml:description> <maml:para>Gets the organizations where the user has access. Where the given user is either a member or an owner.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the organizations where the user has access. Where the given user is either a member or an owner.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAccounts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Gets all organizations where the user is a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamAccounts</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Gets all organizations where the user is the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MemberId</maml:name> <maml:description> <maml:para>Gets all organizations where the user is a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OwnerId</maml:name> <maml:description> <maml:para>Gets all organizations where the user is the owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----- Example 1: Get organizations where the user is owner -----</maml:title> <dev:code>$myProfile = Get-VSTeamUserProfile -MyProfile $orgs = Get-VSTeamAccounts -MemberId $myProfile.id</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---- Example 2: Get organizations where the user is member ----</maml:title> <dev:code>$myProfile = Get-VSTeamUserProfile -MyProfile $orgs = Get-VSTeamAccounts -OwnerId $myProfile.id</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamPipelineBilling</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamPipelineBilling</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAgent</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAgent</command:noun> <maml:description> <maml:para>Returns the agents in a pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the agents in a pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>To read system capabilities that contain dots you have to use the PSObject Properties property.</maml:para> <maml:para>(Get-VSTeamAgent 1 91).systemCapabilities.PSObject.Properties['Agent.OS'].Value</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamAgent -PoolId 5</dev:code> <dev:remarks> <maml:para>This command retrieves all agents within the pool with the ID 5.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamAgent -PoolId 3 -Id 42</dev:code> <dev:remarks> <maml:para>This example fetches the agent with the ID 42 within the pool with the ID 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$agent = Get-VSTeamAgent -PoolId 1 -Id 91 $agent.systemCapabilities.PSObject.Properties['Agent.OS'].Value</dev:code> <dev:remarks> <maml:para>In this example, the agent with the ID 91 in the pool with the ID 1 is fetched. Afterwards, the system capability 'Agent.OS' of the agent is displayed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$agents = Get-VSTeamAgent -PoolId 2 $agents | Where-Object { $_.status -eq "Online" }</dev:code> <dev:remarks> <maml:para>This command retrieves all agents in the pool with the ID 2 and then filters to show only those agents that are currently online.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAgentPoolMaintenance</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAgentPoolMaintenance</command:noun> <maml:description> <maml:para>Gets the agent pool maintenance job</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the agent pool maintenance job</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAgentPoolMaintenance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to maintain</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to maintain</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-VSTeamAgentPoolMaintenance -Id 1</dev:code> <dev:remarks> <maml:para>Gets the agent pool maintenance job with id 1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamAPIVersion</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamAPIVersion</command:noun> <maml:description> <maml:para>Returns the versions of APIs used.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the versions of APIs used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamAPIVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the service to change. The acceptable values for this parameter are:</maml:para> <maml:para>- Build</maml:para> <maml:para>- Release</maml:para> <maml:para>- Core</maml:para> <maml:para>- Git</maml:para> <maml:para>- DistributedTask</maml:para> <maml:para>- Tfvc</maml:para> <maml:para>- Packaging</maml:para> <maml:para>- MemberEntitlementManagement</maml:para> <maml:para>- ExtensionsManagement</maml:para> <maml:para>- ServiceEndpoints</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the service to change. The acceptable values for this parameter are:</maml:para> <maml:para>- Build</maml:para> <maml:para>- Release</maml:para> <maml:para>- Core</maml:para> <maml:para>- Git</maml:para> <maml:para>- DistributedTask</maml:para> <maml:para>- Tfvc</maml:para> <maml:para>- Packaging</maml:para> <maml:para>- MemberEntitlementManagement</maml:para> <maml:para>- ExtensionsManagement</maml:para> <maml:para>- ServiceEndpoints</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamAPIVersion</dev:code> <dev:remarks> <maml:para>This command gets the API versions currently in use.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamAPIVersion -Service Release</dev:code> <dev:remarks> <maml:para>This command gets the version of the Release API currently in use.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamApproval</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamApproval</command:noun> <maml:description> <maml:para>Gets a list of approvals for all releases for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamApproval function gets the approvals for all releases for a team project.</maml:para> <maml:para>With just a project name, this function gets all of the pending approvals for that team project.</maml:para> <maml:para>When using with AzD "IncludeMyGroupApprovals" will be added to the request when Assigned To Filter is not empty.</maml:para> <maml:para>When using with TFS "IncludeMyGroupApprovals" will be added to the request when Assigned To Filter, Release Id Filter are not empty and Status Filter equals Pending.</maml:para> <maml:para>The vsteam_lib.Approval type has three custom table formats:</maml:para> <maml:para>- Pending: ID, Status, Release Name, Environment, Type, Approver Name, Release Definitions</maml:para> <maml:para>- Approved: Release Name, Environment, Is Automated, Approval Type, Approver Name, Release Definitions, Comments</maml:para> <maml:para>- Rejected: Release Name, Environment, Approval Type, Approver Name, Release Definition, Comments</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamApproval</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>By default the function returns Pending approvals.</maml:para> <maml:para>Using this filter you can return Approved, ReAssigned or Rejected approvals.</maml:para> <maml:para>There is a custom table view for each status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>Only approvals for the release ids provided will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedToFilter</maml:name> <maml:description> <maml:para>Approvals are filtered to only those assigned to this user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>By default the function returns Pending approvals.</maml:para> <maml:para>Using this filter you can return Approved, ReAssigned or Rejected approvals.</maml:para> <maml:para>There is a custom table view for each status.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>Only approvals for the release ids provided will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedToFilter</maml:name> <maml:description> <maml:para>Approvals are filtered to only those assigned to this user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.BuildDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamApproval -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command gets a list of all pending approvals.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamApproval -ProjectName Demo -StatusFilter Approved | Format-Table -View Approved</dev:code> <dev:remarks> <maml:para>This command gets a list of all approved approvals using a custom table format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamApproval -ProjectName Demo -AssignedToFilter Administrator -StatusFilter Rejected | FT -View Rejected</dev:code> <dev:remarks> <maml:para>This command gets a list of all approvals rejected by Administrator using a custom table format.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamArea</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamArea</command:noun> <maml:description> <maml:para>Gets the area node for a given area path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the area node for a given area path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamArea</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This is a wrapper function for Get-VSTeamClassificationNode</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamArea -Path "Features\Login" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command retrieves the area node corresponding to the "Login" area under the "Features" path in the project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamArea -Id 45 -ProjectName "DevOpsProject"</dev:code> <dev:remarks> <maml:para>In this example, the area node with the ID 45 within the "DevOpsProject" is fetched.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamArea -Depth 2 -Path "Features" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve the area node for the "Features" path in the project "MyProject", including its children up to a depth of 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>$areas = Get-VSTeamArea -ProjectName "MyProject" $areas | Where-Object { $_.Name -like "*UI*" }</dev:code> <dev:remarks> <maml:para>This command fetches all area nodes in the "MyProject" and then filters out areas that have a name containing the word "UI".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBanner</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBanner</command:noun> <maml:description> <maml:para>Retrieves a banner from Azure DevOps based on its ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves a banner from Azure DevOps based on its ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBanner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBanner -Id '12345'</dev:code> <dev:remarks> <maml:para>Returns the banner with the specified ID.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuild</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Gets the builds for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamBuild function gets the builds for a team project.</maml:para> <maml:para>With just a project name, this function gets all of the builds for that team project.</maml:para> <maml:para>You can also specify a particular build by ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResultFilter</maml:name> <maml:description> <maml:para>Specifies the result of the builds to return Succeeded, PartiallySucceeded, Failed, or Canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReasonFilter</maml:name> <maml:description> <maml:para>Specifies the reason the build was created of the builds to return Manual, IndividualCI, BatchedCI, Schedule, UserCreated, ValidateShelveSet, CheckInShelveSet, Triggered, or All.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>Specifies the status of the builds to return InProgress, Completed, Cancelling, Postponed, NotStarted, or All.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Queues</maml:name> <maml:description> <maml:para>A comma-delimited list of queue IDs that specifies the builds to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Definitions</maml:name> <maml:description> <maml:para>A comma-delimited list of build definition IDs that specifies the builds to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>Returns the build with this build number.</maml:para> <maml:para>You can also use * for a starts with search. For example: 2015* Will return all build numbers that start with 2015.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of builds to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxBuildsPerDefinition</maml:name> <maml:description> <maml:para>The maximum number of builds to retrieve for each definition.</maml:para> <maml:para>This is only valid when definitions is also specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>A comma-delimited list of extended properties to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResultFilter</maml:name> <maml:description> <maml:para>Specifies the result of the builds to return Succeeded, PartiallySucceeded, Failed, or Canceled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReasonFilter</maml:name> <maml:description> <maml:para>Specifies the reason the build was created of the builds to return Manual, IndividualCI, BatchedCI, Schedule, UserCreated, ValidateShelveSet, CheckInShelveSet, Triggered, or All.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>Specifies the status of the builds to return InProgress, Completed, Cancelling, Postponed, NotStarted, or All.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Queues</maml:name> <maml:description> <maml:para>A comma-delimited list of queue IDs that specifies the builds to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Definitions</maml:name> <maml:description> <maml:para>A comma-delimited list of build definition IDs that specifies the builds to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>Returns the build with this build number.</maml:para> <maml:para>You can also use * for a starts with search. For example: 2015* Will return all build numbers that start with 2015.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of builds to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxBuildsPerDefinition</maml:name> <maml:description> <maml:para>The maximum number of builds to retrieve for each definition.</maml:para> <maml:para>This is only valid when definitions is also specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:description> <maml:para>A comma-delimited list of extended properties to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Build</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuild -ProjectName demo | Format-List *</dev:code> <dev:remarks> <maml:para>This command gets a list of all builds in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the build objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuild -ProjectName demo -top 5 -resultFilter failed</dev:code> <dev:remarks> <maml:para>This command gets a list of 5 failed builds in the demo project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>1203,1204 | Get-VSTeamBuild -ProjectName demo</dev:code> <dev:remarks> <maml:para>This command gets builds with IDs 1203 and 1204 by using the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamBuild -ProjectName demo -ID 1203,1204</dev:code> <dev:remarks> <maml:para>This command gets builds with IDs 1203 and 1204 by using the ID parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamBuild -ProjectName demo -ID 1203 -Raw</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuild</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuild</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuild</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuild</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuildArtifact</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuildArtifact</command:noun> <maml:description> <maml:para>Returns the artifacts of a build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the artifacts of a build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuildArtifact</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuildArtifact -Id 150 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command retrieves all artifacts associated with the build having the ID 150 in the project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildArtifact -Id 220 -ProjectName "DevOpsProject"</dev:code> <dev:remarks> <maml:para>In this example, all artifacts related to the build with the ID 220 within the "DevOpsProject" are fetched.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$builds = Get-VSTeamBuild -ProjectName "MyProject" $builds | ForEach-Object { Get-VSTeamBuildArtifact -Id $_.Id -ProjectName "MyProject" }</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve artifacts for all builds in the "MyProject". It first fetches all builds in the project and then iterates over each build to retrieve its artifacts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamBuildArtifact -Id 310 -ProjectName "TestProject" | Where-Object { $_.Name -like "*debug*" }</dev:code> <dev:remarks> <maml:para>This command fetches all artifacts of the build with ID 310 in the "TestProject" and then filters out artifacts that have a name containing the word "debug".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuildDefinition</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuildDefinition</command:noun> <maml:description> <maml:para>Gets the build definitions for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamBuildDefinition function gets the build definitions for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> <maml:para>With just a project name, this function gets all of the build definitions for that team project.</maml:para> <maml:para>You can also specify a particular build definition by ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuildDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filters to definitions whose names equal this value. Append a * to filter to definitions whose names start with this value. For example: MS*</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more build definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Revision</maml:name> <maml:description> <maml:para>Specifies the specific revision number of the definition to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filters to definitions whose names equal this value. Append a * to filter to definitions whose names start with this value. For example: MS*</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more build definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Revision</maml:name> <maml:description> <maml:para>Specifies the specific revision number of the definition to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>-1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.BuildDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition -ProjectName Demo | Format-List *</dev:code> <dev:remarks> <maml:para>This command gets a list of all build definitions in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the build definition objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition -ProjectName Demo -id 2 -Json</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server formatted as a JSON string.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition -ProjectName Demo -id 2 -Raw</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuildLog</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuildLog</command:noun> <maml:description> <maml:para>Displays the logs for the build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays the logs for the build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuildLog</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Index</maml:name> <maml:description> <maml:para>Each task stores its logs in an array. If you know the index of a specific task you can return just its logs. If you do not provide a value all the logs are displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Index</maml:name> <maml:description> <maml:para>Each task stores its logs in an array. If you know the index of a specific task you can return just its logs. If you do not provide a value all the logs are displayed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuild -Top 1 | Get-VSTeamBuildLog</dev:code> <dev:remarks> <maml:para>This command displays the logs of the first build.</maml:para> <maml:para>The pipeline operator (|) passes the build id to the Get-VSTeamBuildLog cmdlet, which displays the logs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuildTag</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuildTag</command:noun> <maml:description> <maml:para>Returns all the tags of a build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all the tags of a build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuildTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTag -Id 101 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command retrieves all tags associated with the build having the ID 101 in the project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTag -Id 202 -ProjectName "DevOpsProject"</dev:code> <dev:remarks> <maml:para>In this example, all tags related to the build with the ID 202 within the "DevOpsProject" are fetched.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$builds = Get-VSTeamBuild -ProjectName "MyProject" $builds | ForEach-Object { Get-VSTeamBuildTag -Id $_.Id -ProjectName "MyProject" }</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve tags for all builds in the "MyProject". It first fetches all builds in the project and then iterates over each build to retrieve its tags.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTag -Id 303 -ProjectName "TestProject" | Where-Object { $_ -like "*release*" }</dev:code> <dev:remarks> <maml:para>This command fetches all tags of the build with ID 303 in the "TestProject" and then filters out tags that contain the word "release".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamBuildTimeline</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamBuildTimeline</command:noun> <maml:description> <maml:para>Get the timelines for builds</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamBuildTimeline function gets the timelines for a build.</maml:para> <maml:para>With just a project name and the build id, this function gets all the timelines of a build for that team project.</maml:para> <maml:para>You can also specify a particular timeline by ID to get .</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamBuildTimeline</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TimelineId"> <maml:name>TimelineId</maml:name> <maml:description> <maml:para>Returns the timelines with the given timeline id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ChangeId</maml:name> <maml:description> <maml:para>Returns the timelines with the given change id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Returns the timelines with the given plan id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TimelineId"> <maml:name>TimelineId</maml:name> <maml:description> <maml:para>Returns the timelines with the given timeline id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ChangeId</maml:name> <maml:description> <maml:para>Returns the timelines with the given change id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PlanId</maml:name> <maml:description> <maml:para>Returns the timelines with the given plan id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Build</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTimeline -ProjectName demo -Id 1 | Format-List *</dev:code> <dev:remarks> <maml:para>This command gets a list of all timelines of the build with Id 1 in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the timeline objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTimeline -ProjectName demo -Id 1 -TimelineId 595dac0c-0f1a-4bfd-a35f-e5a838ac71d7 -ChangeId 2 -PlanId 356de525-47a9-4251-80c6-d3849a9d6382</dev:code> <dev:remarks> <maml:para>This command gets the timelines with build Id 1 and timeline Id 595dac0c-0f1a-4bfd-a35f-e5a838ac71d7. It is filtered with the change ID and plan ID.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamBuildTimeline -ProjectName demo -Id 1 -TimelineId @(1,2)</dev:code> <dev:remarks> <maml:para>This command gets timelines with IDs 1 and 2 by using the ID parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamBuild | Get-VSTeamBuildTimeline -ProjectName demo</dev:code> <dev:remarks> <maml:para>This command gets timelines with build Ids from the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamBuild</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamBuild</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamClassificationNode</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamClassificationNode</command:noun> <maml:description> <maml:para>Gets the classification node for a given node path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the classification node for a given node path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamClassificationNode</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node, area or iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node, area or iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is the base function for Get-VSTeamArea and Get-VSTeamIteration.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamClassificationNode -StructureGroup "area" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command retrieves all area classification nodes for the specified project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamClassificationNode -StructureGroup "iteration" -Depth 2 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example fetches iteration classification nodes for the "MyProject" with a depth of 2 levels.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamClassificationNode -Path "MyNodePath" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This command retrieves the classification node associated with the specified node path "MyNodePath" within the "MyProject" project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamClassificationNode -Id 12345 -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>This example demonstrates how to retrieve the classification node in "MyProject" using a specific node ID (12345).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamCloudSubscription</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamCloudSubscription</command:noun> <maml:description> <maml:para>Gets the Azure subscriptions associated with the Team Services account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamCloudSubscription function gets the Azure subscriptions associated with the Team Services account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamCloudSubscription</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.AzureSubscription</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function currently is not supported in TFS.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamCloudSubscription</dev:code> <dev:remarks> <maml:para>This command gets a list of all Azure subscriptions associated with the Team Services account.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamDescriptor</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamDescriptor</command:noun> <maml:description> <maml:para>Resolve a storage key to a descriptor.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Resolve a storage key to a descriptor.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamDescriptor</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>StorageKey</maml:name> <maml:description> <maml:para>Storage key of the subject (user, group, scope, etc.) to resolve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>StorageKey</maml:name> <maml:description> <maml:para>Storage key of the subject (user, group, scope, etc.) to resolve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamDescriptor -StorageKey "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"</dev:code> <dev:remarks> <maml:para>This command retrieves the descriptor associated with the provided storage key.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>"a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" | Get-VSTeamDescriptor</dev:code> <dev:remarks> <maml:para>This example demonstrates how to pipe a storage key string directly to `Get-VSTeamDescriptor` to obtain the corresponding descriptor.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamExtension</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamExtension</command:noun> <maml:description> <maml:para>Get the installed extensions in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the installed extensions in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamExtension</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeInstallationIssues</maml:name> <maml:description> <maml:para>If true (the default), include installed extensions with issues.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDisabledExtensions</maml:name> <maml:description> <maml:para>If true (the default), include disabled extensions in the results.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeErrors</maml:name> <maml:description> <maml:para>If true, include installed extensions with errors.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeInstallationIssues</maml:name> <maml:description> <maml:para>If true (the default), include installed extensions with issues.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDisabledExtensions</maml:name> <maml:description> <maml:para>If true (the default), include disabled extensions in the results.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeErrors</maml:name> <maml:description> <maml:para>If true, include installed extensions with errors.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamExtension -PublisherId 'PublisherA' -ExtensionId 'Ext123'</dev:code> <dev:remarks> <maml:para>This command retrieves the details of the extension with the id 'Ext123' from the publisher with id 'PublisherA'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamExtension -IncludeInstallationIssues</dev:code> <dev:remarks> <maml:para>This command retrieves all installed extensions and includes those with installation issues in the results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamExtension -IncludeDisabledExtensions</dev:code> <dev:remarks> <maml:para>This command retrieves all installed extensions, including those that are currently disabled.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamExtension -IncludeErrors</dev:code> <dev:remarks> <maml:para>This command retrieves all installed extensions and includes those with errors in the results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamExtension | Where-Object { $_.PublisherId -eq 'PublisherA' }</dev:code> <dev:remarks> <maml:para>This command retrieves all installed extensions and then filters out to display only those from the publisher with id 'PublisherA'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamExtension</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamFeed</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamFeed</command:noun> <maml:description> <maml:para>Returns a list of package feeds for the account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-VSTeamFeed gets all the feeds for the account</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamFeed</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="FeedId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="FeedId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamFeed</dev:code> <dev:remarks> <maml:para>This command returns all the package feeds for the account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamFeed -ProjectName 'MyProject'</dev:code> <dev:remarks> <maml:para>This command returns all the package feeds for the project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamGitCommit</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamGitCommit</command:noun> <maml:description> <maml:para>Retrieve git commits for a project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamGitCommit function gets the commits for a git repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamGitCommit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created after this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created before this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromCommitId</maml:name> <maml:description> <maml:para>If provided, a lower bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToCommitId</maml:name> <maml:description> <maml:para>If provided, an upper bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Author</maml:name> <maml:description> <maml:para>Alias or display name of the author</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemPath</maml:name> <maml:description> <maml:para>Path of item to search under</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExcludeDeletes</maml:name> <maml:description> <maml:para>Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of entries to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Number of entries to skip</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Alias or display name of the committer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGitCommit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created after this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created before this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromCommitId</maml:name> <maml:description> <maml:para>If provided, a lower bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToCommitId</maml:name> <maml:description> <maml:para>If provided, an upper bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Author</maml:name> <maml:description> <maml:para>Alias or display name of the author</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of entries to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Number of entries to skip</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Alias or display name of the committer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGitCommit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created after this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created before this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromCommitId</maml:name> <maml:description> <maml:para>If provided, a lower bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToCommitId</maml:name> <maml:description> <maml:para>If provided, an upper bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Author</maml:name> <maml:description> <maml:para>Alias or display name of the author</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of entries to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Number of entries to skip</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Alias or display name of the committer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGitCommit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created after this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created before this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromCommitId</maml:name> <maml:description> <maml:para>If provided, a lower bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToCommitId</maml:name> <maml:description> <maml:para>If provided, an upper bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Author</maml:name> <maml:description> <maml:para>Alias or display name of the author</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemPath</maml:name> <maml:description> <maml:para>Path of item to search under</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExcludeDeletes</maml:name> <maml:description> <maml:para>Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of entries to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Number of entries to skip</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HistoryMode</maml:name> <maml:description> <maml:para>What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified. The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- fullHistory</maml:para> <maml:para>- fullHistorySimplifyMerges</maml:para> <maml:para>- simplifiedHistory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Alias or display name of the committer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGitCommit</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id or friendly name of the repository. To use the friendly name, projectId must also be specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created after this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToDate</maml:name> <maml:description> <maml:para>If provided, only include history entries created before this date (string)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. The acceptable values for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersion</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit). The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompareVersionVersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FromCommitId</maml:name> <maml:description> <maml:para>If provided, a lower bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ToCommitId</maml:name> <maml:description> <maml:para>If provided, an upper bound for filtering commits alphabetically</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Author</maml:name> <maml:description> <maml:para>Alias or display name of the author</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>If provided, specifies the exact commit ids of the commits to fetch. May not be combined with other parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ItemPath</maml:name> <maml:description> <maml:para>Path of item to search under</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExcludeDeletes</maml:name> <maml:description> <maml:para>Only applies when an itemPath is specified. This determines whether to exclude delete entries of the specified path.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of entries to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Number of entries to skip</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HistoryMode</maml:name> <maml:description> <maml:para>What Git history mode should be used. This only applies to the search criteria when Ids = null and an itemPath is specified. The acceptable values for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- fullHistory</maml:para> <maml:para>- fullHistorySimplifyMerges</maml:para> <maml:para>- simplifiedHistory</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Alias or display name of the committer</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>You can pipe a repository ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamGitCommit -ProjectName demo -RepositoryId 118C262F-0D4C-4B76-BD9B-7DD8CA12F196</dev:code> <dev:remarks> <maml:para>This command gets a list of all commits in the demo project for a specific repository.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamGitRepository | Select-Object -First 1 | Get-VSTeamGitCommit</dev:code> <dev:remarks> <maml:para>This command gets the Repository Id from the pipeline and the project name from the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamGitRef</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamGitRef</command:noun> <maml:description> <maml:para>Queries the provided repository for its refs and returns them.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-VSTeamGitRef gets all the refs for the provided repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamGitRef</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ID"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>A filter to apply to the refs (starts with).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FilterContains</maml:name> <maml:description> <maml:para>A filter to apply to the refs (contains). (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of refs to return. It cannot be bigger than 1000. If it is not provided but continuationToken is, top will default to 100. (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>The continuation token used for pagination. (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ID"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>A filter to apply to the refs (starts with).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FilterContains</maml:name> <maml:description> <maml:para>A filter to apply to the refs (contains). (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Maximum number of refs to return. It cannot be bigger than 1000. If it is not provided but continuationToken is, top will default to 100. (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>The continuation token used for pagination. (Azure DevOps Service and Azure DevOps Server 2019+ only)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamGitRepository -ProjectName Demo -Name Demo | Get-VSTeamGitRef</dev:code> <dev:remarks> <maml:para>This command returns all the Git refs for the Demo team project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamGitRepository</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamGitRepository</command:noun> <maml:description> <maml:para>Get all the repositories in your Azure DevOps or Team Foundation Server account, or a specific project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-VSTeamGitRepository gets all the repositories in your Azure DevOps or Team Foundation Server account, or a specific project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamGitRepository</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more repositories by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a repository, type Get-VSTeamGitRepository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGitRepository</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more repositories by name.</maml:para> <maml:para>To specify multiple names, use commas to separate the names.</maml:para> <maml:para>To find the name of a repository, type Get-VSTeamGitRepository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more repositories by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a repository, type Get-VSTeamGitRepository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies one or more repositories by name.</maml:para> <maml:para>To specify multiple names, use commas to separate the names.</maml:para> <maml:para>To find the name of a repository, type Get-VSTeamGitRepository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamGitRepository</dev:code> <dev:remarks> <maml:para>This command returns all the Git repositories for your TFS or Team Services account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamGitRepository -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command returns all the Git repositories for the Demo team project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>git clone (Get-VSTeamGitRepository | select -ExpandProperty remoteUrl)</dev:code> <dev:remarks> <maml:para>This command gets the remote URL and passes it to git clone command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamGitStat</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamGitStat</command:noun> <maml:description> <maml:para>Retrieves statistics about branches within a repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves statistics about branches within a repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamGitStat</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ID"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BranchName</maml:name> <maml:description> <maml:para>Name of the branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). Valid options for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. Valid options for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ID"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Specifies the ID of the repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>BranchName</maml:name> <maml:description> <maml:para>Name of the branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VersionOptions</maml:name> <maml:description> <maml:para>Version options - Specify additional modifiers to version (e.g Previous). Valid options for this parameter are:</maml:para> <maml:para>- firstParent</maml:para> <maml:para>- none</maml:para> <maml:para>- previousChange</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Version string identifier (name of tag/branch, SHA1 of commit)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>VersionType</maml:name> <maml:description> <maml:para>Version type (branch, tag, or commit). Determines how Id is interpreted. Valid options for this parameter are:</maml:para> <maml:para>- branch</maml:para> <maml:para>- commit</maml:para> <maml:para>- tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD</dev:code> <dev:remarks> <maml:para>This command returns all the Git stats for the entire repository</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD -BranchName develop</dev:code> <dev:remarks> <maml:para>This command returns all the Git stats for a specific branch</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamGitStat -ProjectName Demo -RepositoryId 011E421A-2A54-4491-B370-9256AD8A1BDD -BranchName develop -VersionType branch -Version 67cae2b029dff7eb3dc062b49403aaedca5bad8d</dev:code> <dev:remarks> <maml:para>This command returns all the Git stats for a specific commit</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamGroup</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamGroup</command:noun> <maml:description> <maml:para>Returns a Group or List of Groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a Group or List of Groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubjectTypes</maml:name> <maml:description> <maml:para>A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:</maml:para> <maml:para>- vssgp (Azure DevOps Group)</maml:para> <maml:para>- aadgp (Azure Active Directory Group)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ScopeDescriptor</maml:name> <maml:description> <maml:para>Specify a non-default scope (collection, project) to search for groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubjectTypes</maml:name> <maml:description> <maml:para>A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:</maml:para> <maml:para>- vssgp (Azure DevOps Group)</maml:para> <maml:para>- aadgp (Azure Active Directory Group)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the desired graph group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubjectTypes</maml:name> <maml:description> <maml:para>A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:</maml:para> <maml:para>- vssgp (Azure DevOps Group)</maml:para> <maml:para>- aadgp (Azure Active Directory Group)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ScopeDescriptor</maml:name> <maml:description> <maml:para>Specify a non-default scope (collection, project) to search for groups.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the desired graph group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators'</dev:code> <dev:remarks> <maml:para>Assigns Endpoint Administrators group to $group variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamInfo</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamInfo</command:noun> <maml:description> <maml:para>Displays your current account and default project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays your current account and default project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamInfo</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamInfo</dev:code> <dev:remarks> <maml:para>This will display your current account and default project</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamIteration</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamIteration</command:noun> <maml:description> <maml:para>Gets the iteration node for a given iteration path.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the iteration node for a given iteration path.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamIteration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>Depth of children to fetch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32</command:parameterValue> <dev:type> <maml:name>int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Integer classification nodes ids.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int32[]</command:parameterValue> <dev:type> <maml:name>int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Keep in mind that the `Get-VSTeamIteration` function is a wrapper for `Get-VSTeamClassificationNode` and will retrieve iteration nodes. If you need to retrieve areas or other classification nodes, you should use the `Get-VSTeamClassificationNode` function directly. Always ensure the correct path and project name are provided to get accurate results.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamIteration -Path '\ProjectX\Sprint1'</dev:code> <dev:remarks> <maml:para>This command returns the iteration node for the given iteration path '\ProjectX\Sprint1'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamIteration -Id 12345</dev:code> <dev:remarks> <maml:para>This command returns the iteration node for the given classification node id 12345.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamIteration -Path '\ProjectX\Sprint1' -Depth 2</dev:code> <dev:remarks> <maml:para>This command returns the iteration node for the given iteration path '\ProjectX\Sprint1' and fetches children up to a depth of 2.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamIteration -ProjectName 'ProjectX' | Where-Object { $_.Name -eq "Sprint1" }</dev:code> <dev:remarks> <maml:para>This command retrieves all iteration nodes from 'ProjectX' and then filters out to display only the node named "Sprint1".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamIteration -Path '\ProjectX\Sprint1' -ProjectName 'ProjectX'</dev:code> <dev:remarks> <maml:para>This command retrieves the iteration node with the path '\ProjectX\Sprint1' that is part of 'ProjectX'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamJobRequest</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamJobRequest</command:noun> <maml:description> <maml:para>Returns all the job requests of an agent.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all the job requests of an agent.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamJobRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>AgentId</maml:name> <maml:description> <maml:para>Id of the agent to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompletedRequestCount</maml:name> <maml:description> <maml:para>The number of requests to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>AgentId</maml:name> <maml:description> <maml:para>Id of the agent to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CompletedRequestCount</maml:name> <maml:description> <maml:para>The number of requests to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamJobRequest 1 111</dev:code> <dev:remarks> <maml:para>This will display all the job request of agent with id 111 under the pool with id 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamMember</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamMember</command:noun> <maml:description> <maml:para>Returns a team member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a team member.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="name"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The id of the team to search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases="name"> <maml:name>TeamId</maml:name> <maml:description> <maml:para>The id of the team to search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.TeamMember</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamMember -TeamId 'DevOpsTeam'</dev:code> <dev:remarks> <maml:para>Returns all members of the team with the id "DevOpsTeam".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamMember -TeamId 'DevOpsTeam' -Top 10</dev:code> <dev:remarks> <maml:para>Returns the top 10 members of the team with the id "DevOpsTeam".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamMember -TeamId 'DevOpsTeam' -Skip 5 -Top 10</dev:code> <dev:remarks> <maml:para>Skips the first 5 members and then returns the next 10 members of the team with the id "DevOpsTeam".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamMember -TeamId 'DevOpsTeam' | Where-Object { $_.DisplayName -like "*Smith*" }</dev:code> <dev:remarks> <maml:para>Returns members of the team with the id "DevOpsTeam" whose display name contains "Smith".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamMember -TeamId 'DevOpsTeam' -ProjectName 'ProjectX'</dev:code> <dev:remarks> <maml:para>Returns members of the team with the id "DevOpsTeam" that are part of 'ProjectX'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamMembership</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamMembership</command:noun> <maml:description> <maml:para>Gets a memberships for a container or member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a memberships for a container or member.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamUser | Select-Object -Last 1 | Get-VSTeamMembership | Get-VSTeamGroup</dev:code> <dev:remarks> <maml:para>Get all the groups for the last user</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamGroup | Select-Object -First 1 -Skip 2 | Get-VSTeamMembership | Get-VSTeamUser</dev:code> <dev:remarks> <maml:para>Get all the members for the third group</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VsTeamUser</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Test-VsTeamMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamOption</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamOption</command:noun> <maml:description> <maml:para>Returns all the versions of supported APIs of your TFS or AzD.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns all the versions of supported APIs of your TFS or AzD.</maml:para> <maml:para>There are two table formats defined for the vsteam_lib.Option type, Default and Versions.</maml:para> <maml:para>Default view contains Name, Area, Max Version and URI Template.</maml:para> <maml:para>Version view contains Name, Area, Min Version, Max Version, Released Version and Resource Version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamOption</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubDomain</maml:name> <maml:description> <maml:para>Returns options for that sub domain APIs. Some examples include:</maml:para> <maml:para>- vsaex = Member Entitlement Management</maml:para> <maml:para>- feeds = Artifacts</maml:para> <maml:para>- vsrm = Release Management</maml:para> <maml:para>- vssps = Graph</maml:para> <maml:para>- extmgmt = Extensions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Area</maml:name> <maml:description> <maml:para>Returns options for that area's APIs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Returns options for that resource's APIs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubDomain</maml:name> <maml:description> <maml:para>Returns options for that sub domain APIs. Some examples include:</maml:para> <maml:para>- vsaex = Member Entitlement Management</maml:para> <maml:para>- feeds = Artifacts</maml:para> <maml:para>- vsrm = Release Management</maml:para> <maml:para>- vssps = Graph</maml:para> <maml:para>- extmgmt = Extensions</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Area</maml:name> <maml:description> <maml:para>Returns options for that area's APIs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>Returns options for that resource's APIs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamOption</dev:code> <dev:remarks> <maml:para>This will display all the versions of supported APIs for your account using the 'Default' table format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamOption | Format-Table -View Versions</dev:code> <dev:remarks> <maml:para>This will display all the versions of supported APIs for your account using the 'Versions' custom table format.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamOption -SubDomain vsrm</dev:code> <dev:remarks> <maml:para>This will display all the versions of supported APIs for the release management service.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamOption -Area core</dev:code> <dev:remarks> <maml:para>This will display all the versions of supported APIs for the area core.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamOption -Area core -Resource teams</dev:code> <dev:remarks> <maml:para>This will display all the versions of supported APIs for resources teams under the area core.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPackage</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPackage</command:noun> <maml:description> <maml:para>Returns a list of packages for a feed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of packages for a feed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="id"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>The package Id (GUID Id, not the package name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeAllVersions</maml:name> <maml:description> <maml:para>Returns all versions of the package in the response. Default is latest version only.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return deleted or unpublished versions of packages in the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDescription</maml:name> <maml:description> <maml:para>Return the description for every version of each package in the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HideUrls</maml:name> <maml:description> <maml:para>Do not return REST Urls with the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeAllVersions</maml:name> <maml:description> <maml:para>Returns all versions of the package in the response. Default is latest version only.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return deleted or unpublished versions of packages in the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDescription</maml:name> <maml:description> <maml:para>Return the description for every version of each package in the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HideUrls</maml:name> <maml:description> <maml:para>Do not return REST Urls with the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:description> <maml:para>One of the supported artifact package types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PackageNameQuery</maml:name> <maml:description> <maml:para>Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skip the first N packages (or package versions when GetTopPackageVersions is set)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Get the top N packages (or package versions when GetTopPackageVersions is set)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="id"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>The package Id (GUID Id, not the package name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeAllVersions</maml:name> <maml:description> <maml:para>Returns all versions of the package in the response. Default is latest version only.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return deleted or unpublished versions of packages in the response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDescription</maml:name> <maml:description> <maml:para>Return the description for every version of each package in the response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HideUrls</maml:name> <maml:description> <maml:para>Do not return REST Urls with the response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProtocolType</maml:name> <maml:description> <maml:para>One of the supported artifact package types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PackageNameQuery</maml:name> <maml:description> <maml:para>Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skip the first N packages (or package versions when GetTopPackageVersions is set)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Get the top N packages (or package versions when GetTopPackageVersions is set)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------- Example 1: List all package and versions -----------</maml:title> <dev:code>Get-VSTeamFeed | Get-VSTeamPackage -includeAllVersions</dev:code> <dev:remarks> <maml:para>This command returns all the packages for all the feeds returned by Get-VSTeamFeed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: List only NuGet packages -------------</maml:title> <dev:code>Get-VSTeamFeed | Get-VSTeamPackage -protocolType NuGet</dev:code> <dev:remarks> <maml:para>This command only returns NuGet packages for all the feeds returned by Get-VSTeamFeed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------- Example 3: Return only the second package ----------</maml:title> <dev:code>Get-VSTeamPackage -feedName vsteam -Top 1 -Skip 1</dev:code> <dev:remarks> <maml:para>This command returns the second package from the feed named vsteam</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-- Example 4: Return only packages and versions from project --</maml:title> <dev:code>Get-VSTeamPackage -feedId 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d -projectName MyProject</dev:code> <dev:remarks> <maml:para>This command returns all the packages and versions for the feedId in the project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamFeed</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamFeed</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPackageVersion</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPackageVersion</command:noun> <maml:description> <maml:para>Returns a list of versions for a package.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of versions for a package.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPackageVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="id"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>The package Id (GUID Id, not the package name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HideUrls</maml:name> <maml:description> <maml:para>Do not return REST Urls with the response.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="id"> <maml:name>PackageId</maml:name> <maml:description> <maml:para>The package Id (GUID Id, not the package name).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">guid</command:parameterValue> <dev:type> <maml:name>guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>HideUrls</maml:name> <maml:description> <maml:para>Do not return REST Urls with the response.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>----------------- Example 1: Get from pipeline -----------------</maml:title> <dev:code>Get-VSTeamPackage vsteam -top 1 | Get-VSTeamPackageVersion</dev:code> <dev:remarks> <maml:para>This command returns all the versions for all the package returned by Get-VSTeamPackage.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Get using parameters ---------------</maml:title> <dev:code>$p = Get-VSTeamPackage vsteam -top 1 Get-VSTeamPackageVersion -feedId $($p.FeedId) -packageId $($p.Id)</dev:code> <dev:remarks> <maml:para>This command returns all the versions for the packageId.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----- Example 3: Get version from package in project feed -----</maml:title> <dev:code>Get-VSTeamPackageVersion -feedId 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d -packageId 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d -projectName MyProject</dev:code> <dev:remarks> <maml:para>This command returns all the versions for the packageId in the project feed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamFeed</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamFeed</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPermissionInheritance</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPermissionInheritance</command:noun> <maml:description> <maml:para>Undocumented API Returns true or false.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Undocumented API Returns true or false.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPermissionInheritance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the type of resource. The acceptable values for this parameter are:</maml:para> <maml:para>- Repository</maml:para> <maml:para>- BuildDefinition</maml:para> <maml:para>- ReleaseDefinition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the type of resource. The acceptable values for this parameter are:</maml:para> <maml:para>- Repository</maml:para> <maml:para>- BuildDefinition</maml:para> <maml:para>- ReleaseDefinition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPermissionInheritance -ProjectName Demo -Name Demo-CI -ResourceType BuildDefinition</dev:code> <dev:remarks> <maml:para>This command returns true or false.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition | Get-VSTeamPermissionInheritance</dev:code> <dev:remarks> <maml:para>This command returns true or false for every build definition returned from Get-VSTeamBuildDefinition.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPermissionInheritanceType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPermissionInheritanceType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPolicy</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPolicy</command:noun> <maml:description> <maml:para>Get the code policies in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the code policies in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one code policy by id.</maml:para> <maml:para>The id is an integer. Unique within each project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one code policy by id.</maml:para> <maml:para>The id is an integer. Unique within each project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPolicy -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command returns all the policies for the Demo project in your TFS or Team Services account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamPolicy -ProjectName Demo -Id 1</dev:code> <dev:remarks> <maml:para>This command gets the policy with an id of 1 within the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicyType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicyType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPolicyType</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPolicyType</command:noun> <maml:description> <maml:para>Get the policy types in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the policy types in the specified Azure DevOps or Team Foundation Server project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPolicyType</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one policy type by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one policy type by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPolicyType -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command returns all the policy types for the Demo project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamPolicyType -ProjectName Demo -Id 73da726a-8ff9-44d7-8caa-cbb581eac991</dev:code> <dev:remarks> <maml:para>This command gets the policy type by the specified id within the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicy</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPool</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPool</command:noun> <maml:description> <maml:para>Returns the agent pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the agent pools.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPool</dev:code> <dev:remarks> <maml:para>Returns a list of all agent pools.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamPool -Id 12345</dev:code> <dev:remarks> <maml:para>Returns the agent pool with the specified `Id` "12345".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamPool | Where-Object { $_.Name -eq "Default" }</dev:code> <dev:remarks> <maml:para>Returns the agent pool with the name "Default".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamPool | Sort-Object Name</dev:code> <dev:remarks> <maml:para>Returns all agent pools sorted by their name in ascending order.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamAccount</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamAccount</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamAccount</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamAccount</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamAccount</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamAccount</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamProcess</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamProcess</command:noun> <maml:description> <maml:para>Returns a list of process templates in the Team Services or Team Foundation Server account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The list of Process Templates can be filtered by name (which may include Wildcard). You can also get a single Process Template by id</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamProcess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the process template name for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available process templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProcessID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Process Template to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the process template name for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available process templates.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProcessID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Process Template to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamProcess</dev:code> <dev:remarks> <maml:para>This will return all the Process Templates</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamProcess | Format-Wide</dev:code> <dev:remarks> <maml:para>This will return the Process Templates only showing their name</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamProcess *scrum*</dev:code> <dev:remarks> <maml:para>This will return an process templates with names containing scrum, in other words, the default "Scrum" template and custom ones with names like "Custom Scrum", "Scrum for Contoso" will all be returned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamProfile</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamProfile</command:noun> <maml:description> <maml:para>Returns the saved profiles.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the saved profiles.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Optional name for the profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamProfile</dev:code> <dev:remarks> <maml:para>Return the list of saved profiles</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamProfile -Name mydemos</dev:code> <dev:remarks> <maml:para>Will return details of the profile provided</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProfile</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamProject</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamProject</command:noun> <maml:description> <maml:para>Returns a list of projects in the Team Services or Team Foundation Server account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The list of projects returned can be controlled by using the stateFilter, top and skip parameters.</maml:para> <maml:para>You can also get a single project by name or id.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StateFilter</maml:name> <maml:description> <maml:para>Returns team projects in a specific team project state. The acceptable values for this parameter are:</maml:para> <maml:para>- WellFormed</maml:para> <maml:para>- CreatePending</maml:para> <maml:para>- Deleting</maml:para> <maml:para>- New</maml:para> <maml:para>- All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WellFormed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Defines the number of team projects to skip. The default value is 0</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProjectID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeCapabilities</maml:name> <maml:description> <maml:para>Will return additional information about the project.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StateFilter</maml:name> <maml:description> <maml:para>Returns team projects in a specific team project state. The acceptable values for this parameter are:</maml:para> <maml:para>- WellFormed</maml:para> <maml:para>- CreatePending</maml:para> <maml:para>- Deleting</maml:para> <maml:para>- New</maml:para> <maml:para>- All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>WellFormed</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Defines the number of team projects to skip. The default value is 0</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProjectID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeCapabilities</maml:name> <maml:description> <maml:para>Will return additional information about the project.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>You can use PowerShell default values to set top to any value you like.</maml:para> <maml:para>$Global:PSDefaultParameterValues[" -vsteam :top"] = 500</maml:para> <maml:para>However, this function is called by the Project cache which is used by the project validation code. If the value of top is not high enough validation may fail. By default this function returns all projects.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamProject</dev:code> <dev:remarks> <maml:para>This will return all the WellFormed team projects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamProject -top 5 | Format-Wide</dev:code> <dev:remarks> <maml:para>This will return the top five WellFormed team projects only showing their name</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamProject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamPullRequest</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamPullRequest</command:noun> <maml:description> <maml:para>Returns one or more open pull requests from your team, project, or Id.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns one or more open pull requests from your team, project, or Id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamPullRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PullRequestId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the pull request by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The repository ID of the pull request's target branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamPullRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PullRequestId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the pull request by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The repository ID of the pull request's target branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeCommits</maml:name> <maml:description> <maml:para>If set, includes the commits that are part of the pull request. Requires the RepositoryId to be set.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamPullRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The repository ID of the pull request's target branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceRepositoryId</maml:name> <maml:description> <maml:para>If set, search for pull requests whose source branch is in this repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests from this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests into this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>If set, search for pull requests that are in this state. Defaults to Active if unset. Valid values for this parameter are:</maml:para> <maml:para>- abandoned</maml:para> <maml:para>- active</maml:para> <maml:para>- all</maml:para> <maml:para>- completed</maml:para> <maml:para>- notSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The number of pull requests to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamPullRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The repository ID of the pull request's target branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceRepositoryId</maml:name> <maml:description> <maml:para>If set, search for pull requests whose source branch is in this repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests from this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests into this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The number of pull requests to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PullRequestId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the pull request by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The repository ID of the pull request's target branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceRepositoryId</maml:name> <maml:description> <maml:para>If set, search for pull requests whose source branch is in this repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SourceBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests from this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TargetBranchRef</maml:name> <maml:description> <maml:para>If set, search for pull requests into this branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>If set, search for pull requests that are in this state. Defaults to Active if unset. Valid values for this parameter are:</maml:para> <maml:para>- abandoned</maml:para> <maml:para>- active</maml:para> <maml:para>- all</maml:para> <maml:para>- completed</maml:para> <maml:para>- notSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The number of pull requests to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of pull requests to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeCommits</maml:name> <maml:description> <maml:para>If set, includes the commits that are part of the pull request. Requires the RepositoryId to be set.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest</dev:code> <dev:remarks> <maml:para>This command returns all the open pull requests for your TFS or Team Services account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command returns all the open pull requests for the Demo team project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest -ProjectName Demo -All</dev:code> <dev:remarks> <maml:para>This command returns all pull requests for the Demo team project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest -ProjectName Demo -TargetBranchRef "refs/heads/mybranch"</dev:code> <dev:remarks> <maml:para>This command returns all open pull requests for a specific branch</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest -Id 123</dev:code> <dev:remarks> <maml:para>This command gets the pull request with an Id of 123.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Get-VSTeamPullRequest -Id 123 -RepositoryId "93BBA613-2729-4158-9217-751E952AB4AF" -IncludeCommits</dev:code> <dev:remarks> <maml:para>This command gets the pull request with an Id of 123 and includes the commits that are part of the pull request.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Show-VSTeamPullRequest</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Show-VSTeamPullRequest</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamPullRequest</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPullRequest</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamPullRequest</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamPullRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamQuery</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamQuery</command:noun> <maml:description> <maml:para>Gets the root queries and their children.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the root queries and their children.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamQuery</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>In the folder of queries, return child queries and folders to this depth.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- all</maml:para> <maml:para>- clauses</maml:para> <maml:para>- minimal</maml:para> <maml:para>- none</maml:para> <maml:para>- wiql</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Include deleted queries and folders</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Depth</maml:name> <maml:description> <maml:para>In the folder of queries, return child queries and folders to this depth.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- all</maml:para> <maml:para>- clauses</maml:para> <maml:para>- minimal</maml:para> <maml:para>- none</maml:para> <maml:para>- wiql</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Include deleted queries and folders</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>How much of the information returned about the query is expanded.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Query</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamQuery MyProject</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamQueue</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamQueue</command:noun> <maml:description> <maml:para>Gets a agent queue.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a agent queue.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamQueue</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ActionFilter</maml:name> <maml:description> <maml:para>None, Manage or Use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamQueue</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="QueueID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the queue to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueueName</maml:name> <maml:description> <maml:para>Name of the queue to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ActionFilter</maml:name> <maml:description> <maml:para>None, Manage or Use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="QueueID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the queue to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Queue</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamQueue -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Returns a list of all agent queues for the specified project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamQueue -QueueName "BuildQueue" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Returns the agent queue with the name "BuildQueue" for the specified project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamQueue -Id "12345" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Returns the agent queue with the specified `Id` "12345" for the project "MyProject".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamQueue -ActionFilter "Manage" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Returns the agent queues for the project "MyProject" where the action filter is set to "Manage".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Get-VSTeamQueue -ProjectName "MyProject" | Where-Object { $_.QueueName -like "*Test*" }</dev:code> <dev:remarks> <maml:para>Returns all agent queues for the project "MyProject" where the queue name contains the word "Test".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamRelease</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamRelease</command:noun> <maml:description> <maml:para>Gets the releases for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamRelease function gets the releases for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> <maml:para>With just a project name, this function gets all of the releases for that team project.</maml:para> <maml:para>You can also specify a particular release definition by ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamRelease</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies which property should be expanded in the list of Release (environments, artifacts, none).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>Draft, Active or Abandoned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DefinitionId</maml:name> <maml:description> <maml:para>Id of the release definition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Releases with names containing searchText.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ArtifactVersionId</maml:name> <maml:description> <maml:para>Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Creator of the release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MinCreatedTime</maml:name> <maml:description> <maml:para>Minimum creation time of releases to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCreatedTime</maml:name> <maml:description> <maml:para>Maximum creation time of releases to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Order of the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>ContinuationToken is used when retrieving more results than can be returned in one response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies which property should be expanded in the list of Release (environments, artifacts, none).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StatusFilter</maml:name> <maml:description> <maml:para>Draft, Active or Abandoned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DefinitionId</maml:name> <maml:description> <maml:para>Id of the release definition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SearchText</maml:name> <maml:description> <maml:para>Releases with names containing searchText.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ArtifactVersionId</maml:name> <maml:description> <maml:para>Releases with given artifactVersionId will be returned. E.g. in case of Build artifactType, it is buildId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>CreatedBy</maml:name> <maml:description> <maml:para>Creator of the release.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MinCreatedTime</maml:name> <maml:description> <maml:para>Minimum creation time of releases to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxCreatedTime</maml:name> <maml:description> <maml:para>Maximum creation time of releases to be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueryOrder</maml:name> <maml:description> <maml:para>Order of the results.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>ContinuationToken is used when retrieving more results than can be returned in one response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Release</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe release definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamRelease -ProjectName demo | Format-List *</dev:code> <dev:remarks> <maml:para>This command gets a list of all releases in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamRelease -ProjectName demo -Id 10 -Raw</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamRelease -ProjectName demo -Id 10 -Json</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server formatted as JSON.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamRelease -ProjectName demo -artifactVersionId 7</dev:code> <dev:remarks> <maml:para>This command returns the associated release for given Id. If the artifact type is a "Build" (Azure Pipelines) then it is the id of the build.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamRelease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamRelease</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamReleaseDefinition</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamReleaseDefinition</command:noun> <maml:description> <maml:para>Gets the release definitions for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-VSTeamReleaseDefinition function gets the release definitions for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> <maml:para>With just a project name, this function gets all of the release definitions for that team project.</maml:para> <maml:para>You can also specify a particular release definition by ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamReleaseDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies which property should be expanded in the list of Release Definition (environments, artifacts, none).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamReleaseDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more release definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamReleaseDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Specifies which property should be expanded in the list of Release Definition (environments, artifacts, none).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more release definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamReleaseDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the raw response into JSON and displays in the console. This is required when you need to use the object to send back. Without this switch the JSON produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Raw</maml:name> <maml:description> <maml:para>Returns the raw response. This is required when you need to use the object to send back. Without this switch the object produced from the returned object will not match the expected shape of the JSON for sending back to server.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Int[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.ReleaseDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamReleaseDefinition -ProjectName demo | Format-List *</dev:code> <dev:remarks> <maml:para>This command gets a list of all release definitions in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Format-List cmdlet, which displays all available properties (*) of the release definition objects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamReleaseDefinition -ProjectName Demo -id 2 -Json</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server formatted as a JSON string.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamReleaseDefinition -ProjectName Demo -id 2 -Raw</dev:code> <dev:remarks> <maml:para>This command returns the raw object returned from the server.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamResourceArea</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamResourceArea</command:noun> <maml:description> <maml:para>List all the areas supported by this instance of TFS/VSTS.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List all the areas supported by this instance of TFS/VSTS.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamResourceArea</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamResourceArea</dev:code> <dev:remarks> <maml:para>This will display all the areas of supported APIs for your account.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamSecurityNamespace</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamSecurityNamespace</command:noun> <maml:description> <maml:para>List all security namespaces or just the specified namespace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>List all security namespaces or just the specified namespace.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamSecurityNamespace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamSecurityNamespace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Security namespace name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamSecurityNamespace</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LocalOnly</maml:name> <maml:description> <maml:para>If true, retrieve only local security namespaces.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Security namespace name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LocalOnly</maml:name> <maml:description> <maml:para>If true, retrieve only local security namespaces.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamSecurityNamespace</dev:code> <dev:remarks> <maml:para>Returns a list of all security namespaces.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamSecurityNamespace -Id "abcdef12-1234-5678-9abc-def123456789"</dev:code> <dev:remarks> <maml:para>Returns the security namespace with the specified `Id`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamSecurityNamespace -Name "Project"</dev:code> <dev:remarks> <maml:para>Returns the security namespace with the name "Project".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamSecurityNamespace -LocalOnly</dev:code> <dev:remarks> <maml:para>Returns only the local security namespaces.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamServiceEndpoint</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamServiceEndpoint</command:noun> <maml:description> <maml:para>Gets a service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a service endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamServiceEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType</dev:code> <dev:remarks> <maml:para>Returns all available service endpoint types.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Type "AzureRM"</dev:code> <dev:remarks> <maml:para>Returns the service endpoint type with the name "AzureRM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Scheme "OAuth"</dev:code> <dev:remarks> <maml:para>Returns service endpoint types that use the "OAuth" scheme.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Type "GitHub" -Scheme "PersonalAccessToken"</dev:code> <dev:remarks> <maml:para>Returns the service endpoint type with the name "GitHub" and scheme "PersonalAccessToken".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamServiceEndpointType</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamServiceEndpointType</command:noun> <maml:description> <maml:para>Get service endpoint types.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get service endpoint types.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamServiceEndpointType</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Name of service endpoint type to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Scheme</maml:name> <maml:description> <maml:para>Scheme of service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>Name of service endpoint type to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Scheme</maml:name> <maml:description> <maml:para>Scheme of service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType</dev:code> <dev:remarks> <maml:para>Returns all available service endpoint types.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Type "AzureRM"</dev:code> <dev:remarks> <maml:para>Returns the service endpoint type with the name "AzureRM".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Scheme "OAuth"</dev:code> <dev:remarks> <maml:para>Returns service endpoint types that use the "OAuth" scheme.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamServiceEndpointType -Type "GitHub" -Scheme "PersonalAccessToken"</dev:code> <dev:remarks> <maml:para>Returns the service endpoint type with the name "GitHub" and scheme "PersonalAccessToken".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamTaskGroup</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamTaskGroup</command:noun> <maml:description> <maml:para>Gets a task group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a task group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamTaskGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamTaskGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" } Get-VSTeamTaskGroup @methodParameters</dev:code> <dev:remarks> <maml:para>Get all the task groups for the some_project_name project. Here we are splatting the parameter, but it may also be directly specified. See a non-splatting example below.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamTaskGroup -ProjectName "some_project_name" -Id "Task_group_id"</dev:code> <dev:remarks> <maml:para>Get a task group when the ID is already known.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "Task_group_name" } Get-VSTeamTaskGroup @methodParameters</dev:code> <dev:remarks> <maml:para>Get a task group by name, when the ID is not known. Here we are splatting the parameters, but they may also be directly specified. Getting by ID is preferred, as it's more efficient; but getting by name is, of course, handy.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamTaskGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamTfvcBranch</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamTfvcBranch</command:noun> <maml:description> <maml:para>Gets a branch for a given path from TFVC source control.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-VSTeamTfvcBranch gets a branch for a given path from TFVC source control.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamTfvcBranch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeChildren</maml:name> <maml:description> <maml:para>Return child branches, if there are any.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeParent</maml:name> <maml:description> <maml:para>Return the parent branch, if there is one.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return branches marked as deleted.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamTfvcBranch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to the branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeChildren</maml:name> <maml:description> <maml:para>Return child branches, if there are any.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeParent</maml:name> <maml:description> <maml:para>Return the parent branch, if there is one.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return branches marked as deleted.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Full path to the branch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeChildren</maml:name> <maml:description> <maml:para>Return child branches, if there are any.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeParent</maml:name> <maml:description> <maml:para>Return the parent branch, if there is one.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return branches marked as deleted.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>You can pipe paths to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch</dev:code> <dev:remarks> <maml:para>This command returns the branch object for the path $/MyProject/MyBranch</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeChildren</dev:code> <dev:remarks> <maml:para>This command returns the branch object for the path $/MyProject/MyBranch and its child branches.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeParent</dev:code> <dev:remarks> <maml:para>This command returns the branch object for the path $/MyProject/MyBranch and its parent.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcBranch -Path $/MyProject/MyBranch -IncludeDeleted</dev:code> <dev:remarks> <maml:para>This command returns the branch object for the path $/MyProject/MyBranch, even if it's marked as deleted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>'$/MyProject/MyBranch','$/AnotherProject/AnotherBranch' | Get-VSTeamTfvcBranch</dev:code> <dev:remarks> <maml:para>This command returns the branch objects for the paths $/MyProject/MyBranch and $/AnotherProject/AnotherBranch by using the pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcBranch -ProjectName TestProject</dev:code> <dev:remarks> <maml:para>This command returns all the branches under a project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamTfvcRootBranch</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamTfvcRootBranch</command:noun> <maml:description> <maml:para>Gets root branches for all projects with TFVC source control.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-VSTeamTfvcRootBranch gets root branches for all projects with TFVC source control.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamTfvcRootBranch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeChildren</maml:name> <maml:description> <maml:para>Return the child branches for each root branch.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return deleted branches.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeChildren</maml:name> <maml:description> <maml:para>Return the child branches for each root branch.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IncludeDeleted</maml:name> <maml:description> <maml:para>Return deleted branches.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcRootBranch</dev:code> <dev:remarks> <maml:para>This command returns root branches for all projects.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcRootBranch -IncludeChildren</dev:code> <dev:remarks> <maml:para>This command returns root branches for all projects and their respective child branches.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamTfvcRootBranch -IncludeDeleted</dev:code> <dev:remarks> <maml:para>This command returns root branches for all projects, also those marked as deleted.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamUser</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamUser</command:noun> <maml:description> <maml:para>Returns a list of users for the account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of users for the account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubjectTypes</maml:name> <maml:description> <maml:para>A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:</maml:para> <maml:para>- vss (Azure DevOps User)</maml:para> <maml:para>- aad (Azure Active Directory User)</maml:para> <maml:para>- svc (Azure DevOps Service Identity)</maml:para> <maml:para>- imp (Imported Identity)</maml:para> <maml:para>- msa (Microsoft Account)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the desired graph user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubjectTypes</maml:name> <maml:description> <maml:para>A comma separated list of user subject subtypes to reduce the retrieved results. Valid subject types:</maml:para> <maml:para>- vss (Azure DevOps User)</maml:para> <maml:para>- aad (Azure Active Directory User)</maml:para> <maml:para>- svc (Azure DevOps Service Identity)</maml:para> <maml:para>- imp (Imported Identity)</maml:para> <maml:para>- msa (Microsoft Account)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>The descriptor of the desired graph user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamUser</dev:code> <dev:remarks> <maml:para>Returns a list of all users for the account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamUser -SubjectTypes vss,msa</dev:code> <dev:remarks> <maml:para>Returns a list of users for the account filtered by the specified subject types: Azure DevOps User (vss) and Microsoft Account (msa).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamUser -Descriptor "vssA1B2C3D4E5F6"</dev:code> <dev:remarks> <maml:para>Returns the user with the specified descriptor "vssA1B2C3D4E5F6".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamUserEntitlement</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamUserEntitlement</command:noun> <maml:description> <maml:para>Get User Entitlement for a user, or a paged list of users matching the specified filter</maml:para> <maml:para>Please note that Filter, Name, UserType and License parameters only works when MemberEntitlementManagement module version is 6.0 or upper In the same way Top and Skip paramerers only works up to version 5.1</maml:para> <maml:para>You can setup the specific version for the MemberEntitlementManagement calling Set-VSTeamAPIVersion -Service MemberEntitlementManagement -Version VersionNumberYouNeed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get User Entitlement for a user, or a paged list of users matching the specified filter</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamUserEntitlement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are:</maml:para> <maml:para>- Projects</maml:para> <maml:para>- Extensions</maml:para> <maml:para>- GroupRules</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamUserEntitlement</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="UserId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are:</maml:para> <maml:para>- Projects</maml:para> <maml:para>- Extensions</maml:para> <maml:para>- GroupRules</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>User entlitement API returs a paged result. This parameter allows to limit the number of pages to be retrieved. Default is 0 = all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Equality operators relating to searching user entitlements seperated by and clauses. Valid filters include: licenseId, licenseStatus, userType, and name. - licenseId: filters based on license assignment using license names. i.e. licenseId eq 'Account-Stakeholder' or licenseId eq 'Account-Express'.</maml:para> <maml:para>- licenseStatus: filters based on license status. currently only supports disabled. i.e. licenseStatus eq 'Disabled'. To get disabled basic licenses, you would pass (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')</maml:para> <maml:para>- userType: filters off identity type. Suppored types are member or guest i.e. userType eq 'member'.</maml:para> <maml:para>- name: filters on if the user's display name or email contians given input. i.e. get all users with "test" in email or displayname is "name eq 'test'".</maml:para> <maml:para> </maml:para> <maml:para>A valid query could be: (licenseId eq 'Account-Stakeholder' or (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')) and name eq 'test' and userType eq 'guest'.</maml:para> <maml:para>Currently, filter names and values must match exactly the case. i.e.: * LicenseID will throw Invalid filter message.</maml:para> <maml:para>* licenseId eq 'account-stakeholder' will return an empty list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are:</maml:para> <maml:para>- Projects</maml:para> <maml:para>- Extensions</maml:para> <maml:para>- GroupRules</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>User entlitement API returs a paged result. This parameter allows to limit the number of pages to be retrieved. Default is 0 = all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Filters based on license assignment using license names</maml:para> <maml:para>The acceptable values for this parameter are: - Account-Stakeholder: Stakeholder</maml:para> <maml:para>- Account-Express: Basic</maml:para> <maml:para>- Account-Advanced: Basic + Test Plans</maml:para> <maml:para> </maml:para> <maml:para>Other licenses which source (licenseSource) is MSDN cannot be filtered here Parameter values are case sensitive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicenseId</maml:name> <maml:description> <maml:para>Filters based on license id.</maml:para> <maml:para>The acceptable values for this parameter are: - Account-Stakeholder (Stakeholder)</maml:para> <maml:para>- Account-Express (Basic)</maml:para> <maml:para>- Account-Advanced (Basic + Test Plans)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UserType</maml:name> <maml:description> <maml:para>Filters based on user type</maml:para> <maml:para>The acceptable values for this parameter are: - member</maml:para> <maml:para>- guest</maml:para> <maml:para> </maml:para> <maml:para>Parameter values are case sensitive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters on if the user's display name or email contains given input</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>The number of items to skip.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="UserId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>Specifies the maximum number to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Comma (",") separated list of properties to select in the result entitlements. The acceptable values for this parameter are:</maml:para> <maml:para>- Projects</maml:para> <maml:para>- Extensions</maml:para> <maml:para>- GroupRules</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>User entlitement API returs a paged result. This parameter allows to limit the number of pages to be retrieved. Default is 0 = all pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Equality operators relating to searching user entitlements seperated by and clauses. Valid filters include: licenseId, licenseStatus, userType, and name. - licenseId: filters based on license assignment using license names. i.e. licenseId eq 'Account-Stakeholder' or licenseId eq 'Account-Express'.</maml:para> <maml:para>- licenseStatus: filters based on license status. currently only supports disabled. i.e. licenseStatus eq 'Disabled'. To get disabled basic licenses, you would pass (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')</maml:para> <maml:para>- userType: filters off identity type. Suppored types are member or guest i.e. userType eq 'member'.</maml:para> <maml:para>- name: filters on if the user's display name or email contians given input. i.e. get all users with "test" in email or displayname is "name eq 'test'".</maml:para> <maml:para> </maml:para> <maml:para>A valid query could be: (licenseId eq 'Account-Stakeholder' or (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')) and name eq 'test' and userType eq 'guest'.</maml:para> <maml:para>Currently, filter names and values must match exactly the case. i.e.: * LicenseID will throw Invalid filter message.</maml:para> <maml:para>* licenseId eq 'account-stakeholder' will return an empty list</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Filters based on license assignment using license names</maml:para> <maml:para>The acceptable values for this parameter are: - Account-Stakeholder: Stakeholder</maml:para> <maml:para>- Account-Express: Basic</maml:para> <maml:para>- Account-Advanced: Basic + Test Plans</maml:para> <maml:para> </maml:para> <maml:para>Other licenses which source (licenseSource) is MSDN cannot be filtered here Parameter values are case sensitive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicenseId</maml:name> <maml:description> <maml:para>Filters based on license id.</maml:para> <maml:para>The acceptable values for this parameter are: - Account-Stakeholder (Stakeholder)</maml:para> <maml:para>- Account-Express (Basic)</maml:para> <maml:para>- Account-Advanced (Basic + Test Plans)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UserType</maml:name> <maml:description> <maml:para>Filters based on user type</maml:para> <maml:para>The acceptable values for this parameter are: - member</maml:para> <maml:para>- guest</maml:para> <maml:para> </maml:para> <maml:para>Parameter values are case sensitive</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Filters on if the user's display name or email contains given input</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------ Example 1: Get user by Id ------------------</maml:title> <dev:code>Get-VSTeamUserEntitlement -Id f1ef22eb-5dd6-4e26-907c-986a0311b106</dev:code> <dev:remarks> <maml:para>This command gets the user entitlement of the user identified by id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------- Example 2: Get users by name -----------------</maml:title> <dev:code>Get-VSTeamUserEntitlement -Name username</dev:code> <dev:remarks> <maml:para>This command gets a list of users which mail or user name contains 'username'. Filtering by Name, License, or UserType is available only when MemberEntitlementManagement service version is 6.0 or upper. See Get-VSTeamAPIVersion and Set-VSTeamAPIVersion commands</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------ Example 3: Filter with some conditions ------------</maml:title> <dev:code>Get-VSTeamUserEntitlement -Filter "licenseId eq 'Account-Express' and licenseStatus eq 'Disabled'"</dev:code> <dev:remarks> <maml:para>This command gets a list of users that match the license status and license type conditions. The -Filter parameter is available only when MemberEntitlementManagement service version is 6.0 or upper. See Get-VSTeamAPIVersion and Set-VSTeamAPIVersion commands</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------- Example 4: List paged users -----------------</maml:title> <dev:code>Get-VSTeamUserEntitlement -Skip 100 -Top 100</dev:code> <dev:remarks> <maml:para>This command list the from the user in the 101 position, the next 100 users Filtering using the -Top -Skip parameters only works when MemberEntitlementManagement service version is below 6.0. See Get-VSTeamAPIVersion and Set-VSTeamAPIVersion commands</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamUserProfile</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamUserProfile</command:noun> <maml:description> <maml:para>Gets the user profile of an account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the user profile of an account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamUserProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Gets the user profile with the given id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamUserProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MyProfile</maml:name> <maml:description> <maml:para>Gets all organizations where the user is the owner.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Gets the user profile with the given id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MyProfile</maml:name> <maml:description> <maml:para>Gets all organizations where the user is the owner.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- Example 1: Get user profile by id --------------</maml:title> <dev:code>$myProfile = Get-VSTeamUserProfile -Id f6e38832-6804-464f-9cf9-4aaa97327cfc</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------- Example 2: Get current users profile -------------</maml:title> <dev:code>$myProfile = Get-VSTeamUserProfile -MyProfile</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamPipelineBilling</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamPipelineBilling</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamVariableGroup</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamVariableGroup</command:noun> <maml:description> <maml:para>Gets a variable group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a variable group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" } Get-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Id = "variable_group_id" } Get-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "variable_group_name" } Get-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamVariableGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamWiki</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamWiki</command:noun> <maml:description> <maml:para>Returns a list of wikis for the selected project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of wikis in a project</maml:para> <maml:para>A single wiki can be returned by providing the wiki namd or Id</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="WikiName, WikiId"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name or ID of the Wiki to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="WikiName, WikiId"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name or ID of the Wiki to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamWiki</dev:code> <dev:remarks> <maml:para>This will return a list of all the wikis for all the projects</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamWiki -ProjectName myProject</dev:code> <dev:remarks> <maml:para>This will return all the wikis for the specified project</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamWiki -ProjectName myProject -WikiName my-code-wiki</dev:code> <dev:remarks> <maml:para>This will return the specified wiki in the project provided</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamWiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamWiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamWiql</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamWiql</command:noun> <maml:description> <maml:para>Returns work items from the given WIQL query or a saved query by ID from your projects team.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns work items from the given WIQL query or a saved query by ID from your projects team.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamWiql</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id query to return work items for. This is the ID of any saved query within a team in a project</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The max number of results to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Whether or not to use time precision.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>The expand the work items with the selected attributes in the WIQL query.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-VSTeamWiql</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Query</maml:name> <maml:description> <maml:para>The WIQL query. For the syntax check the official documentation (https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax?view=azure-devops).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The max number of results to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Whether or not to use time precision.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>The expand the work items with the selected attributes in the WIQL query.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id query to return work items for. This is the ID of any saved query within a team in a project</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Query</maml:name> <maml:description> <maml:para>The WIQL query. For the syntax check the official documentation (https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax?view=azure-devops).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>Team ID or team name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Top</maml:name> <maml:description> <maml:para>The max number of results to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TimePrecision</maml:name> <maml:description> <maml:para>Whether or not to use time precision.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>The expand the work items with the selected attributes in the WIQL query.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>If you do not set the default project by called Set-VSTeamDefaultProject you must pass in -ProjectName for the tab completion of names to work.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamWiql -Query "Select [System.Id], [System.Title], [System.State] From WorkItems" -Team "MyProject Team" -Project "MyProject" -Expand</dev:code> <dev:remarks> <maml:para>This command gets work items via a WIQL query and expands the return work items with only the selected fields System.Id, System.Title and System.State.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamWiql -Query "Select [System.Id], [System.Title], [System.State] From WorkItems" -Team "MyProject Team" -Project "MyProject"</dev:code> <dev:remarks> <maml:para>This command gets work items via a WIQL query and returns the WIQL query result with only work item IDs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamWorkItem</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamWorkItem</command:noun> <maml:description> <maml:para>Returns one or more a work items from your project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns one or more a work items from your project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamWorkItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of one or more work items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ErrorPolicy</maml:name> <maml:description> <maml:para>The flag to control error policy in a bulk get work items request. The acceptable values for this parameter are:</maml:para> <maml:para>- Fail</maml:para> <maml:para>- Omit</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>omit</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Comma-separated list of requested fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Comma-separated list of requested fields. The acceptable values for this parameter are:</maml:para> <maml:para>- None</maml:para> <maml:para>- Relations</maml:para> <maml:para>- Fields</maml:para> <maml:para>- Links</maml:para> <maml:para>- All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of one or more work items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ErrorPolicy</maml:name> <maml:description> <maml:para>The flag to control error policy in a bulk get work items request. The acceptable values for this parameter are:</maml:para> <maml:para>- Fail</maml:para> <maml:para>- Omit</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>omit</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Fields</maml:name> <maml:description> <maml:para>Comma-separated list of requested fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Expand</maml:name> <maml:description> <maml:para>Comma-separated list of requested fields. The acceptable values for this parameter are:</maml:para> <maml:para>- None</maml:para> <maml:para>- Relations</maml:para> <maml:para>- Fields</maml:para> <maml:para>- Links</maml:para> <maml:para>- All</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> <maml:para>WorkItemType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>WorkItemType is a dynamic parameter and use the default project value to query their validate set.</maml:para> <maml:para>If you do not set the default project by called Set-VSTeamDefaultProject you must provide -ProjectName or you will have to type in the names.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamWorkItem -Id 47,48</dev:code> <dev:remarks> <maml:para>This command gets work items with IDs 47 and 48 by using the IDs parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamWorkItemTag</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamWorkItemTag</command:noun> <maml:description> <maml:para>Gets a work item tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a list of work item tags in a project.</maml:para> <maml:para>A single tag can be returned by providing the tag name or id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamWorkItemTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TagName, TagId"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TagName, TagId"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamWorkItemTag</dev:code> <dev:remarks> <maml:para>This will return a list of all the work item tags within the current project</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamWorkItemTag -TagId my-tag</dev:code> <dev:remarks> <maml:para>This will return a specific work item tag</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamWorkItemTag -TagName my-tag</dev:code> <dev:remarks> <maml:para>This will return a specific work item tag</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-VSTeamWorkItemType</command:name> <command:verb>Get</command:verb> <command:noun>VSTeamWorkItemType</command:noun> <maml:description> <maml:para>Gets a list of all Work Item Types or a single work item type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a list of all Work Item Types or a single work item type.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-VSTeamWorkItemType</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>The type of work item to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkItemType</maml:name> <maml:description> <maml:para>The type of work item to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The JSON returned has empty named items i.e. "": "To Do" This causes issues with the ConvertFrom-Json CmdLet. Therefore, all "": are replaced with "_end":</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamWorkItemType -ProjectName test -WorkItemType 'Code Review Response'</dev:code> <dev:remarks> <maml:para>This command gets a single work item type.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-VSTeamRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>VSTeamRequest</command:noun> <maml:description> <maml:para>Allows you to call any TFS/AzD REST API. All the Auth and Route Structure is taken care of for you. Just provide the parts of the API call you need. If you need to send a non-standard URL use the -Url parameter. If the -Url is used the Url is not changed but the header and UserAgent are added for you.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke-VSTeamRequest allows you to call a TFS/AzD REST API much easier than using Invoke-WebRequest directly. The shape of the URI and authentication is all handled for you.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-VSTeamRequest</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Full api url without querystring. If this parameter is used the -Area, -Resource, -Version, and -SubDomain are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>Querystring to add to the end of the url. If this parameter is used the -Area, -Resource, -Version, and -SubDomain are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>The team name to find the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoProject</maml:name> <maml:description> <maml:para>Do not add the project name to the URI.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the request.</maml:para> <maml:para>If this parameter is omitted and the request method is POST, the content type will be set to application/json.</maml:para> <maml:para>Otherwise, the content type is not specified in the call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the method used for the request. The acceptable values for this parameter are:</maml:para> <maml:para>- Get</maml:para> <maml:para>- Post</maml:para> <maml:para>- Patch</maml:para> <maml:para>- Delete</maml:para> <maml:para>- Options</maml:para> <maml:para>- Put</maml:para> <maml:para>- Default</maml:para> <maml:para>- Trace</maml:para> <maml:para>- Head</maml:para> <maml:para>- Merge</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>Specifies the body of the request. The body is the content of the request that follows the headers.</maml:para> <maml:para>You can pipe a body value to Invoke-VSTeamRequest.</maml:para> <maml:para>The Body parameter can be used to specify a list of query parameters or specify the content of the response.</maml:para> <maml:para>When the input is a GET request and the body is an IDictionary (typically, a hash table), the body is added to the URI as query parameters. For other GET requests, the body is set as the value of the request body in the standard name=value format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the file that contains the contents of the request. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Specifies the output file for which this function saves the response body. Enter a path and file name. If you omit the path, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Area</maml:name> <maml:description> <maml:para>The area to find the resource. You can tab complete this value. It can be filtered by passing -subDomain first.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The name of the feature you want to manipulate. You can tab complete this value if you pass -Area before this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique value of the item you want to work with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the API you wish to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubDomain</maml:name> <maml:description> <maml:para>The SubDomain before .dev.azure.com. For example, to target Release Management you must use the SubDomain vsrm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the PowerShell object into JSON and displays in the console.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalHeaders</maml:name> <maml:description> <maml:para>Adds additional headers to the request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseProjectId</maml:name> <maml:description> <maml:para>Converts the project name to project id before building the URI for the REST API call.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Url</maml:name> <maml:description> <maml:para>Full api url without querystring. If this parameter is used the -Area, -Resource, -Version, and -SubDomain are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>QueryString</maml:name> <maml:description> <maml:para>Querystring to add to the end of the url. If this parameter is used the -Area, -Resource, -Version, and -SubDomain are ignored.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Team</maml:name> <maml:description> <maml:para>The team name to find the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoProject</maml:name> <maml:description> <maml:para>Do not add the project name to the URI.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ContentType</maml:name> <maml:description> <maml:para>Specifies the content type of the request.</maml:para> <maml:para>If this parameter is omitted and the request method is POST, the content type will be set to application/json.</maml:para> <maml:para>Otherwise, the content type is not specified in the call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>application/json</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Method</maml:name> <maml:description> <maml:para>Specifies the method used for the request. The acceptable values for this parameter are:</maml:para> <maml:para>- Get</maml:para> <maml:para>- Post</maml:para> <maml:para>- Patch</maml:para> <maml:para>- Delete</maml:para> <maml:para>- Options</maml:para> <maml:para>- Put</maml:para> <maml:para>- Default</maml:para> <maml:para>- Trace</maml:para> <maml:para>- Head</maml:para> <maml:para>- Merge</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Get</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>Specifies the body of the request. The body is the content of the request that follows the headers.</maml:para> <maml:para>You can pipe a body value to Invoke-VSTeamRequest.</maml:para> <maml:para>The Body parameter can be used to specify a list of query parameters or specify the content of the response.</maml:para> <maml:para>When the input is a GET request and the body is an IDictionary (typically, a hash table), the body is added to the URI as query parameters. For other GET requests, the body is set as the value of the request body in the standard name=value format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the file that contains the contents of the request. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OutFile</maml:name> <maml:description> <maml:para>Specifies the output file for which this function saves the response body. Enter a path and file name. If you omit the path, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Area</maml:name> <maml:description> <maml:para>The area to find the resource. You can tab complete this value. It can be filtered by passing -subDomain first.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The name of the feature you want to manipulate. You can tab complete this value if you pass -Area before this parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique value of the item you want to work with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>The version of the API you wish to target.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SubDomain</maml:name> <maml:description> <maml:para>The SubDomain before .dev.azure.com. For example, to target Release Management you must use the SubDomain vsrm.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>JSON</maml:name> <maml:description> <maml:para>Converts the PowerShell object into JSON and displays in the console.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalHeaders</maml:name> <maml:description> <maml:para>Adds additional headers to the request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseProjectId</maml:name> <maml:description> <maml:para>Converts the project name to project id before building the URI for the REST API call.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Invoke-VSTeamRequest -resource projectHistory -version '4.1-preview' -Verbose</dev:code> <dev:remarks> <maml:para>This command will return the project history.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>ivr -area release -resource releases -version '4.1-preview' -subDomain vsrm -Verbose</dev:code> <dev:remarks> <maml:para>This command will return the releases for a project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeam</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeam</command:noun> <maml:description> <maml:para>Removes a team from a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a team from a project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name, TeamId, TeamName"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the team to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Name, TeamId, TeamName"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the team to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>---------------- Example 1: Remove second team ----------------</maml:title> <dev:code>Set-DefaultProject Test Get-VSTeam | Select-Object -First 1 -Skip 1 | Remove-VSTeam</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>---------------- Example 2: Remove team by name ----------------</maml:title> <dev:code>Remove-VSTeam LastTeam -ProjectName Test -Force</dev:code> <dev:remarks> <maml:para>This command removes the team named 'LastTeam'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>----------------- Example 2: Remove team by id -----------------</maml:title> <dev:code>Remove-VSTeam -Id 30246aee-95f8-45cc-9552-bceff1921a40 -Force</dev:code> <dev:remarks> <maml:para>This command removes the team with id 30246aee-95f8-45cc-9552-bceff1921a40.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamAccessControlEntry</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamAccessControlEntry</command:noun> <maml:description> <maml:para>Removes specified ACEs in the ACL for the provided token. The request URI contains the namespace ID, the target token, and a single or list of descriptors that should be removed. Only supports removing AzD based users/groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes specified ACEs in the ACL for the provided token. The request URI contains the namespace ID, the target token, and a single or list of descriptors that should be removed. Only supports removing AzD based users/groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamAccessControlEntry</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> <maml:para>Valid token formats are:</maml:para> <maml:para>- Git Repository (repov2/$projectID/$repositoryID)</maml:para> <maml:para>- Build Definition ($projectID/$buildDefinitionID)</maml:para> <maml:para>- Release Definition ($projectID/$releaseDefinitionID, $projectID/Path/to/Release/$releaseDefinitionID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>An array of descriptors of users/groups to be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Array</command:parameterValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VSTeamAccessControlEntry</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> <maml:para>Valid IDs are:</maml:para> <maml:para>AzD:</maml:para> <maml:para>- Analytics (58450c49-b02d-465a-ab12-59ae512d6531)</maml:para> <maml:para>- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba)</maml:para> <maml:para>- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd)</maml:para> <maml:para>- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de)</maml:para> <maml:para>- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866)</maml:para> <maml:para>- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f)</maml:para> <maml:para>- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba)</maml:para> <maml:para>- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680)</maml:para> <maml:para>- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87)</maml:para> <maml:para>- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e)</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f)</maml:para> <maml:para>- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23)</maml:para> <maml:para>- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c)</maml:para> <maml:para>- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046)</maml:para> <maml:para>- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18)</maml:para> <maml:para>- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7)</maml:para> <maml:para>- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb)</maml:para> <maml:para>- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8)</maml:para> <maml:para>- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02)</maml:para> <maml:para>- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4)</maml:para> <maml:para>- Library (b7e84409-6553-448a-bbb2-af228e07cbeb)</maml:para> <maml:para>- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20)</maml:para> <maml:para>- Project (52d39943-cb85-4d7f-8fa8-c6baac873819)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b)</maml:para> <maml:para>- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3)</maml:para> <maml:para>- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1)</maml:para> <maml:para>- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67)</maml:para> <maml:para>- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2)</maml:para> <maml:para>- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436)</maml:para> <maml:para>- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1)</maml:para> <maml:para>- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e)</maml:para> <maml:para>- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999)</maml:para> <maml:para>- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400)</maml:para> <maml:para>- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418)</maml:para> <maml:para>- BuildAdministration (302acaca-b667-436d-a946-87133492041c)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f)</maml:para> <maml:para>- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e)</maml:para> <maml:para>- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d)</maml:para> <maml:para>- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6)</maml:para> <maml:para>- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3)</maml:para> <maml:para>- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c)</maml:para> <maml:para>- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63)</maml:para> <maml:para>- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0)</maml:para> <maml:para>- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12)</maml:para> <maml:para>- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956)</maml:para> <maml:para>- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729)</maml:para> <maml:para>- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9)</maml:para> <maml:para>- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7)</maml:para> <maml:para>- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052)</maml:para> <maml:para> </maml:para> <maml:para>VSSPS:</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS)</maml:para> <maml:para>- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS)</maml:para> <maml:para>- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS)</maml:para> <maml:para>- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS)</maml:para> <maml:para>- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS)</maml:para> <maml:para>- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> <maml:para>Valid token formats are:</maml:para> <maml:para>- Git Repository (repov2/$projectID/$repositoryID)</maml:para> <maml:para>- Build Definition ($projectID/$buildDefinitionID)</maml:para> <maml:para>- Release Definition ($projectID/$releaseDefinitionID, $projectID/Path/to/Release/$releaseDefinitionID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>An array of descriptors of users/groups to be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Array</command:parameterValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> <maml:para>Valid IDs are:</maml:para> <maml:para>AzD:</maml:para> <maml:para>- Analytics (58450c49-b02d-465a-ab12-59ae512d6531)</maml:para> <maml:para>- AnalyticsViews (d34d3680-dfe5-4cc6-a949-7d9c68f73cba)</maml:para> <maml:para>- ReleaseManagement (7c7d32f7-0e86-4cd6-892e-b35dbba870bd)</maml:para> <maml:para>- ReleaseManagement2 (c788c23e-1b46-4162-8f5e-d7585343b5de)</maml:para> <maml:para>- Identity (5a27515b-ccd7-42c9-84f1-54c998f03866)</maml:para> <maml:para>- WorkItemTrackingAdministration (445d2788-c5fb-4132-bbef-09c4045ad93f)</maml:para> <maml:para>- DistributedTask (101eae8c-1709-47f9-b228-0e476c35b3ba)</maml:para> <maml:para>- WorkItemQueryFolders (71356614-aad7-4757-8f2c-0fb3bff6f680)</maml:para> <maml:para>- GitRepositories (2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87)</maml:para> <maml:para>- VersionControlItems2 (3c15a8b7-af1a-45c2-aa97-2cb97078332e)</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f)</maml:para> <maml:para>- WorkItemTrackingProvision (5a6cd233-6615-414d-9393-48dbb252bd23)</maml:para> <maml:para>- ServiceEndpoints (49b48001-ca20-4adc-8111-5b60c903a50c)</maml:para> <maml:para>- ServiceHooks (cb594ebe-87dd-4fc9-ac2c-6a10a4c92046)</maml:para> <maml:para>- Chat (bc295513-b1a2-4663-8d1a-7017fd760d18)</maml:para> <maml:para>- Collection (3e65f728-f8bc-4ecd-8764-7e378b19bfa7)</maml:para> <maml:para>- Proxy (cb4d56d2-e84b-457e-8845-81320a133fbb)</maml:para> <maml:para>- Plan (bed337f8-e5f3-4fb9-80da-81e17d06e7a8)</maml:para> <maml:para>- Process (2dab47f9-bd70-49ed-9bd5-8eb051e59c02)</maml:para> <maml:para>- AccountAdminSecurity (11238e09-49f2-40c7-94d0-8f0307204ce4)</maml:para> <maml:para>- Library (b7e84409-6553-448a-bbb2-af228e07cbeb)</maml:para> <maml:para>- Environment (83d4c2e6-e57d-4d6e-892b-b87222b7ad20)</maml:para> <maml:para>- Project (52d39943-cb85-4d7f-8fa8-c6baac873819)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b)</maml:para> <maml:para>- CSS (83e28ad4-2d72-4ceb-97b0-c7726d5502c3)</maml:para> <maml:para>- TeamLabSecurity (9e4894c3-ff9a-4eac-8a85-ce11cafdc6f1)</maml:para> <maml:para>- ProjectAnalysisLanguageMetrics (fc5b7b85-5d6b-41eb-8534-e128cb10eb67)</maml:para> <maml:para>- Tagging (bb50f182-8e5e-40b8-bc21-e8752a1e7ae2)</maml:para> <maml:para>- MetaTask (f6a4de49-dbe2-4704-86dc-f8ec1a294436)</maml:para> <maml:para>- Iteration (bf7bfa03-b2b7-47db-8113-fa2e002cc5b1)</maml:para> <maml:para>- Favorites (fa557b48-b5bf-458a-bb2b-1b680426fe8b)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e)</maml:para> <maml:para>- ViewActivityPaneSecurity (dc02bf3d-cd48-46c3-8a41-345094ecc94b)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999)</maml:para> <maml:para>- WorkItemTracking (73e71c45-d483-40d5-bdba-62fd076f7f87)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400)</maml:para> <maml:para>- TestManagement (e06e1c24-e93d-4e4a-908a-7d951187b483)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418)</maml:para> <maml:para>- BuildAdministration (302acaca-b667-436d-a946-87133492041c)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f)</maml:para> <maml:para>- Boards (251e12d9-bea3-43a8-bfdb-901b98c0125e)</maml:para> <maml:para>- UtilizationPermissions (83abde3a-4593-424e-b45f-9898af99034d)</maml:para> <maml:para>- WorkItemsHub (c0e7a722-1cad-4ae6-b340-a8467501e7ce)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6)</maml:para> <maml:para>- VersionControlPrivileges (66312704-deb5-43f9-b51c-ab4ff5e351c3)</maml:para> <maml:para>- Workspaces (93bafc04-9075-403a-9367-b7164eac6b5c)</maml:para> <maml:para>- CrossProjectWidgetView (093cbb02-722b-4ad6-9f88-bc452043fa63)</maml:para> <maml:para>- WorkItemTrackingConfiguration (35e35e8e-686d-4b01-aff6-c369d6e36ce0)</maml:para> <maml:para>- Discussion Threads (0d140cae-8ac1-4f48-b6d1-c93ce0301a12)</maml:para> <maml:para>- BoardsExternalIntegration (5ab15bc8-4ea1-d0f3-8344-cab8fe976877)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956)</maml:para> <maml:para>- Social (81c27cc8-7a9f-48ee-b63f-df1e1d0412dd)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729)</maml:para> <maml:para>- Build (33344d9c-fc72-4d6f-aba5-fa317101a7e9)</maml:para> <maml:para>- DashboardsPrivileges (8adf73b7-389a-4276-b638-fe1653f7efc7)</maml:para> <maml:para>- VersionControlItems (a39371cf-0841-4c16-bbd3-276e341bc052)</maml:para> <maml:para> </maml:para> <maml:para>VSSPS:</maml:para> <maml:para>- EventSubscriber (2bf24a2b-70ba-43d3-ad97-3d9e1f75622f) (VSSPS)</maml:para> <maml:para>- EventSubscription (58b176e7-3411-457a-89d0-c6d0ccb3c52b) (VSSPS)</maml:para> <maml:para>- Registry (4ae0db5d-8437-4ee8-a18b-1f6fb38bd34c) (VSSPS)</maml:para> <maml:para>- Graph (c2ee56c9-e8fa-4cdd-9d48-2c44f697a58e) (VSSPS)</maml:para> <maml:para>- Invitation (ea0b4d1e-577a-4797-97b5-2f5755e548d5) (VSSPS)</maml:para> <maml:para>- SystemGraph (b24dfdf1-285a-4ea6-a55b-32549a68121d) (VSSPS)</maml:para> <maml:para>- Job (2a887f97-db68-4b7c-9ae3-5cebd7add999) (VSSPS)</maml:para> <maml:para>- CommerceCollectionSecurity (307be2d3-12ed-45c2-aacf-6598760efca7) (VSSPS)</maml:para> <maml:para>- StrongBox (4a9e8381-289a-4dfd-8460-69028eaa93b3) (VSSPS)</maml:para> <maml:para>- GroupLicensing (c6a4fd35-b508-49eb-8ea7-7189df5f3698) (VSSPS)</maml:para> <maml:para>- Server (1f4179b3-6bac-4d01-b421-71ea09171400) (VSSPS)</maml:para> <maml:para>- SettingEntries (6ec4592e-048c-434e-8e6c-8671753a8418) (VSSPS)</maml:para> <maml:para>- RemotableTemplateTest (ccdcb71c-4780-4a42-9bb4-8bce07a7628f) (VSSPS)</maml:para> <maml:para>- Location (2725d2bc-7520-4af4-b0e3-8d876494731f) (VSSPS)</maml:para> <maml:para>- WebPlatform (0582eb05-c896-449a-b933-aa3d99e121d6) (VSSPS)</maml:para> <maml:para>- DataProvider (7ffa7cf4-317c-4fea-8f1d-cfda50cfa956) (VSSPS)</maml:para> <maml:para>- Security (9a82c708-bfbe-4f31-984c-e860c2196781) (VSSPS)</maml:para> <maml:para>- IdentityPicker (a60e0d84-c2f8-48e4-9c0c-f32da48d5fd1) (VSSPS)</maml:para> <maml:para>- ServicingOrchestration (84cc1aa4-15bc-423d-90d9-f97c450fc729) (VSSPS)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Token</maml:name> <maml:description> <maml:para>The security Token</maml:para> <maml:para>Valid token formats are:</maml:para> <maml:para>- Git Repository (repov2/$projectID/$repositoryID)</maml:para> <maml:para>- Build Definition ($projectID/$buildDefinitionID)</maml:para> <maml:para>- Release Definition ($projectID/$releaseDefinitionID, $projectID/Path/to/Release/$releaseDefinitionID)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>An array of descriptors of users/groups to be removed</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Array</command:parameterValue> <dev:type> <maml:name>System.Array</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This function outputs a non-terminating error if the ACE removal from the ACL returns $False. This can be due to the wrong descriptor being provided, or the descriptor already not being on the ACL.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespaceId "2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87" -token "repov2/$projectid/$repoid" -descriptor @("vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzk4ODc2NjMwLTEwMTQ0ODQ4MTMtMzE5MDA4NTI4Ny0xNDU4NTkwODY1LTEtMzE1MjE3NTkwMy03NjE1NjY3OTMtMjgwMTUwMjI2Ny0zMjU5Mjg5MTIy")</dev:code> <dev:remarks> <maml:para>This will remove the specified descriptor from the specified repository, using the security namespace id, while confirming for the remove action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespaceId "2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87" -token "repov2/$projectid/$repoid" -descriptor @("vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzk4ODc2NjMwLTEwMTQ0ODQ4MTMtMzE5MDA4NTI4Ny0xNDU4NTkwODY1LTEtMzE1MjE3NTkwMy03NjE1NjY3OTMtMjgwMTUwMjI2Ny0zMjU5Mjg5MTIy") -force</dev:code> <dev:remarks> <maml:para>This will remove the specified descriptor from the specified repository, using the security namespace id, with no confirmation for the remove action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespaceId "2e9eb7ed-3c0a-47d4-87c1-0ffdd275fd87" -token "repov2/$projectid/$repoid" -descriptor @("descriptor1","descriptor2")</dev:code> <dev:remarks> <maml:para>This will remove multiple descriptors from the specified repository, using the security namespace id, while confirming for the remove action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespace [vsteam_lib.SecurityNamespace]$securityNamespace -token "repov2/$projectid/$repoid" -descriptor @("vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzk4ODc2NjMwLTEwMTQ0ODQ4MTMtMzE5MDA4NTI4Ny0xNDU4NTkwODY1LTEtMzE1MjE3NTkwMy03NjE1NjY3OTMtMjgwMTUwMjI2Ny0zMjU5Mjg5MTIy")</dev:code> <dev:remarks> <maml:para>This will remove the specified descriptor from the specified repository, using a security namespace object, while confirming for the remove action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespace [vsteam_lib.SecurityNamespace]$securityNamespace -token "repov2/$projectid/$repoid" -descriptor @("vssgp.Uy0xLTktMTU1MTM3NDI0NS0xMzk4ODc2NjMwLTEwMTQ0ODQ4MTMtMzE5MDA4NTI4Ny0xNDU4NTkwODY1LTEtMzE1MjE3NTkwMy03NjE1NjY3OTMtMjgwMTUwMjI2Ny0zMjU5Mjg5MTIy") -force</dev:code> <dev:remarks> <maml:para>This will remove the specified descriptor from the specified repository, using a security namespace object, with no confirmation for the remove action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlEntry -securityNamespace [vsteam_lib.SecurityNamespace]$securityNamespace -token "repov2/$projectid/$repoid" -descriptor @("descriptor1","descriptor2")</dev:code> <dev:remarks> <maml:para>This will remove multiple descriptors from the specified repository, using a security namespace object, while confirming for the remove action.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamAccessControlList</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamAccessControlList</command:noun> <maml:description> <maml:para>Remove access control lists under the specified security namespace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove access control lists under the specified security namespace.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamAccessControlList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tokens</maml:name> <maml:description> <maml:para>One or more comma-separated security tokens</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VSTeamAccessControlList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tokens</maml:name> <maml:description> <maml:para>One or more comma-separated security tokens</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespace</maml:name> <maml:description> <maml:para>Security namespace object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.SecurityNamespace</command:parameterValue> <dev:type> <maml:name>vsteam_lib.SecurityNamespace</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurityNamespaceId</maml:name> <maml:description> <maml:para>Security namespace identifier.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Tokens</maml:name> <maml:description> <maml:para>One or more comma-separated security tokens</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Recurse</maml:name> <maml:description> <maml:para>If true and this is a hierarchical namespace, also remove child ACLs of the specified tokens.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$namespace = Get-VSTeamSecurityNamespace -NamespaceId "abcdef12-1234-5678-9abc-def123456789" Remove-VSTeamAccessControlList -SecurityNamespace $namespace -Tokens "token1,token2"</dev:code> <dev:remarks> <maml:para>Removes access control lists for the specified tokens "token1" and "token2" from the security namespace retrieved using the provided `NamespaceId`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Recurse</dev:code> <dev:remarks> <maml:para>Recursively removes the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Force</dev:code> <dev:remarks> <maml:para>Removes the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId` and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Remove-VSTeamAccessControlList -SecurityNamespaceId "abcdef12-1234-5678-9abc-def123456789" -Tokens "token1" -Recurse -WhatIf</dev:code> <dev:remarks> <maml:para>Shows what would happen if the command runs to recursively remove the access control list for the specified token "token1" from the security namespace with the given `SecurityNamespaceId`, without actually executing the command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamAccount</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamAccount</command:noun> <maml:description> <maml:para>Clears your default project, account name and personal access token.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the environment variables that hold your default project, account, bearer token and personal access token. You have to run Set-VSTeamAccount again before calling any other functions.</maml:para> <maml:para>To remove from the Machine level you must be running PowerShell as administrator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamAccount</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your account information at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to clear your account information at the Process, User or Machine levels.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamAccount</dev:code> <dev:remarks> <maml:para>This will clear your account name and personal access token.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamAgent</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamAgent</command:noun> <maml:description> <maml:para>Removes an agent from a pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an agent from a pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamAgent -PoolId 101 -Id 2021</dev:code> <dev:remarks> <maml:para>Removes the agent with ID `2021` from the pool with ID `101`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$agentIds = 2021, 2022, 2023 Remove-VSTeamAgent -PoolId 101 -Id $agentIds</dev:code> <dev:remarks> <maml:para>Removes multiple agents with IDs `2021`, `2022`, and `2023` from the pool with ID `101`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamAgent -PoolId 101 -Id 2021 -Force</dev:code> <dev:remarks> <maml:para>Removes the agent with ID `2021` from the pool with ID `101` and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamArea</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamArea</command:noun> <maml:description> <maml:para>Removes an existing area from the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an existing area from the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamArea</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the area node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="NodeId"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of an area where work items should be reassigned to if they are currently assigned to the area being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the area node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="NodeId"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of an area where work items should be reassigned to if they are currently assigned to the area being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Remove-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamArea -ProjectName "Demo" -Path "\MyArea\Path" -ReClassifyId 19</dev:code> <dev:remarks> <maml:para>This command removes an existing area with the path \MyArea\Path to the Demo project. Any work items that are assigned to that path get reassigned to the area with the id 19.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamArea | Remove-VSTeamArea "A1" -Force</dev:code> <dev:remarks> <maml:para>This command removes an existing area with the path "A1" to the default project. Any work items that are assigned to that path get reassigned to the area with the returned by Get-VSTeamArea.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamBanner</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamBanner</command:noun> <maml:description> <maml:para>Removes a banner message from an Azure DevOps organization by its identifier.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a banner message from an Azure DevOps organization by its identifier.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamBanner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamBanner -Id '9547ed55-66e1-403d-95aa-9e628726861c'</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBanner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamBanner</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamBuild</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Deletes the build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuild | Remove-VSTeamBuild -Force</dev:code> <dev:remarks> <maml:para>This command will delete all builds that are not marked retain indefinitely.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamBuildDefinition</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamBuildDefinition</command:noun> <maml:description> <maml:para>Removes the build definitions for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-VSTeamBuildDefinition function removes the build definitions for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more build definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more build definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition -ProjectName Demo | Remove-VSTeamBuildDefinition</dev:code> <dev:remarks> <maml:para>This command gets a list of all build definitions in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Remove-VSTeamBuildDefinition function, which removes each build definition object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamBuildTag</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamBuildTag</command:noun> <maml:description> <maml:para>Removes the tag from a build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the tag from a build.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamBuildTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>One or more tags. To specify multiple, use commas to separate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more builds by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a build, type Get-VSTeamBuild.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>One or more tags. To specify multiple, use commas to separate.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate"</dev:code> <dev:remarks> <maml:para>Removes the "ReleaseCandidate" tag from the build with ID `1001`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Removes the "ReleaseCandidate" tag from the build with ID `1001` within the "MyProject" project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$tagsToRemove = "ReleaseCandidate", "Beta", "Alpha" $tagsToRemove | ForEach-Object { Remove-VSTeamBuildTag -BuildId 1001 -Tag $_ }</dev:code> <dev:remarks> <maml:para>Removes multiple tags "ReleaseCandidate", "Beta", and "Alpha" from the build with ID `1001`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Remove-VSTeamBuildTag -BuildId 1001 -Tag "ReleaseCandidate" -Force</dev:code> <dev:remarks> <maml:para>Removes the "ReleaseCandidate" tag from the build with ID `1001` and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamClassificationNode</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamClassificationNode</command:noun> <maml:description> <maml:para>Removes either an existing iteration or area from the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes either an existing iteration or area from the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamClassificationNode</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">iterations</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">areas</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of a classification node where work items should be reassigned to if they are currently assigned to the node being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of a classification node where work items should be reassigned to if they are currently assigned to the node being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is the base function for Remove-VSTeamArea and Remove-VSTeamIteration.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamClassificationNode -ProjectName Demo -StructureGroup "iterations" -Path "\MyIteration\Path"</dev:code> <dev:remarks> <maml:para>This command removes an existing iteration with the path MyIteration/Path to the Demo project. Any work items that are assigned to that path get reassigned to the root iteration, since no reclassification id has been given.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamClassificationNode -ProjectName "Demo" -StructureGroup "areas" -Path "\MyIteration\Path" -ReClassifyId 19</dev:code> <dev:remarks> <maml:para>This command removes an existing area with the path \MyIteration\Path to the Demo project. Any work items that are assigned to that path get reassigned to the area with the id 19.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamDirectAssignment</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamDirectAssignment</command:noun> <maml:description> <maml:para>Removes explicit assignments of users by their IDs. Operates in either preview mode or normal mode. In normal mode, it chunks user IDs into groups of 20 to avoid timeouts.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes explicit assignments of users by their IDs. Operates in either preview mode or normal mode. In normal mode, it chunks user IDs into groups of 20 to avoid timeouts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamDirectAssignment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The IDs of the users to remove explicit assignments for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Preview</maml:name> <maml:description> <maml:para>Switch to operate in preview mode.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UserIds</maml:name> <maml:description> <maml:para>The IDs of the users to remove explicit assignments for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Preview</maml:name> <maml:description> <maml:para>Switch to operate in preview mode.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamDirectAssignment -UserIds '12345','67890' -Preview</dev:code> <dev:remarks> <maml:para>Removes the explicit assignments for the users with the specified IDs in preview mode.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamDirectAssignment -UserIds '12345','67890'</dev:code> <dev:remarks> <maml:para>Removes the explicit assignments for the users with the specified IDs.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamExtension</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamExtension</command:noun> <maml:description> <maml:para>Uninstall the specified extension from the account / project collection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Uninstall the specified extension from the account / project collection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension"</dev:code> <dev:remarks> <maml:para>Removes the extension "MyExtension" from the publisher "Contoso".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -Force</dev:code> <dev:remarks> <maml:para>Removes the extension "MyExtension" from the publisher "Contoso" and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamExtension</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamFeed</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamFeed</command:noun> <maml:description> <maml:para>Removes a package feed from the account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a package feed from the account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamFeed</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="FeedId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="FeedId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamFeed -id '00000000-0000-0000-0000-000000000000'</dev:code> <dev:remarks> <maml:para>This command remove the package feed from the account.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamFeed -id '00000000-0000-0000-0000-000000000000' -ProjectName 'MyProject'</dev:code> <dev:remarks> <maml:para>This command remove the package feed from the project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamGitRepository</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamGitRepository</command:noun> <maml:description> <maml:para>Removes the Git repository from your Azure DevOps or Team Foundation Server account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove-VSTeamGitRepository removes the Git repository from your Azure DevOps or Team Foundation Server account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamGitRepository</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more repositories by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a repository, type Get-Repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="RepositoryID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more repositories by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a repository, type Get-Repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid[]</command:parameterValue> <dev:type> <maml:name>Guid[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamGitRepository -Id 687c53f8-1a82-4e89-9a86-13d51bc4a8d5</dev:code> <dev:remarks> <maml:para>This command removes all the Git repositories for your TFS or Team Services account.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamIteration</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamIteration</command:noun> <maml:description> <maml:para>Removes an existing iteration from the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an existing iteration from the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamIteration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the iteration node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of an iteration where work items should be reassigned to if they are currently assigned to the iteration being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the iteration node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ReClassifyId</maml:name> <maml:description> <maml:para>Id of an iteration where work items should be reassigned to if they are currently assigned to the iteration being deleted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Remove-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamIteration -ProjectName Demo -Path "\MyIteration\Path"</dev:code> <dev:remarks> <maml:para>This command removes an existing iteration with the path MyIteration/Path to the Demo project. Any work items that are assigned to that path get reassigned to the root iteration, since no reclassification id has been given.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamIteration -ProjectName "Demo" -Path "\MyIteration\Path" -ReClassifyId 19</dev:code> <dev:remarks> <maml:para>This command removes an existing iteration with the path \MyIteration\Path to the Demo project. Any work items that are assigned to that path get reassigned to the iteration with the id 19.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamClassificationNode</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamMembership</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamMembership</command:noun> <maml:description> <maml:para>Removes a membership to a container.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a membership to a container.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$user = Get-VSTeamUser | ? DisplayName -eq 'Test User' $group = Get-VSTeamGroup | ? DisplayName -eq 'Endpoint Administrators' Remove-VSTeamMembership -MemberDescriptor $user.Descriptor -ContainerDescriptor $group.Descriptor</dev:code> <dev:remarks> <maml:para>Removes Test User from the Endpoint Administrators group.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VsTeamUser</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Test-VsTeamMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamPolicy</command:noun> <maml:description> <maml:para>Removes the specified policy from the specified project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove-VSTeamPolicy removes the policy from the specified project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more policies by ID.</maml:para> <maml:para>To find the ID of a policy see Get-VSTeamPolicy (Get-VSTeamPolicy.md)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int[]</command:parameterValue> <dev:type> <maml:name>Int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more policies by ID.</maml:para> <maml:para>To find the ID of a policy see Get-VSTeamPolicy (Get-VSTeamPolicy.md)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int[]</command:parameterValue> <dev:type> <maml:name>Int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamPolicy -ProjectName Demo -Id 1</dev:code> <dev:remarks> <maml:para>This command removes the policy with ID of 1 from the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicyType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicyType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamPool</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamPool</command:noun> <maml:description> <maml:para>Removes the agent pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the agent pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamPool -Id 101</dev:code> <dev:remarks> <maml:para>Removes the pool with ID `101`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$poolsToRemove = 101, 102, 103 $poolsToRemove | ForEach-Object { Remove-VSTeamPool -Id $_ }</dev:code> <dev:remarks> <maml:para>Removes multiple pools with IDs `101`, `102`, and `103`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$poolsToRemove = 101, 102, 103 $poolsToRemove | Remove-VSTeamPool -Id $_</dev:code> <dev:remarks> <maml:para>Another method to remove multiple pools with IDs `101`, `102`, and `103` using pipeline input.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPool</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamProfile</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamProfile</command:noun> <maml:description> <maml:para>Removes the profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the profile.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of profile to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of profile to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamProfile | Remove-VSTeamProfile -Force</dev:code> <dev:remarks> <maml:para>This will remove all the profiles on your system.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamProject</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamProject</command:noun> <maml:description> <maml:para>Deletes the Team Project from your Team Services account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This will permanently delete your Team Project from your Team Services account.</maml:para> <maml:para>This function takes a DynamicParam for ProjectName that can be read from the Pipeline by Property Name</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamProject 'MyProject'</dev:code> <dev:remarks> <maml:para>You will be prompted for confirmation and the project will be deleted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamProject 'MyProject' -Force</dev:code> <dev:remarks> <maml:para>You will NOT be prompted for confirmation and the project will be deleted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamProject | Remove-VSTeamProject -Force</dev:code> <dev:remarks> <maml:para>This will remove all projects</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamRelease</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamRelease</command:noun> <maml:description> <maml:para>Removes the releases for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-VSTeamRelease function removes the releases for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe release definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamRelease -ProjectName demo | Remove-VSTeamRelease</dev:code> <dev:remarks> <maml:para>This command gets a list of all releases in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Remove-VSTeamRelease function, which removes each release definition object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamRelease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamRelease</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamReleaseDefinition</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamReleaseDefinition</command:noun> <maml:description> <maml:para>Removes the release definitions for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-VSTeamReleaseDefinition function removes the release definitions for a team project.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more release definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamReleaseDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more release definitions by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release definition, type Get-VSTeamReleaseDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe release definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamReleaseDefinition -ProjectName demo | Remove-VSTeamReleaseDefinition</dev:code> <dev:remarks> <maml:para>This command gets a list of all release definitions in the demo project.</maml:para> <maml:para>The pipeline operator (|) passes the data to the Remove-VSTeamReleaseDefinition function, which removes each release definition object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamServiceEndpoint</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamServiceEndpoint</command:noun> <maml:description> <maml:para>Removes a service endpoint.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a service endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamServiceEndpoint</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the service endpoint</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab"</dev:code> <dev:remarks> <maml:para>Removes the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Removes the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` within the "MyProject" project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Force</dev:code> <dev:remarks> <maml:para>Removes the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamTaskGroup</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamTaskGroup</command:noun> <maml:description> <maml:para>Removes a task group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a task group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamTaskGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$projectName = "some_project_name" $taskGroup = Get-VSTeamTaskGroup -Name "taskName" -ProjectName $projectName $methodParameters = @{ Id = $taskGroup.id ProjectName = $projectName Force = $true } Remove-VSTeamTaskGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamTaskGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamUserEntitlement</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamUserEntitlement</command:noun> <maml:description> <maml:para>Delete a user from the account.</maml:para> <maml:para>The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a user from the account.</maml:para> <maml:para>The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="UserId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="name"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email of the user to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="UserId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="name"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email of the user to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamUserEntitlement -Id "12345678-abcd-1234-abcd-1234567890ab"</dev:code> <dev:remarks> <maml:para>Removes the user entitlement with ID `12345678-abcd-1234-abcd-1234567890ab`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamUserEntitlement -Email "user1@example.com"</dev:code> <dev:remarks> <maml:para>Removes the user entitlement for the user with the email "user1@example.com".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamUserEntitlement -Id "12345678-abcd-1234-abcd-1234567890ab" -Force</dev:code> <dev:remarks> <maml:para>Removes the user entitlement with ID `12345678-abcd-1234-abcd-1234567890ab` and forces the removal without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamVariableGroup</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamVariableGroup</command:noun> <maml:description> <maml:para>Removes a variable group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a variable group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamVariableGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "new_variable_group" Description = "Describe the Variable Group" Type = "Vsts" Variables = @{ key1 = @{ value = "value1" isSecret = $true } } } $newVariableGroup = Add-VSTeamVariableGroup @methodParameters $methodParameters = @{ Id = $newVariableGroup.id ProjectName = "some_project_name" Force = $true } Remove-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamVariableGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamWiki</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamWiki</command:noun> <maml:description> <maml:para>Unpublish a project or code wiki in the project provided</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Un-publish a code or project wiki in to the selected repo</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>WikiName</maml:name> <maml:description> <maml:para>Name of the Wiki to Un-publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-VSTeamWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Id"> <maml:name>WikiId</maml:name> <maml:description> <maml:para>Id of the Wiki to Un-publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Name"> <maml:name>WikiName</maml:name> <maml:description> <maml:para>Name of the Wiki to Un-publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Id"> <maml:name>WikiId</maml:name> <maml:description> <maml:para>Id of the Wiki to Un-publish</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamWiki -ProjectName myProject -WikiName myWikiName</dev:code> <dev:remarks> <maml:para>This will Un-publish a wiki by name, project name required</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamWiki -WikiId 00000000-0000-0000-0000-000000000000</dev:code> <dev:remarks> <maml:para>This will Un-publish a wiki by Id</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamWiki</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamWiki</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamWiki</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamWorkItem</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamWorkItem</command:noun> <maml:description> <maml:para>Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified work item and sends it to the Recycle Bin, so that it can be restored back, if required. Optionally, if the destroy parameter has been set to true, it destroys the work item permanently. WARNING: If the destroy parameter is set to true, work items deleted by this command will NOT go to recycle-bin and there is no way to restore/recover them after deletion. It is recommended NOT to use this parameter. If you do, please use this parameter with extreme caution.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamWorkItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of one or more work items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Destroy</maml:name> <maml:description> <maml:para>Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of one or more work items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Destroy</maml:name> <maml:description> <maml:para>Optional parameter, if set to true, the work item is deleted permanently. Please note: the destroy action is PERMANENT and cannot be undone.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>If you do not set the default project by called Set-VSTeamDefaultProject before calling Get-VSTeamWorkItem you will have to type in the names.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamWorkItem -Id 47,48 -Force</dev:code> <dev:remarks> <maml:para>This command deletes work items with IDs 47 and 48 by using the IDs parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-VSTeamWorkItem -Id 47</dev:code> <dev:remarks> <maml:para>This command deletes the work item with ID 47 by using the ID parameter.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Remove-VSTeamWorkItem -Id 47 -Destroy -Force</dev:code> <dev:remarks> <maml:para>This command deletes work item with IDs 47 permanently by using the Destroy parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-VSTeamWorkItemTag</command:name> <command:verb>Remove</command:verb> <command:noun>VSTeamWorkItemTag</command:noun> <maml:description> <maml:para>Gets a work item tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a work item tag.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-VSTeamWorkItemTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TagName, TagId"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="TagName, TagId"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Remove-VSTeamWorkItemTag -TagName</dev:code> <dev:remarks> <maml:para>This will remove a specific work item tag within the current project</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamAccount</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamAccount</command:noun> <maml:description> <maml:para>Stores your account name and personal access token for use with the other functions in this module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>On Windows you have to option to store the information at the process, user or machine (you must be running PowerShell as administrator to store at the machine level) level.</maml:para> <maml:para>On Linux and Mac you can only store at the process level.</maml:para> <maml:para>Calling Set-VSTeamAccount will clear any default project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="PAT"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Set-VSTeamAccount command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your account information at the Process, User or Machine levels. When saved at the User or Machine level your account information will be in any future PowerShell processes.</maml:para> <maml:para>To store at the Machine level you must be running PowerShell as an Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Drive</maml:name> <maml:description> <maml:para>The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VSTeamAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="Token"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your account information at the Process, User or Machine levels. When saved at the User or Machine level your account information will be in any future PowerShell processes.</maml:para> <maml:para>To store at the Machine level you must be running PowerShell as an Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Drive</maml:name> <maml:description> <maml:para>The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VSTeamAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your account information at the Process, User or Machine levels. When saved at the User or Machine level your account information will be in any future PowerShell processes.</maml:para> <maml:para>To store at the Machine level you must be running PowerShell as an Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseWindowsAuthentication</maml:name> <maml:description> <maml:para>Allows the use of the current user's Windows credentials to authenticate against a local Team Foundation Server or Azure DevOps Server. This cannot be used to connect to Azure DevOps Services.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Drive</maml:name> <maml:description> <maml:para>The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VSTeamAccount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>The profile name stored using Add-VSTeamProfile function. You can tab complete through existing profile names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Drive</maml:name> <maml:description> <maml:para>The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Account</maml:name> <maml:description> <maml:para>The Azure DevOps (AzD) account name to use. DO NOT enter the entire URL.</maml:para> <maml:para>Just the portion after dev.azure.com. For example in the following url mydemos is the account name. https://dev.azure.com/mydemos (https://dev.azure.com/mydemos)or The full Team Foundation Server (TFS) url including the collection. http://localhost:8080/tfs/DefaultCollection (http://localhost:8080/tfs/DefaultCollection)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="PAT"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Set-VSTeamAccount command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your account information at the Process, User or Machine levels. When saved at the User or Machine level your account information will be in any future PowerShell processes.</maml:para> <maml:para>To store at the Machine level you must be running PowerShell as an Administrator.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="Token"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseWindowsAuthentication</maml:name> <maml:description> <maml:para>Allows the use of the current user's Windows credentials to authenticate against a local Team Foundation Server or Azure DevOps Server. This cannot be used to connect to Azure DevOps Services.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>UseBearerToken</maml:name> <maml:description> <maml:para>Switches the authorization from Basic to Bearer. You still use the PAT for PersonalAccessToken parameters to store the token.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Profile</maml:name> <maml:description> <maml:para>The profile name stored using Add-VSTeamProfile function. You can tab complete through existing profile names.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> <maml:para> </maml:para> <maml:para>If you are on AzD it will default to AzD otherwise it will default to TFS2017.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017 for TFS and AzD for AzD</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Drive</maml:name> <maml:description> <maml:para>The name of the drive you want to mount to this account. The command you need to run will be presented. Simply copy and paste the command to mount the drive. To use the drive run Set-Location [driveName]:</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAccount</dev:code> <dev:remarks> <maml:para>You will be prompted for the account name and personal access token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrthisisnotreal4uhlh5vgbmgap3mziwnga</dev:code> <dev:remarks> <maml:para>Allows you to provide all the information on the command line.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account http://localtfs:8080/tfs/DefaultCollection -UseWindowsAuthentication</dev:code> <dev:remarks> <maml:para>On Windows, allows you use to use Windows authentication against a local TFS server.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Profile demonstrations</dev:code> <dev:remarks> <maml:para>Will add the account from the profile provided.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Profile demonstrations -Drive demo | Invoke-Expression Set-Location demo: PS demo:\> Get-ChildItem</dev:code> <dev:remarks> <maml:para>Will add the account from the profile provided and mount a drive named demo that you can navigate like a file system. If you do not pipe to Invoke-Expression you can simply copy and paste the output and execute it.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Profile demonstrations -Level Machine</dev:code> <dev:remarks> <maml:para>Will add the account from the profile provided and store the information at the Machine level. Now any new PowerShell sessions will auto load this account.</maml:para> <maml:para>Note: You must run PowerShell as an Administrator to store at the Machine level.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken</dev:code> <dev:remarks> <maml:para>Will add the account and use the OAuth Token provided by AzD when you check the Allow scripts to access OAuth token checkbox on the phase. Using this method removes the need to create a Personal Access Token. Note -Token is just an alias for -PersonalAccessToken. The token is scoped to only allow access to the account running the build or release. To access other accounts you will have to use a personal access token.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Clear-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Clear-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamAlias</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamAlias</command:noun> <maml:description> <maml:para>In version 6.0 the default aliases were removed to prevent conflicts with other modules. If you want to use the original aliases you can run this function to restore them.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>In version 6.0 the default aliases were removed to prevent conflicts with other modules. If you want to use the original aliases you can run this function to restore them.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamAlias</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAlias -Force</dev:code> <dev:remarks> <maml:para>Activates the alias names and forces the update without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamAPIVersion</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamAPIVersion</command:noun> <maml:description> <maml:para>Sets the API versions to support either TFS2017, TFS2018, AzD2019 or AzD.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-VSTeamAPIVersion sets the versions of APIs used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamAPIVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VSTeamAPIVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the service to change. The acceptable values for this parameter are:</maml:para> <maml:para>- Build</maml:para> <maml:para>- Release</maml:para> <maml:para>- Core</maml:para> <maml:para>- Git</maml:para> <maml:para>- DistributedTask</maml:para> <maml:para>- Tfvc</maml:para> <maml:para>- Packaging</maml:para> <maml:para>- MemberEntitlementManagement</maml:para> <maml:para>- ExtensionsManagement</maml:para> <maml:para>- ServiceEndpoints</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the version to use. The acceptable values for this parameter are:</maml:para> <maml:para>- TFS2017</maml:para> <maml:para>- TFS2017U1</maml:para> <maml:para>- TFS2017U2</maml:para> <maml:para>- TFS2017U3</maml:para> <maml:para>- TFS2018</maml:para> <maml:para>- TFS2018U1</maml:para> <maml:para>- TFS2018U2</maml:para> <maml:para>- TFS2018U3</maml:para> <maml:para>- AzD2019</maml:para> <maml:para>- AzD2019U1</maml:para> <maml:para>- VSTS</maml:para> <maml:para>- AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>TFS2017</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Service</maml:name> <maml:description> <maml:para>Specifies the service to change. The acceptable values for this parameter are:</maml:para> <maml:para>- Build</maml:para> <maml:para>- Release</maml:para> <maml:para>- Core</maml:para> <maml:para>- Git</maml:para> <maml:para>- DistributedTask</maml:para> <maml:para>- Tfvc</maml:para> <maml:para>- Packaging</maml:para> <maml:para>- MemberEntitlementManagement</maml:para> <maml:para>- ExtensionsManagement</maml:para> <maml:para>- ServiceEndpoints</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the version to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAPIVersion AzD</dev:code> <dev:remarks> <maml:para>This command sets the API versions to support AzD.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamAPIVersion -Service Release -Version '5.0'</dev:code> <dev:remarks> <maml:para>This command sets the version of the Release calls to 5.0.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamApproval</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamApproval</command:noun> <maml:description> <maml:para>Sets the status of approval to Approved, Rejected, Pending, or ReAssigned.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set-VSTeamApproval sets the status of approval to Approved, Rejected, Pending, or ReAssigned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamApproval</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the approval IDs of the approvals to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status to set for the approval. The acceptable values for this parameter are:</maml:para> <maml:para>- Approved</maml:para> <maml:para>- Rejected</maml:para> <maml:para>- Pending</maml:para> <maml:para>- ReAssigned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Approved</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specifies the user to whom the approval has been re-assigned to Alias of the user chuckreinhart@outlook.com, for example.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment to be stored with this approval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the approval IDs of the approvals to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Specifies the status to set for the approval. The acceptable values for this parameter are:</maml:para> <maml:para>- Approved</maml:para> <maml:para>- Rejected</maml:para> <maml:para>- Pending</maml:para> <maml:para>- ReAssigned</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Approved</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Approver</maml:name> <maml:description> <maml:para>Specifies the user to whom the approval has been re-assigned to Alias of the user chuckreinhart@outlook.com, for example.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>Specifies the comment to be stored with this approval.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamApproval | Set-VSTeamApproval</dev:code> <dev:remarks> <maml:para>This command sets all pending approvals to approved.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamApproval -Id 1 -Status Rejected</dev:code> <dev:remarks> <maml:para>This command rejects approval with Id of 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamDefaultAPITimeout</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamDefaultAPITimeout</command:noun> <maml:description> <maml:para>Sets the default timeout to be used with other calls in the module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>By setting a default timeout you can adjust the value for your needs</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamDefaultAPITimeout</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TimeoutSec</maml:name> <maml:description> <maml:para>Specifies the timeout for all function calls.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default timeout at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default timeout will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TimeoutSec</maml:name> <maml:description> <maml:para>Specifies the timeout for all function calls.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default timeout at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default timeout will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultAPITimeout 30</dev:code> <dev:remarks> <maml:para>This command sets 30 seconds as the default timeout.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamDefaultProject</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamDefaultProject</command:noun> <maml:description> <maml:para>Sets the default project to be used with other calls in the module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The majority of the functions in this module require a project name.</maml:para> <maml:para>By setting a default project you can omit that parameter from your function calls and this default will be used instead.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamDefaultProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default project at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default project will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default project at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default project will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo</dev:code> <dev:remarks> <maml:para>This command sets Demo as the default project.</maml:para> <maml:para>You can now call other functions that require a project name without passing the project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Set-VSTeamAPIVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamAPIVersion</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultAPITimeout</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultAPITimeout</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_profiles</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_profiles</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_vsteam_provider</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/about_vsteam_provider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamDefaultProjectCount</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamDefaultProjectCount</command:noun> <maml:description> <maml:para>Sets the default project count to be used with other calls in the module. This is important if you have more than 100 projects.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The majority of the functions in this module require a project name and you can tab complete it. Each project name if validated before used in a function call.</maml:para> <maml:para>By setting a default project count you can make sure all your projects are returned during tab completion and project name parameter validation if you have more than 100 projects.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamDefaultProjectCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of projects to return by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default project count at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default project count will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Count</maml:name> <maml:description> <maml:para>Specifies the number of projects to return by default.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>On Windows allows you to store your default project count at the Process, User or Machine levels.</maml:para> <maml:para>When saved at the User or Machine level your default project count will be in any future PowerShell processes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProjectCount 500</dev:code> <dev:remarks> <maml:para>This command sets 500 as the default project count to return.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamEnvironmentStatus</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamEnvironmentStatus</command:noun> <maml:description> <maml:para>Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the status of a environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamEnvironmentStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>Specifies one or more environments by ID you wish to deploy.</maml:para> <maml:para>The Environment Ids are unique for each environment and in each release.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of an environment type Get-VSTeamRelease -expand environments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>Specifies the release by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set for the environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The comment to set for the status change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ScheduledDeploymentTime</maml:name> <maml:description> <maml:para>The date and time to schedule when setting the status to scheduled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>EnvironmentId</maml:name> <maml:description> <maml:para>Specifies one or more environments by ID you wish to deploy.</maml:para> <maml:para>The Environment Ids are unique for each environment and in each release.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of an environment type Get-VSTeamRelease -expand environments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ReleaseId</maml:name> <maml:description> <maml:para>Specifies the release by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set for the environment to canceled, inProgress, notStarted, partiallySucceeded, queued, rejected, scheduled, succeeded or undefined.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Comment</maml:name> <maml:description> <maml:para>The comment to set for the status change.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ScheduledDeploymentTime</maml:name> <maml:description> <maml:para>The date and time to schedule when setting the status to scheduled.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamEnvironmentStatus -ReleaseId 54 -Id 5 -status inProgress</dev:code> <dev:remarks> <maml:para>This command will set the status of environment with id 5 of release 54 to inProgress. You can use this call to redeploy an environment.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamPermissionInheritance</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamPermissionInheritance</command:noun> <maml:description> <maml:para>Undocumented API Sets the permission inheritance to true or false.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Undocumented API Sets the permission inheritance to true or false.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamPermissionInheritance</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the type of resource. The acceptable values for this parameter are:</maml:para> <maml:para>- Repository</maml:para> <maml:para>- BuildDefinition</maml:para> <maml:para>- ReleaseDefinition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewState</maml:name> <maml:description> <maml:para>The new state to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Specifies the type of resource. The acceptable values for this parameter are:</maml:para> <maml:para>- Repository</maml:para> <maml:para>- BuildDefinition</maml:para> <maml:para>- ReleaseDefinition</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewState</maml:name> <maml:description> <maml:para>The new state to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamPermissionInheritance -ProjectName Demo -Name Demo-CI -ResourceType BuildDefinition -NewState $true -Force</dev:code> <dev:remarks> <maml:para>This command sets the permission inheritance to true.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-VSTeamBuildDefinition | Set-VSTeamPermissionInheritance -ResourceType BuildDefinition -NewState $true -Force</dev:code> <dev:remarks> <maml:para>This command sets the permission inheritance to true for every build definition returned from Get-VSTeamBuildDefinition.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamPermissionInheritanceType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamPermissionInheritanceType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamPipelineAuthorization</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamPipelineAuthorization</command:noun> <maml:description> <maml:para>Authorizes pipelines to use the given resources.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Authorizes pipelines to use the given resources.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamPipelineAuthorization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>PipelineIds</maml:name> <maml:description> <maml:para>List of pipeline Ids to authorize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authorize</maml:name> <maml:description> <maml:para>Allows given pipelines to use the named resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Resource which the pipelines are authorized to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Resource type to authorize the pipeline on</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Endpoint</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Repository</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-VSTeamPipelineAuthorization</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizeAll</maml:name> <maml:description> <maml:para>Removes any authorization restrictions for the given resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Resource which the pipelines are authorized to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Resource type to authorize the pipeline on</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Endpoint</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Repository</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Authorize</maml:name> <maml:description> <maml:para>Allows given pipelines to use the named resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizeAll</maml:name> <maml:description> <maml:para>Removes any authorization restrictions for the given resource</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>PipelineIds</maml:name> <maml:description> <maml:para>List of pipeline Ids to authorize</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Resource which the pipelines are authorized to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>Resource type to authorize the pipeline on</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int32[]</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamPipelineAuthorization -PipelineIds 1 -ResourceId 34 -ResourceType Queue -Authorize $true</dev:code> <dev:remarks> <maml:para>Authorizes the pipeline to access the resource 34 of type Queue (Agent Pool).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamPipelineAuthorization -PipelineIds 1 -ResourceId $resourceId -ResourceType VariableGroup -Authorize $false</dev:code> <dev:remarks> <maml:para>Removes authorization from the pipeline to access the resource with id $resourceId of type VariableGroup.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamPipelineAuthorization -PipelineIds @(1,2,3) -ResourceId 34 -ResourceType Queue -Authorize $true</dev:code> <dev:remarks> <maml:para>Authorizes the pipelines 1, 2 and 3 to access the resource 34 of type Queue (Agent Pool).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Set-VSTeamPipelineAuthorization -ResourceId $resourceId -ResourceType Repository -AuthorizeAll $true</dev:code> <dev:remarks> <maml:para>Authorize all pipelines to access the resource with id $resourceId of type Repository.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamPipelineBilling</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamPipelineBilling</command:noun> <maml:description> <maml:para>Purchases private and Microsoft hosted concurrent jobs for pipelines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Purchases private and Microsoft hosted concurrent jobs for pipelines. A minimum of owner or project collection administrator permissions are required to trigger billing actions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamPipelineBilling</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of billing to be set.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">HostedPipeline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PrivatePipeline</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization to be billed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The quantity to which the billing should be set. E.g. for Microsoft-hosted pipelines you would set the concurred jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of billing to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OrganizationId</maml:name> <maml:description> <maml:para>The organization to be billed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Quantity</maml:name> <maml:description> <maml:para>The quantity to which the billing should be set. E.g. for Microsoft-hosted pipelines you would set the concurred jobs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Beware that these operations are potentially producing costs. This is why you need to confirm or force the command.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------- Example 1: Set Microsoft hosted pipeline jobs --------</maml:title> <dev:code>$myProfile = Get-VSTeamUserProfile -MyProfile $orgs = Get-VSTeamAccounts -MemberId $myProfile.id Set-VSTeamPipelineBilling -Type HostedPipeline -Quantity 1 -OrganizationId $orgs[0].accountId</dev:code> <dev:remarks> <maml:para>Sets the concurrent jobs on organization `$orgs[0].accountId` for hosted pipelines to 1. Depending on the original value either the number has been reduced or new concurrent jobs have been purchased. The organization id and the connected subscription for the organization are required. To get the id you can use `Get-VSTeamAccounts` and `Get-VSTeamUserProfile`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------- Example 2: Set private hosted pipeline jobs ---------</maml:title> <dev:code>Set-VSTeamPipelineBilling -Type PrivatePipeline -Quantity 1 -OrganizationId 9de24e7c-2e01-496c-bde5-71f92195ae2c</dev:code> <dev:remarks> <maml:para>Sets the concurrent jobs for private agents on organization `9de24e7c-2e01-496c-bde5-71f92195ae2c` for hosted pipelines to 1. Depending on the original value either the number has been reduced or new concurrent jobs have been purchased.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 3: Set private hosted pipeline jobs with current organization</maml:title> <dev:code>Set-VSTeamPipelineBilling -Type PrivatePipeline -Quantity 1</dev:code> <dev:remarks> <maml:para>Sets the concurrent jobs for private agents on the current set organization for hosted pipelines to 1. Depending on the original value either the number has been reduced or new concurrent jobs have been purchased.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamUserProfile</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserProfile</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamAccountBilling</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamAccountBilling</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamReleaseStatus</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamReleaseStatus</command:noun> <maml:description> <maml:para>Sets the status of a release to Active or Abandoned.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets the status of a release to Active or Abandoned.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamReleaseStatus</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set for the release Active or Abandoned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies one or more releases by ID.</maml:para> <maml:para>To specify multiple IDs, use commas to separate the IDs.</maml:para> <maml:para>To find the ID of a release type Get-VSTeamRelease.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue> <dev:type> <maml:name>Int32[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set for the release Active or Abandoned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamReleaseStatus -Id 5 -status Abandoned</dev:code> <dev:remarks> <maml:para>This command will set the status of release with id 5 to Abandoned.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-VSTeamVariableGroupVariable</command:name> <command:verb>Set</command:verb> <command:noun>VSTeamVariableGroupVariable</command:noun> <maml:description> <maml:para>Adds a variable to an existing variable group, or changes its value if the variable is already present.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Adds a variable to an existing variable group, or changes its value if the variable is already present.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-VSTeamVariableGroupVariable</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the variable to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>GroupName</maml:name> <maml:description> <maml:para>Name of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the variable to set</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>The new value of the variable</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>""</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Secret variable updating or creation is not currently supported.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code># In project MyProject, variable group MyVarGroup, set the value of Foo to Hello. The variable # called Foo will be created if it doesn't already exist. Set-VSTeamVariableGroupVariable -ProjectName MyProject -GroupName MyVarGroup -Name Foo -Value Hello</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamVariableGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeam</command:name> <command:verb>Show</command:verb> <command:noun>VSTeam</command:noun> <maml:description> <maml:para>Opens TFS or AzD site in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens TFS or AzD site in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeam</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeam</dev:code> <dev:remarks> <maml:para>This will open a browser to the TFS or AzD site</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamApproval</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamApproval</command:noun> <maml:description> <maml:para>Opens the release associated with the waiting approval in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the release associated with the waiting approval in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamApproval</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>ReleaseDefinitionId</maml:name> <maml:description> <maml:para>Only approvals for the release id provided will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="1" aliases="Id"> <maml:name>ReleaseDefinitionId</maml:name> <maml:description> <maml:para>Only approvals for the release id provided will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.BuildDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamApproval -ProjectName Demo | Show-VSTeamApproval</dev:code> <dev:remarks> <maml:para>This command opens a web browser showing the release requiring approval.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamBuild</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Opens the build summary in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the build summary in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamBuild</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies build by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies build by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Build</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe the build ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamBuild -ProjectName Demo -Id 3</dev:code> <dev:remarks> <maml:para>This command will open a web browser with the summary of build 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuild</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuild</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuild</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuild</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamBuildDefinition</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamBuildDefinition</command:noun> <maml:description> <maml:para>Opens the build definition in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the build definition in the default browser.</maml:para> <maml:para>The project name is a Dynamic Parameter which may not be displayed in the syntax above but is mandatory.</maml:para> <maml:para>With just a project name, this function shows all of the build definitions for that team project.</maml:para> <maml:para>You can also specify a particular build definition by ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamBuildDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the build definitions to retrieve. The acceptable values for this parameter are:</maml:para> <maml:para>- Mine</maml:para> <maml:para>- All</maml:para> <maml:para>- Queued</maml:para> <maml:para>- XAML</maml:para> <maml:para> </maml:para> <maml:para>If not specified, all types will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The folder of the build definitions to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Show-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies build definition by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the build definitions to retrieve. The acceptable values for this parameter are:</maml:para> <maml:para>- Mine</maml:para> <maml:para>- All</maml:para> <maml:para>- Queued</maml:para> <maml:para>- XAML</maml:para> <maml:para> </maml:para> <maml:para>If not specified, all types will be returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>All</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The folder of the build definitions to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>\</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="BuildDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies build definition by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.BuildDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe build definition IDs to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamBuildDefinition -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command will open a web browser with All Definitions for this project showing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamFeed</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamFeed</command:noun> <maml:description> <maml:para>Opens the feed in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the feed in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamFeed</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies feed by ID or Name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Feed</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamFeed -Name Demo</dev:code> <dev:remarks> <maml:para>This command will open a web browser with this feed showing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamFeed</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamFeed</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamGitRepository</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamGitRepository</command:noun> <maml:description> <maml:para>Opens the Git repository in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the Git repository in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamGitRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RemoteUrl</maml:name> <maml:description> <maml:para>The RemoteUrl of the Git repository to open.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>RemoteUrl</maml:name> <maml:description> <maml:para>The RemoteUrl of the Git repository to open.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamGitRepository -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command opens the Git repository in a browser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamPackage</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamPackage</command:noun> <maml:description> <maml:para>Opens the package in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the package in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:description> <maml:para>Package to show</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.Package</command:parameterValue> <dev:type> <maml:name>vsteam_lib.Package</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:description> <maml:para>Package to show</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">vsteam_lib.Package</command:parameterValue> <dev:type> <maml:name>vsteam_lib.Package</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>vsteam_lib.Package</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Package</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>------------------- Example 1: From pipeline -------------------</maml:title> <dev:code>Get-VSTeamPackage -feedName vsteam -Top 1 -Skip 2 | Show-VSTeamPackage</dev:code> <dev:remarks> <maml:para>This command will open a web browser with this package showing.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------- Example 2: By parameter -------------------</maml:title> <dev:code>$p = Get-VSTeamPackage -feedName vsteam -Top 1 -Skip 2 Show-VSTeamPackage $p</dev:code> <dev:remarks> <maml:para>This command will open a web browser with this package showing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamPackage</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPackage</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamProject</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamProject</command:noun> <maml:description> <maml:para>Opens the project in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the project in default browser.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProjectID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="ProjectID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamProject TestProject</dev:code> <dev:remarks> <maml:para>This will open a browser to the TestProject site</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamProject</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamProject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamPullRequest</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamPullRequest</command:noun> <maml:description> <maml:para>Opens the pull request in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the pull request in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PullRequestId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies pull request by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PullRequestId"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies pull request by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>You can pipe the pull request ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamPullRequest 3</dev:code> <dev:remarks> <maml:para>This command will open a web browser with the pull request id of 3.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Show-VSTeamPullRequest -Id 3</dev:code> <dev:remarks> <maml:para>This command will open a web browser with the pull request id of 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamPullRequest</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPullRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamRelease</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamRelease</command:noun> <maml:description> <maml:para>Opens the release summary in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the release summary in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies release by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies release by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>You can pipe the release ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamRelease -ProjectName Demo -Id 3</dev:code> <dev:remarks> <maml:para>This command will open a web browser with the summary of release 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamRelease</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamRelease</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamRelease</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamReleaseDefinition</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamReleaseDefinition</command:noun> <maml:description> <maml:para>Opens the release definitions for a team project in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the release definitions for a team project in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies release definition by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ReleaseDefinitionID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies release definition by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.ReleaseDefinition</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe the release definition ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamReleaseDefinition -ProjectName Demo</dev:code> <dev:remarks> <maml:para>This command will open a web browser with All Release Definitions for this project showing.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamReleaseDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamReleaseDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-VSTeamWorkItem</command:name> <command:verb>Show</command:verb> <command:noun>VSTeamWorkItem</command:noun> <maml:description> <maml:para>Opens the work item in the default browser.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Opens the work item in the default browser.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-VSTeamWorkItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="WorkItemID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies work item by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="WorkItemID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies work item by ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.WorkItem</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>You can pipe the WorkItem ID to this function.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Show-VSTeamWorkItem -ProjectName Demo -Id 3</dev:code> <dev:remarks> <maml:para>This command will open a web browser with the summary of work item 3.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamWorkItem</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamWorkItem</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamWorkItem</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamWorkItem</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-VSTeamBuild</command:name> <command:verb>Stop</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Allows you to cancel a running build.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stop-VSTeamBuild will cancel a build using the build id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-VSTeamBuild</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>BuildId</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Stop-VSTeamBuild -id 1</dev:code> <dev:remarks> <maml:para>This example cancels the build with build id 1.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo $buildsToCancel = Get-VSTeamBuild -StatusFilter "inProgress" | where-object definitionName -eq Build-Definition-Name ForEach($build in $buildsToCancel) { Stop-VSTeamBuild -id $build.id }</dev:code> <dev:remarks> <maml:para>This example will find all builds with a status of "inProgress" and a definitionName of "Build-Definition-Name" and then cancel each of these builds.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-VSTeamMembership</command:name> <command:verb>Test</command:verb> <command:noun>VSTeamMembership</command:noun> <maml:description> <maml:para>Tests the membership in a container.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests the membership in a container.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VSTeamMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>MemberDescriptor</maml:name> <maml:description> <maml:para>A member descriptor retrieved by Get-VsTeamUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>ContainerDescriptor</maml:name> <maml:description> <maml:para>A container descriptor retrieved by Get-VsTeamGroup.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$UserDescriptor = 'aad.OTcyOTJkNzYtMjc3Yi03OTgxLWIzNDMtNTkzYmM3ODZkYjlj' $GroupDescriptor = 'vssgp.Uy0xLTktMTU1MTM3NDI0NS04NTYwMDk3MjYtNDE5MzQ0MjExNy0yMzkwNzU2MTEwLTI3NDAxNjE4MjEtMC0wLTAtMC0x' Test-VSTeamMembership -MemberDescriptor $UserDescriptor -ContainerDescriptor $GroupDescriptor</dev:code> <dev:remarks> <maml:para>Tests if the user with the email $UserDescriptor is a member of the group $GroupDescriptor.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$UserDescriptor = 'aad.OTcyOTJkNzYtMjc3Yi03OTgxLWIzNDMtNTkzYmM3ODZkYjlj' $GroupDescriptor = 'vssgp.Uy0xLTktMTU1MTM3NDI0NS04NTYwMDk3MjYtNDE5MzQ0MjExNy0yMzkwNzU2MTEwLTI3NDAxNjE4MjEtMC0wLTAtMC0x' $membershipExists = Test-VSTeamMembership -MemberDescriptor $UserDescriptor -ContainerDescriptor $GroupDescriptor if ($membershipExists) { Write-Output "User is a member of the group." } else { Write-Output "User is not a member of the group." }</dev:code> <dev:remarks> <maml:para>Tests if the user with the $UserDescriptor is a member of the group $GroupDescriptor and outputs a message based on the result.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VsTeamUser</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VsTeamMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VsTeamMembership</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VsTeamMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-VSTeamYamlPipeline</command:name> <command:verb>Test</command:verb> <command:noun>VSTeamYamlPipeline</command:noun> <maml:description> <maml:para>Validates the local YAML pipeline against Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Validates the local YAML pipeline against Azure DevOps.</maml:para> <maml:para> Now, you can try out a YAML pipeline without committing it to a repo or running it. Given an existing pipeline and an optional new YAML payload, this function will give you back the fully compiled YAML pipeline including templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-VSTeamYamlPipeline</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the YAML pipeline to be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the file that should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>branch name of the remote repository where the YAML file should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>YamlOverride</maml:name> <maml:description> <maml:para>YAML content that should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the YAML pipeline to be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Path to the file that should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>branch name of the remote repository where the YAML file should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>YamlOverride</maml:name> <maml:description> <maml:para>YAML content that should be checked</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>FilePath</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Int32</maml:name> </dev:type> <maml:description> <maml:para>PipelineId</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.YamlPipelineResult</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Currently the API that is used by this cmdlet is only supporting YAML pipelines without template references. This will be supported soon. see the issue in GitHub: https://github.com/microsoft/azure-pipelines-yaml/issues/34#issuecomment-591092498 (https://github.com/microsoft/azure-pipelines-yaml/issues/34#issuecomment-591092498)This cmdlet is not starting a pipeline run, but rather trying to resolve the full YAML code. It will not check if the task themselves work. See here for more info https://www.razorspoint.com/2020/03/13/how-to-preview-and-test-a-changing-yaml-pipeline-on-azure-devops/ (https://www.razorspoint.com/2020/03/13/how-to-preview-and-test-a-changing-yaml-pipeline-on-azure-devops/)Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24 -FilePath './azure-pipelines.yml'</dev:code> <dev:remarks> <maml:para>This example checks the YAML pipeline with ID 24 and the file './azure-pipelines.yml' for consistency on Azure DevOps to see if the changes still work.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$yamlOverride = [string](Get-Content -raw $FilePath) Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24 -YamlOverride $yamlOverride</dev:code> <dev:remarks> <maml:para>This example checks the YAML pipeline with ID 24 and the content of a yaml file in the variable $yamlOverride for consistency on Azure DevOps to see if the changes still work.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24 -Branch 'main'</dev:code> <dev:remarks> <maml:para>This example checks the YAML in the remote repository connected to the pipeline with ID 24 for consistency on Azure DevOps. It will take the file for the branch 'main'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24 - Branch 'refs/heads/feature/test'</dev:code> <dev:remarks> <maml:para>This example checks the YAML in the remote repository connected to the pipeline with ID 24 for consistency on Azure DevOps. It will take the file for the branch ref 'refs/heads/feature/test'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>Test-VSTeamYamlPipeline -Project DemoProject -PipelineId 24</dev:code> <dev:remarks> <maml:para>This example checks the YAML file pipeline with ID 24 for consistency on Azure DevOps to see if the existing YAML of the pipeline works.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamBuildDefinition</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamBuildDefinition</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeam</command:name> <command:verb>Update</command:verb> <command:noun>VSTeam</command:noun> <maml:description> <maml:para>Updates the team name, description or both.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the team name, description or both.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Id, TeamToUpdate, TeamId, TeamName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team to update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewTeamName</maml:name> <maml:description> <maml:para>The new name of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The new description of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="Id, TeamToUpdate, TeamId, TeamName"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the team to update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewTeamName</maml:name> <maml:description> <maml:para>The new name of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The new description of the team</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Description</maml:para> <maml:para>Name</maml:para> <maml:para>NewTeamName</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Team</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeam -Name "OldTeamName" -NewTeamName "NewTeamName"</dev:code> <dev:remarks> <maml:para>Updates the team name from "OldTeamName" to "NewTeamName".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeam -Name "TeamName" -Description "Updated Team Description"</dev:code> <dev:remarks> <maml:para>Updates the description of the team named "TeamName" to "Updated Team Description".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Update-VSTeam -Name "TeamName" -NewTeamName "NewTeamName" -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Updates the team name within the "MyProject" project from "TeamName" to "NewTeamName".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Update-VSTeam -Name "TeamName" -NewTeamName "NewTeamName" -Force</dev:code> <dev:remarks> <maml:para>Updates the team name from "TeamName" to "NewTeamName" and forces the update without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamAgent</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamAgent</command:noun> <maml:description> <maml:para>Instructs the agent to download and install the lastest version of the agent on self-hosted agents.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Instructs the agent to download and install the lastest version of the agent on self-hosted agents.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamAgent</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to Update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>Id of the pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="AgentID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the agent to Update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int[]</command:parameterValue> <dev:type> <maml:name>int[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamAgent -PoolId 101 -Id 2021</dev:code> <dev:remarks> <maml:para>Updates the agent with ID `2021` in the pool with ID `101`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$agentIds = 2021, 2022, 2023 Update-VSTeamAgent -PoolId 101 -Id $agentIds</dev:code> <dev:remarks> <maml:para>Updates multiple agents with IDs `2021`, `2022`, and `2023` in the pool with ID `101`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Update-VSTeamAgent -PoolId 101 -Id 2021 -Force</dev:code> <dev:remarks> <maml:para>Updates the agent with ID `2021` in the pool with ID `101` and forces the update without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamArea</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamArea</command:noun> <maml:description> <maml:para>Updates the area name in a project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the area name in a project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamArea</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name of the existing area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing area for which the name will be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name of the existing area.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing area for which the name will be changed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Add-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamArea -ProjectName Demo -Name "NewAreaName" -Path "MyArea/Path"</dev:code> <dev:remarks> <maml:para>This command updates an area with the specified path to the name NewAreaName (which will change the path) in the Demo project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeamArea -Name "NewAreaName" -Path "MyArea/Path"</dev:code> <dev:remarks> <maml:para>This command updates an area with the specified path to the name NewAreaName (which will change the path) in the default project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamIteration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamBanner</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamBanner</command:noun> <maml:description> <maml:para>Updates an existing banner message in an Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing banner message in an Azure DevOps organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamBanner</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of the banner message. The acceptable values for this parameter are:</maml:para> <maml:para>- info</maml:para> <maml:para>- warning</maml:para> <maml:para>- error</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message content to be displayed on the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The expiration date of the banner in the format `yyyy-mm-ddThh:mm`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Level</maml:name> <maml:description> <maml:para>The level of the banner message. The acceptable values for this parameter are:</maml:para> <maml:para>- info</maml:para> <maml:para>- warning</maml:para> <maml:para>- error</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The message content to be displayed on the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExpirationDate</maml:name> <maml:description> <maml:para>The expiration date of the banner in the format `yyyy-mm-ddThh:mm`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The unique identifier for the banner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamBanner -Level warning -Message 'Updated Message' -ExpirationDate '2024-01-01T05:00' -Id '9547ed55-66e1-403d-95aa-9e628726861c'</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamBanner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamBanner</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamBanner</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamBuild</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamBuild</command:noun> <maml:description> <maml:para>Allows you to set the keep forever flag and build number.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows you to set the keep forever flag and build number.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamBuild</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>The value you want to set as the build number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeepForever</maml:name> <maml:description> <maml:para>$True or $False to set the keep forever property of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>BuildNumber</maml:name> <maml:description> <maml:para>The value you want to set as the build number.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="BuildID"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>KeepForever</maml:name> <maml:description> <maml:para>$True or $False to set the keep forever property of the build.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Build</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamBuild | Update-VSTeamBuild -KeepForever $false</dev:code> <dev:remarks> <maml:para>Sets the keep forever property of every build to false.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamBuildDefinition</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamBuildDefinition</command:noun> <maml:description> <maml:para>Updates a build definition for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads a JSON file off disk or string and uses that file to update an existing build definition in the provided project.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the build definition to update by ID.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamBuildDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>JSON string of build definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the build definition to update by ID.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the build definition to update by ID.</maml:para> <maml:para>To find the ID of a build definition, type Get-VSTeamBuildDefinition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>BuildDefinition</maml:name> <maml:description> <maml:para>JSON string of build definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamBuildDefinition -ProjectName Demo -Id 123 -InFile build.json</dev:code> <dev:remarks> <maml:para>This command reads build.json and updates existing build definition with id 123 from it on the demo team project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$b = Get-VSTeamBuildDefinition -ProjectName Demo -Id 23 -Raw $b.variables.subscriptionId.value = 'Some New Value' $body = $b | ConvertTo-Json -Depth 100 Update-VSTeamBuildDefinition -ProjectName Demo -Id 23 -BuildDefinition $body</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamClassificationNode</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamClassificationNode</command:noun> <maml:description> <maml:para>Updates a pre-existing iteration or area in the project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a pre-existing iteration or area in the project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamClassificationNode</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">iterations</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">areas</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name for the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StructureGroup</maml:name> <maml:description> <maml:para>Structure group of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the classification node.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is the base function for Update-VSTeamArea and Update-VSTeamIteration.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamClassificationNode -ProjectName Demo -Name "NewIteration" -StructureGroup "iterations" -Path "MyIteration/Path"</dev:code> <dev:remarks> <maml:para>This command updates a pre-existing iteration at the path MyIteration/Path with the new name NewIteration (which will change the path) within the Demo project. Additionally, because no dates are specified, if any dates did previously exist, they would be "unset."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeamClassificationNode -ProjectName "Demo" -FinishDate (Get-Date "31.01.2020") -StartDate (Get-Date "01.01.2020") -Name "NewIteration" -StructureGroup "iterations" -Path "MyIteration/Path"</dev:code> <dev:remarks> <maml:para>This command updates a pre-existing iteration at the path MyIteration/Path with the new name NewIteration (which will change the path), the start date 01.01.2020, and finish date 31.01.2020 within the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamIteration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamIteration</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamIteration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamExtension</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamExtension</command:noun> <maml:description> <maml:para>Update an installed extension. Typically this API is used to enable or disable an extension.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update an installed extension. Typically this API is used to enable or disable an extension.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamExtension</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionState</maml:name> <maml:description> <maml:para>The state of an installed extension. Example: "disabled". The acceptable values for this parameter are:</maml:para> <maml:para>- none</maml:para> <maml:para>- disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PublisherId</maml:name> <maml:description> <maml:para>The id of the publisher.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionId</maml:name> <maml:description> <maml:para>The id of the extension.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ExtensionState</maml:name> <maml:description> <maml:para>The state of an installed extension. Example: "disabled". The acceptable values for this parameter are:</maml:para> <maml:para>- none</maml:para> <maml:para>- disabled</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "disabled"</dev:code> <dev:remarks> <maml:para>Disables the extension "MyExtension" from the publisher "Contoso".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "none"</dev:code> <dev:remarks> <maml:para>Sets the extension state to "none" for the extension "MyExtension" from the publisher "Contoso".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Update-VSTeamExtension -PublisherId "Contoso" -ExtensionId "MyExtension" -ExtensionState "disabled" -Force</dev:code> <dev:remarks> <maml:para>Disables the extension "MyExtension" from the publisher "Contoso" and forces the update without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamExtension</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamExtension</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamExtension</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamGitRepositoryDefaultBranch</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamGitRepositoryDefaultBranch</command:noun> <maml:description> <maml:para>Update the default branch of an existing respository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update the default branch of an existing respository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamGitRepositoryDefaultBranch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>The name of the project which the target repository is a part of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>DefaultBranch</maml:name> <maml:description> <maml:para>The new branch name to apply to the target repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>The name of the project which the target repository is a part of.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the target repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true #(ByPropertyName)" position="named" aliases="none"> <maml:name>DefaultBranch</maml:name> <maml:description> <maml:para>The new branch name to apply to the target repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamGitRepositoryDefaultBranch -ProjectName MyProject -Name MyRepo -DefaultBranch develop</dev:code> <dev:remarks> <maml:para>This command sets the default branch for the 'MyRepo' git repository in the 'MyProject' project to 'develop'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamIteration</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamIteration</command:noun> <maml:description> <maml:para>Updates an iteration's properties in a project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an iteration's properties in a project</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamIteration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing iteration that will be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>New name of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Path of the existing iteration that will be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>StartDate</maml:name> <maml:description> <maml:para>Start date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>FinishDate</maml:name> <maml:description> <maml:para>Finish date of the iteration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">datetime</command:parameterValue> <dev:type> <maml:name>datetime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function is a wrapper of the base function Update-VSTeamClassificationNode.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamIteration -ProjectName Demo -Name "NewIterationName" -Path "MyIteration/Path"</dev:code> <dev:remarks> <maml:para>This command updates an iteration with the specified path to the name NewIterationName (which will change the path) in the Demo project. Additionally, because no dates are specified, if any dates did previously exist, they would be "unset."</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeamArea -Name "NewIterationName" -Path "MyIteration/Path" -FinishDate "31.01.2020" -StartDate "01.01.2020"</dev:code> <dev:remarks> <maml:para>This command updates an area with the specified path to the name NewIterationName (which will change the path) in the default project with the start date 01.01.2020 and finish date 31.01.2020.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamClassificationNode</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamArea</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamArea</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-VSTeamClassificationNode</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamClassificationNode</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamNuGetPackageVersion</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamNuGetPackageVersion</command:noun> <maml:description> <maml:para>Set mutable state on a package version.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set mutable state on a package version.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamNuGetPackageVersion</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Name of the package to update. This cannot be the id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Version"> <maml:name>PackageVersion</maml:name> <maml:description> <maml:para>Version of the package to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="feedName"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Name or Id of the feed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PackageName</maml:name> <maml:description> <maml:para>Name of the package to update. This cannot be the id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="Version"> <maml:name>PackageVersion</maml:name> <maml:description> <maml:para>Version of the package to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IsListed</maml:name> <maml:description> <maml:para>Indicates the listing state of a package.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-VSTeamPackageVersion -feedName ber -packageId 0d64db64-c7b7-412e-83f4-68c5f2bfc3d8 | Update-VSTeamNuGetPackageVersion -FeedId ber -PackageName Trackyon.Ber -isListed $false</dev:code> <dev:remarks> <maml:para>This command un-lists every version of Trackyon.Ber in the ber feed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamPackage</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPackage</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPackageVersion</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPackageVersion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamPolicy</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamPolicy</command:noun> <maml:description> <maml:para>Updates an existing policy in the specified project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing policy in the specified project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamPolicy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the policy to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>Specifies the id of the type of policy to be update. This must match the original policy, it cannot be changed via this call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Enables the policy</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>blocking</maml:name> <maml:description> <maml:para>Determines if the policy will block pushes to the branch if the policy is not adhered to.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>settings</maml:name> <maml:description> <maml:para>The settings for the policy.</maml:para> <maml:para>Each policy type has it's own settings that will need to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the policy to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int</command:parameterValue> <dev:type> <maml:name>Int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>type</maml:name> <maml:description> <maml:para>Specifies the id of the type of policy to be update. This must match the original policy, it cannot be changed via this call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>enabled</maml:name> <maml:description> <maml:para>Enables the policy</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>blocking</maml:name> <maml:description> <maml:para>Determines if the policy will block pushes to the branch if the policy is not adhered to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>settings</maml:name> <maml:description> <maml:para>The settings for the policy.</maml:para> <maml:para>Each policy type has it's own settings that will need to be set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamPolicy -ProjectName Demo -id 1 -type 687c53f8-1a82-4e89-9a86-13d51bc4a8d5 -enabled -blocking -settings @{MinimumApproverCount = 1;Scope=@(@{repositoryId=b87c5af8-1a82-4e59-9a86-13d5cbc4a8d5; matchKind="Exact"; refName="refs/heads/trunk"})}</dev:code> <dev:remarks> <maml:para>This command updates an existing policy in the Demo project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamPolicy</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPolicy</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPolicyType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPolicyType</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamPool</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamPool</command:noun> <maml:description> <maml:para>Updates an agent pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an agent pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pool to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the pool to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoProvision</maml:name> <maml:description> <maml:para>Auto-provision this agent pool in new projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoAutoUpdates</maml:name> <maml:description> <maml:para>Turn off automatic updates of agents in the pool. Default is turned on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="PoolID"> <maml:name>Id</maml:name> <maml:description> <maml:para>Id of the pool to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">int</command:parameterValue> <dev:type> <maml:name>int</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pool to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of the pool to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoProvision</maml:name> <maml:description> <maml:para>Auto-provision this agent pool in new projects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NoAutoUpdates</maml:name> <maml:description> <maml:para>Turn off automatic updates of agents in the pool. Default is turned on.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamPool -Id 13 -Name "UpdatedTestPoolName" -Description "Test Description" -AutoProvision -NoAutoUpdates</dev:code> <dev:remarks> <maml:para>Updates the pool with id 13 with the name new "UpdatedTestPoolName" that is auto-provisioning to every project and agent software is not updating automatically.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamPool</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamPool</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamPool</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamProfile</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamProfile</command:noun> <maml:description> <maml:para>Allows you to update the Personal Access Token for your profile.</maml:para> </maml:description> </command:details> <maml:description> <maml:para> </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the profile to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Update-VSTeamProfile command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamProfile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the profile to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>SecurePersonalAccessToken</maml:name> <maml:description> <maml:para>A secured string to capture your personal access token.</maml:para> <maml:para>This will allow you to provide your personal access token without displaying it in plain text.</maml:para> <maml:para>To use pat simply omit it from the Update-VSTeamProfile command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="2" aliases="none"> <maml:name>PersonalAccessToken</maml:name> <maml:description> <maml:para>The personal access token from AzD/TFS to use to access this account.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="3" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the profile to be updated</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamProfile -Name ProfileName</dev:code> <dev:remarks> <maml:para>You will be prompted for the account name and personal access token.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Update-VSTeamProfile -Name mydemos -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga</dev:code> <dev:remarks> <maml:para>Allows you to provide all the information on the command line.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-VSTeamProfile | Where-Object version -eq vsts | Select-Object -skip 1 | Update-VSTeamProfile -PersonalAccessToken 7a8ilh6db4aforlrnrqmdrxdztkjvcc4uhlh5vgbteserp3mziwnga -Force</dev:code> <dev:remarks> <maml:para>This will update all but the first AzD profile</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Update-VSTeamAccount</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Update-VSTeamAccount</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-VSTeamDefaultProject</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Set-VSTeamDefaultProject</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamProject</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamProject</command:noun> <maml:description> <maml:para>Updates the project name, description or both.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the project name, description or both.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ProjectId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>The visibility of the project.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">private</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">public</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewName</maml:name> <maml:description> <maml:para>The new name for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewDescription</maml:name> <maml:description> <maml:para>The new description for the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="ProjectId"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the project to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>The visibility of the project.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamProject -Name Demo -NewName aspDemo</dev:code> <dev:remarks> <maml:para>This command changes the name of your project from Demo to aspDemo.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>--------------- Example 2: Make a project public ---------------</maml:title> <dev:code>Update-VSTeamProject -Name Demo -Visibility public</dev:code> <dev:remarks> <maml:para>This command makes your project public.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamPullRequest</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamPullRequest</command:noun> <maml:description> <maml:para>Update a pull request</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update a pull request</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Draft</maml:name> <maml:description> <maml:para>Set the pull request as a draft</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set the pull request to. Valid values for this are:</maml:para> <maml:para>- abandoned</maml:para> <maml:para>- active</maml:para> <maml:para>- completed</maml:para> <maml:para>- notSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnableAutoComplete</maml:name> <maml:description> <maml:para>Set the pull requests auto complete status</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoCompleteIdentity</maml:name> <maml:description> <maml:para>The identity that enabled autocomplete. This is mandatory if -AutoComplete is set to $true</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamPullRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisableAutoComplete</maml:name> <maml:description> <maml:para>Unset the pull requests auto complete status</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="Id"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The id of the repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PullRequestId</maml:name> <maml:description> <maml:para>The id of the pull request</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>The status to set the pull request to. Valid values for this are:</maml:para> <maml:para>- abandoned</maml:para> <maml:para>- active</maml:para> <maml:para>- completed</maml:para> <maml:para>- notSet</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EnableAutoComplete</maml:name> <maml:description> <maml:para>Set the pull requests auto complete status</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AutoCompleteIdentity</maml:name> <maml:description> <maml:para>The identity that enabled autocomplete. This is mandatory if -AutoComplete is set to $true</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">VSTeamUser</command:parameterValue> <dev:type> <maml:name>VSTeamUser</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>DisableAutoComplete</maml:name> <maml:description> <maml:para>Unset the pull requests auto complete status</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Draft</maml:name> <maml:description> <maml:para>Set the pull request as a draft</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.PullRequest</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken $r = Get-VSTeamGitRepository -ProjectName project -Name demorepo Update-VSTeamPullRequest -RepositoryId $r.RepositoryId -Draft</dev:code> <dev:remarks> <maml:para>Set the pull request to be a draft</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken $r = Get-VSTeamGitRepository -ProjectName project -Name demorepo Update-VSTeamPullRequest -RepositoryId $r.RepositoryId -Status abandoned</dev:code> <dev:remarks> <maml:para>Abandon a pull request</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamRelease</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamRelease</command:noun> <maml:description> <maml:para>Allows you to update release variables for future stages to read.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows you to update release variables for future stages to read.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamRelease</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the release to update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Release</maml:name> <maml:description> <maml:para>The updated release to save in AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCustomObject</command:parameterValue> <dev:type> <maml:name>PSCustomObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the release to update</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Release</maml:name> <maml:description> <maml:para>The updated release to save in AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCustomObject</command:parameterValue> <dev:type> <maml:name>PSCustomObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.Release</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw $r.variables.temp.value='temp' Update-VSTeamRelease -ProjectName project -Id 76 -release $r</dev:code> <dev:remarks> <maml:para>Changes the variable temp on the release. This can be done in one stage and read in another stage.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamAccount -Account mydemos -Token $(System.AccessToken) -UseBearerToken $r = Get-VSTeamRelease -ProjectName project -Id 76 -Raw $r.variables | Add-Member NoteProperty temp([PSCustomObject]@{value='test'}) Update-VSTeamRelease -ProjectName project -Id 76 -release $r</dev:code> <dev:remarks> <maml:para>Adds a variable temp to the release with a value of test.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamReleaseDefinition</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamReleaseDefinition</command:noun> <maml:description> <maml:para>Updates a build definition for a team project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reads a JSON file off disk or from string and uses that file to update an existing release definition in the provided project.</maml:para> <maml:para>You must call Set-VSTeamAccount before calling this function.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamReleaseDefinition</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>ReleaseDefinition</maml:name> <maml:description> <maml:para>JSON string of release definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>Path and file name to the JSON file that contains the definition to be updated. If the path is omitted, the default is the current location.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases="none"> <maml:name>ReleaseDefinition</maml:name> <maml:description> <maml:para>JSON string of release definition.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamReleaseDefinition -ProjectName Demo -Id 123 -InFile release.json</dev:code> <dev:remarks> <maml:para>This command reads release.json and updates existing release definition with id 123 from it on the demo team project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$b = Get-VSTeamReleaseDefinition -ProjectName Demo -Id 23 -Raw $b.variables.subscriptionId.value = 'Some New Value' $body = $b | ConvertTo-Json -Depth 100 Update-VSTeamReleaseDefinition -ProjectName Demo -ReleaseDefinition $body</dev:code> <dev:remarks> <maml:para>This commands update the variables of the release definition.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamServiceEndpoint</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamServiceEndpoint</command:noun> <maml:description> <maml:para>Updates an existing service connection</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing service connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamServiceEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>UUID of existing services endpoint from AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>Hashtable of payload for REST call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="1" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>UUID of existing services endpoint from AzD</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>Object</maml:name> <maml:description> <maml:para>Hashtable of payload for REST call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <command:returnValue> <dev:type> <maml:name>vsteam_lib.ServiceEndpoint</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$endpointPayload = @{ name = "MyNewEndpoint"; type = "generic"; url = "https://api.endpoint.com"; isShared = $false } Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload</dev:code> <dev:remarks> <maml:para>Updates the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$endpointPayload = @{ name = "MyNewEndpoint"; type = "generic"; url = "https://api.endpoint.com"; isShared = $false } Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload -ProjectName "MyProject"</dev:code> <dev:remarks> <maml:para>Updates the service endpoint within the "MyProject" project with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$endpointPayload = @{ name = "MyNewEndpoint"; type = "generic"; url = "https://api.endpoint.com"; isShared = $false } Update-VSTeamServiceEndpoint -Id "12345678-abcd-1234-abcd-1234567890ab" -Object $endpointPayload -Force</dev:code> <dev:remarks> <maml:para>Updates the service endpoint with ID `12345678-abcd-1234-abcd-1234567890ab` with the specified properties in the `$endpointPayload` hashtable and forces the update without any confirmation prompts.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamServiceFabricEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamServiceFabricEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamSonarQubeEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamSonarQubeEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamKubernetesEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamKubernetesEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-VSTeamAzureRMServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamAzureRMServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamServiceEndpointType</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamServiceEndpointType</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamServiceEndpoint</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamServiceEndpoint</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamTaskGroup</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamTaskGroup</command:noun> <maml:description> <maml:para>Updates an existing task group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing task group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamTaskGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>The path to the json file that represents the task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamTaskGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>InFile</maml:name> <maml:description> <maml:para>The path to the json file that represents the task group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$projectName = "projectName" $taskGroup = Get-VSTeamTaskGroup -Name "taskGroupName" -ProjectName $projectName # Make some change, e.g. $taskGroup.description = "new description" $taskGroupJson = ConvertTo-Json -InputObject $taskGroup -Depth 10 Update-VSTeamTaskGroup -ProjectName $projectName -Id $taskGroup.id -Body $taskGroupJson</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamTaskGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamTaskGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamTaskGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamUserEntitlement</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamUserEntitlement</command:noun> <maml:description> <maml:para>Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Type of Account License you want to change to. The acceptable values for this parameter are:</maml:para> <maml:para>- Advanced</maml:para> <maml:para>- EarlyAdopter</maml:para> <maml:para>- Express</maml:para> <maml:para>- None</maml:para> <maml:para>- Professional</maml:para> <maml:para>- StakeHolder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicensingSource</maml:name> <maml:description> <maml:para>Source of the license. The acceptable values for this parameter are: - account</maml:para> <maml:para>- auto</maml:para> <maml:para>- msdn</maml:para> <maml:para>- none</maml:para> <maml:para>- profile</maml:para> <maml:para>- trial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MSDNLicenseType</maml:name> <maml:description> <maml:para>MSDN license type. The acceptable values for this parameter are: - eligible</maml:para> <maml:para>- enterprise</maml:para> <maml:para>- none</maml:para> <maml:para>- platforms</maml:para> <maml:para>- premium</maml:para> <maml:para>- professional</maml:para> <maml:para>- testProfessional</maml:para> <maml:para>- ultimate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamUserEntitlement</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email address of the user to update. For organizations with over 100 users this can be very slow and resource intensive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Type of Account License you want to change to. The acceptable values for this parameter are:</maml:para> <maml:para>- Advanced</maml:para> <maml:para>- EarlyAdopter</maml:para> <maml:para>- Express</maml:para> <maml:para>- None</maml:para> <maml:para>- Professional</maml:para> <maml:para>- StakeHolder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicensingSource</maml:name> <maml:description> <maml:para>Source of the license. The acceptable values for this parameter are: - account</maml:para> <maml:para>- auto</maml:para> <maml:para>- msdn</maml:para> <maml:para>- none</maml:para> <maml:para>- profile</maml:para> <maml:para>- trial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MSDNLicenseType</maml:name> <maml:description> <maml:para>MSDN license type. The acceptable values for this parameter are: - eligible</maml:para> <maml:para>- enterprise</maml:para> <maml:para>- none</maml:para> <maml:para>- platforms</maml:para> <maml:para>- premium</maml:para> <maml:para>- professional</maml:para> <maml:para>- testProfessional</maml:para> <maml:para>- ultimate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the user to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Email</maml:name> <maml:description> <maml:para>The email address of the user to update. For organizations with over 100 users this can be very slow and resource intensive.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>License</maml:name> <maml:description> <maml:para>Type of Account License you want to change to. The acceptable values for this parameter are:</maml:para> <maml:para>- Advanced</maml:para> <maml:para>- EarlyAdopter</maml:para> <maml:para>- Express</maml:para> <maml:para>- None</maml:para> <maml:para>- Professional</maml:para> <maml:para>- StakeHolder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>LicensingSource</maml:name> <maml:description> <maml:para>Source of the license. The acceptable values for this parameter are: - account</maml:para> <maml:para>- auto</maml:para> <maml:para>- msdn</maml:para> <maml:para>- none</maml:para> <maml:para>- profile</maml:para> <maml:para>- trial</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MSDNLicenseType</maml:name> <maml:description> <maml:para>MSDN license type. The acceptable values for this parameter are: - eligible</maml:para> <maml:para>- enterprise</maml:para> <maml:para>- none</maml:para> <maml:para>- platforms</maml:para> <maml:para>- premium</maml:para> <maml:para>- professional</maml:para> <maml:para>- testProfessional</maml:para> <maml:para>- ultimate</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Update-VSTeamUserEntitlement -Id "12345" -License "Professional"</dev:code> <dev:remarks> <maml:para>This example updates the license type of a user with ID "12345" to "Professional".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Update-VSTeamUserEntitlement -Email "user@example.com" -License "StakeHolder"</dev:code> <dev:remarks> <maml:para>This example updates the license type of a user with email "user@example.com" to "StakeHolder".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamUserEntitlement</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamUserEntitlement</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamVariableGroup</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamVariableGroup</command:noun> <maml:description> <maml:para>Updates an existing variable group</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an existing variable group</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The variable group description</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProviderData</maml:name> <maml:description> <maml:para>The variable group ProviderData. This parameter is not available in TFS2017. This should be $null for Vsts types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The variable group type. This parameter is not available in TFS2017; all variable groups are type Vsts in this case.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Vsts</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AzureKeyVault</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>The variable group variables.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-VSTeamVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Does not prompt</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>ID of the existing variable group</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The variable group description</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The variable group name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProviderData</maml:name> <maml:description> <maml:para>The variable group ProviderData. This parameter is not available in TFS2017. This should be $null for Vsts types.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Type</maml:name> <maml:description> <maml:para>The variable group type. This parameter is not available in TFS2017; all variable groups are type Vsts in this case.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Variables</maml:name> <maml:description> <maml:para>The variable group variables.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>The json that represents the task group as a string</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.Collections.Hashtable</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>$methodParameters = @{ ProjectName = "some_project_name" Name = "new_variable_group" Description = "Describe the Variable Group" Type = "Vsts" Variables = @{ key1 = @{ value = "value1" isSecret = $true } } } $newVariableGroup = Add-VSTeamVariableGroup @methodParameters $methodParameters = @{ id = $newVariableGroup.id ProjectName = "some_project_name" Name = "new_variable_group" Description = "Describe the Variable Group" Type = "AzureKeyVault" Variables = @{ name_of_existing_secret = @{ enabled = $true contentType = "" value = "" isSecret = $true } } ProviderData = @{ serviceEndpointId = "AzureRMServiceEndpointGuid" vault = "name_of_existing_key_vault" } } Update-VSTeamVariableGroup @methodParameters</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code># Copy variable group varGroupName from project sourceProjectName to project targetProjectName. If varGroupName already exists, we'll update it; else, we'll add it. $Name = "varGroupName" $FromProject = "sourceProjectName" $ToProject = "targetProjectName" $FromVariableGroupObject = Get-VSTeamVariableGroup -Name $Name -ProjectName $FromProject $body = ConvertTo-Json -InputObject $FromVariableGroupObject -Depth 100 -Compress $toVariableGroupObject = Get-VSTeamVariableGroup -Name $Name -ProjectName $ToProject if ($toVariableGroupObject) { Update-VSTeamVariableGroup -Body $body -ProjectName $ToProject -Id $toVariableGroupObject.id } else { Add-VSTeamVariableGroup -Body $body -ProjectName $ToProject }</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Add-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Add-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamVariableGroup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamVariableGroup</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamVariableGroup</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamWorkItem</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamWorkItem</command:noun> <maml:description> <maml:para>Update a work item in your project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Update-VSTeamWorkItem will update a new work item in your project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamWorkItem</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the work item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>The IterationPath of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>The email address of the user this work item will be assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalFields</maml:name> <maml:description> <maml:para>Hashtable which contains a key value pair of any field that should be filled with values. Key is the internal name of the field and the value is the content of the field being filled. E.g. the internal name for the area path is 'System.AreaPath'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName, ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the work item.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>The title of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The Description of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>IterationPath</maml:name> <maml:description> <maml:para>The IterationPath of the work item</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AssignedTo</maml:name> <maml:description> <maml:para>The email address of the user this work item will be assigned to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>AdditionalFields</maml:name> <maml:description> <maml:para>Hashtable which contains a key value pair of any field that should be filled with values. Key is the internal name of the field and the value is the content of the field being filled. E.g. the internal name for the area path is 'System.AreaPath'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>ProjectName</maml:para> <maml:para>WorkItemType</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Any of the basic work item parameters defined in this method, will cause an exception if also added to the parameter AdditionalFields, since it is redundant. Either only use the parameter OR define them in the AdditionalFields parameter.</maml:para> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Update-VSTeamWorkItem -WorkItemId 1 -Title "Updated Work Item" ID Title Status -- ----- ------ 6 Updated Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo Update-VSTeamWorkItem -Title "Updated Work Item" -WorkItemType Task -Description "This is a description" ID Title Status -- ----- ------ 6 Updated Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Set-VSTeamDefaultProject Demo $additionalFields = @{"System.Tags"= "TestTag"; "System.AreaPath" = "Project\\MyPath"} Update-VSTeamWorkItem -Title "Updated Work Item" -WorkItemType Task -Description "This is a description" -AdditionalFields $additionalFields ID Title Status -- ----- ------ 6 Updated Work Item To Do</dev:code> <dev:remarks> <maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-VSTeamWorkItemTag</command:name> <command:verb>Update</command:verb> <command:noun>VSTeamWorkItemTag</command:noun> <maml:description> <maml:para>Gets a work item tag</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates a work item tag.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-VSTeamWorkItemTag</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Specifies the team project for which this function operates.</maml:para> <maml:para>You can tab complete from a list of available projects.</maml:para> <maml:para>You can use Set-VSTeamDefaultProject to set a default project so you do not have to pass the ProjectName with each call.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>TagIdOrName</maml:name> <maml:description> <maml:para>Name or ID of the tag to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>NewTagName</maml:name> <maml:description> <maml:para>New name for the tag</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false"> </command:parameterValue> <dev:type> <maml:name> </maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces the function without confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the function runs. The function is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the function.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Prerequisites:</maml:para> <maml:para>Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.</maml:para> <maml:para>tips:</maml:para> <maml:para>* check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo</maml:para> <maml:para>* use Set-VSTeamDefaultProject to set default project for every call</maml:para> <maml:para>* use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.</maml:para> <maml:para>* use Profiles to load an account and the correct version</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Update-VSTeamWorkItemTag -TagName</dev:code> <dev:remarks> <maml:para>This will update a specific work item tag within the current project</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Get-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-VSTeamWorkItemTag</maml:linkText> <maml:uri>https://methodsandpractices.github.io/vsteam-docs/docs/modules/vsteam/commands/Remove-VSTeamWorkItemTag</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |