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 use |