en-US/ADOPS-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>Connect-ADOPS</command:name> <command:verb>Connect</command:verb> <command:noun>ADOPS</command:noun> <maml:description> <maml:para>Establish a connection to Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Establish a OAuth connection to one or more Azure DevOps organizations. If the logged on user does not have access to the given organization you may need to specify TenantID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-ADOPS</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using an interactive browser login.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization or url of the organization like `https://dev.azure.com/MyOrg/`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipVerification</maml:name> <maml:description> <maml:para>This switch is necessary to set when using System.AccessToken as OAuth token in Azure DevOps. This will bypass the access verification. If this flag is set we will not check if the provided account can access the selected organization, and there may be access errors when API calls are made.</maml: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>TenantId</maml:name> <maml:description> <maml:para>Specify a tenant to connect to, by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-ADOPS</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using a managed identity.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization or url of the organization like `https://dev.azure.com/MyOrg/`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipVerification</maml:name> <maml:description> <maml:para>This switch is necessary to set when using System.AccessToken as OAuth token in Azure DevOps. This will bypass the access verification. If this flag is set we will not check if the provided account can access the selected organization, and there may be access errors when API calls are made.</maml: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>TenantId</maml:name> <maml:description> <maml:para>Specify a tenant to connect to, by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Connect-ADOPS</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OAuthToken</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using an existing access 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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization or url of the organization like `https://dev.azure.com/MyOrg/`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipVerification</maml:name> <maml:description> <maml:para>This switch is necessary to set when using System.AccessToken as OAuth token in Azure DevOps. This will bypass the access verification. If this flag is set we will not check if the provided account can access the selected organization, and there may be access errors when API calls are made.</maml: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>TenantId</maml:name> <maml:description> <maml:para>Specify a tenant to connect to, by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Interactive</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using an interactive browser login.</maml:para> </maml:description> <command:parameterValue required="false" 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>ManagedIdentity</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using a managed identity.</maml:para> </maml:description> <command:parameterValue required="false" 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>OAuthToken</maml:name> <maml:description> <maml:para>Connect to an Azure DevOps organization using an existing access 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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization or url of the organization like `https://dev.azure.com/MyOrg/`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipVerification</maml:name> <maml:description> <maml:para>This switch is necessary to set when using System.AccessToken as OAuth token in Azure DevOps. This will bypass the access verification. If this flag is set we will not check if the provided account can access the selected organization, and there may be access errors when API calls are made.</maml:para> </maml:description> <command:parameterValue required="false" 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>TenantId</maml:name> <maml:description> <maml:para>Specify a tenant to connect to, by id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Connect-ADOPS -Organization 'ADOPS'</dev:code> <dev:remarks> <maml:para>Connect to an Azure DevOps organization interactively.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Connect-ADOPS -ManagedIdentity -Organization 'ADOPS' -TenantId $TenantId</dev:code> <dev:remarks> <maml:para>Connect to an Azure DevOps organization using a managed identity, specifying the tenant.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Connect-ADOPS -OAuthToken $AccessToken -Organization 'ADOPS' -SkipVerification</dev:code> <dev:remarks> <maml:para>Connect to an Azure DevOps organization using an existing access token. It will not verify that the token has access to the selected organization, and may result in failed API calls.</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>Disconnect-ADOPS</command:name> <command:verb>Disconnect</command:verb> <command:noun>ADOPS</command:noun> <maml:description> <maml:para>Remove an established connection to Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove an established connection to Azure DevOps.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-ADOPS</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Disconnect-ADOPS -Organization 'ADOPS'</dev:code> <dev:remarks> <maml:para>Removes the established connection to the organization "ADOPS".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Disconnect-ADOPS</dev:code> <dev:remarks> <maml:para>Removes the established connection without specifying organization, if there is only one.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSArtifactFeed</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSArtifactFeed</command:noun> <maml:description> <maml:para>Gets one or more artifact feeds</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets one or more artifact feeds. If a project is given returns project scoped feeds. If no project is given it returns organization and project scoped feeds.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSArtifactFeed</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Id of feed to get. GUID format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to get feed(s) 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:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSArtifactFeed</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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>Project</maml:name> <maml:description> <maml:para>Project to get feed(s) 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Id of feed to get. GUID format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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>Project</maml:name> <maml:description> <maml:para>Project to get feed(s) 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSArtifactFeed</dev:code> <dev:remarks> <maml:para>This command returns the all feeds in the organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSArtifactFeed -Project 'MyProject' -FeedId '222cc2c2-2cc2-222c-c2c2-c22cc222222c'</dev:code> <dev:remarks> <maml:para>This command returns the feed with feed id '222cc2c2-2cc2-222c-c2c2-c22cc222222c'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSAuditActions</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSAuditActions</command:noun> <maml:description> <maml:para>Gets all actions that Azure DevOps can log.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This commands lists all actions that Azure DevOps gets in the audit log. https://learn.microsoft.com/en-us/azure/devops/organizations/audit/azure-devops-auditing?view=azure-devops&tabs=preview-page#review-audit-log</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSAuditActions</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get log data 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get log data 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSAuditActions</dev:code> <dev:remarks> <maml:para>This commands lists all actions that Azure DevOps gets in the audit log.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSBuildDefinition</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSBuildDefinition</command:noun> <maml:description> <maml:para>This command gets one or more build definitions.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets one or more build definitions. If will always return the full definition object in order for it to be used to update a definition. If no Id is given it will return all build definitions from the selected project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSBuildDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get definitions 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get definition 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="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>build definition id to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>build definition id to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get definitions 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get definition 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSBuildDefinition -Project myProject -Id 123</dev:code> <dev:remarks> <maml:para>This command will return the build definition with id 123. If no definition id 123 is found it will throw an error.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSBuildDefinition -Project myProject</dev:code> <dev:remarks> <maml:para>This command will return all build definitions in project myProject. If no definitions are found it will return an empty array.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $Pipeline = Get-ADOPSPipeline -Project myProject -Name myPipeline PS C:\> Get-ADOPSBuildDefinition -Project myProject -Id $Pipeline.id</dev:code> <dev:remarks> <maml:para>This command will return the build definition of the pipeline named myPipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSConnection</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSConnection</command:noun> <maml:description> <maml:para>This command gets the active ADOPS connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets the active ADOPS connection. If no connection is made it will return $null.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSConnection</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSConnection Name Value ---- ----- TenantId 97547e13-918b-47eb-a923-6e58efef2e6a Identity my.mail@address Organization MYConnectedOrg</dev:code> <dev:remarks> <maml:para>This command will output any current ADOPS connection</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSElasticPool</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSElasticPool</command:noun> <maml:description> <maml:para>Gets one or more Azure DevOps Elastic Pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or more Azure DevOps Elastic Pools.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSElasticPool</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The Id of the Azure DevOps pool.</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="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The Id of the Azure DevOps pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Get-ADOPSElasticPool -Organization ADOPS -PoolId 10</dev:code> <dev:remarks> <maml:para>Get the Azure DevOps Elastic Pool with the Id of 10 in the ADOPS organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-ADOPSElasticPool -Organization ADOPS</dev:code> <dev:remarks> <maml:para>Get all the Azure DevOps Elastic Pool in the ADOPS organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSFileContent</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSFileContent</command:noun> <maml:description> <maml:para>Gets the content of a single file in an Azure DevOps repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets the contents of a file in an Azure DevOps repository It will try to get the contents no matter the file type, and may fail if a binary or otherwise unreadable file is given.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSFileContent</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>The id (GUID) of the repository. This can be found using the command Get-ADOPSRepository -Project ProjectName -Repository RepositoryName | Select-Object -ExpandProperty id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Full path to the file which contents are read.</maml:para> </maml:description> <command:parameterValue required="true" 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="3" aliases="none"> <maml:name>FilePath</maml:name> <maml:description> <maml:para>Full path to the file which contents are read.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>The id (GUID) of the repository. This can be found using the command Get-ADOPSRepository -Project ProjectName -Repository RepositoryName | Select-Object -ExpandProperty id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSFileContent -Project MyProject -RepositoryId a1c93080-9d68-4ab9-95cf-1a5f68740628 -FilePath /MyFile.ps1</dev:code> <dev:remarks> <maml:para>This command will return the contents of the file "MyFile.ps1" located in the root of the repository "a1c93080-9d68-4ab9-95cf-1a5f68740628" in the "MyProject" project of your default logged in organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSGroup</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSGroup</command:noun> <maml:description> <maml:para>Gets all Azure DevOps groups</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command returns all Azure DevOps groups in your organization. It will not filter groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get groups 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="1" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>Internal parameter. Used to get paged results</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>Internal parameter. Used to get paged results</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get groups 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSGroup</dev:code> <dev:remarks> <maml:para>Gets all Azure DevOps groups</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSNode</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSNode</command:noun> <maml:description> <maml:para>Get one or more Elastic nodes currently in the Elastic pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get one or more Elastic nodes currently in the Elastic pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The unique Id of the Elastic pool.</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="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The unique Id of the Elastic pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Get-ADOPSNode -Organization 'ADOPS' -PoolId 10</dev:code> <dev:remarks> <maml:para>Get the elastic nodes in the elastic pool with id 10.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSPipeline</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSPipeline</command:noun> <maml:description> <maml:para>Get a specific pipeline or all pipelines in a specific DevOps project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists a specific Pipeline or all Pipelines in a Specific Project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSPipeline</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 pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Revision</maml:name> <maml:description> <maml:para>Revision of the pipeline. Omit to get latest.</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="2" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipelines 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="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipelines 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: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 pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Revision</maml:name> <maml:description> <maml:para>Revision of the pipeline. Omit to get latest.</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="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipelines 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="2" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipelines 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSPipeline -Organization $OrganizationName -Project $Project -Name $Name</dev:code> <dev:remarks> <maml:para>Get pipeline with name $Name from $Project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipeline -Organization $OrganizationName -Project $Project -Name $Name -Revision $Revision</dev:code> <dev:remarks> <maml:para>Get pipeline with name $Name and specific $Revision from $Project</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipeline -Organization $OrganizationName -Project $Project</dev:code> <dev:remarks> <maml:para>List all Pipelines in $Project</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipeline -Project $Project</dev:code> <dev:remarks> <maml:para>List all Pipelines in $Project and uses Default Organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSPipelineRetentionSettings</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSPipelineRetentionSettings</command:noun> <maml:description> <maml:para>Returns all pipeline retention settings.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will return all pipeline retention settings for a Azure DevOps Project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSPipelineRetentionSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline retention settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline retention settings 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline retention settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline retention settings 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>A Key/value custom object of all the pipeline retention values.</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>PS C:\> Get-ADOPSPipelineRetentionSettings -Project 'MyProject'</dev:code> <dev:remarks> <maml:para>This command will get all the pipeline retention settings values for a project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSPipelineSettings</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSPipelineSettings</command:noun> <maml:description> <maml:para>Returns all pipeline settings for a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will return all pipeline settings for a project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSPipelineSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline settings 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline settings 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>A key/value custom object of all pipeline settings is returned.</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>PS C:\> Get-ADOPSPipelineSettings -Project 'MyProject' enforceReferencedRepoScopedToken : True disableClassicPipelineCreation : True disableClassicBuildPipelineCreation : True disableClassicReleasePipelineCreation : True forkProtectionEnabled : True buildsEnabledForForks : True enforceJobAuthScopeForForks : True enforceNoAccessToSecretsFromForks : True isCommentRequiredForPullRequest : True requireCommentsForNonTeamMembersOnly : False requireCommentsForNonTeamMemberAndNonContributors : False enableShellTasksArgsSanitizing : True enableShellTasksArgsSanitizingAudit : False disableImpliedYAMLCiTrigger : True statusBadgesArePrivate : True enforceSettableVar : True enforceJobAuthScope : True enforceJobAuthScopeForReleases : True publishPipelineMetadata : True</dev:code> <dev:remarks> <maml:para>This command will return a value for specific setting with the name `statusBadgesArePrivate`</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSPipelineTask</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSPipelineTask</command:noun> <maml:description> <maml:para>Returns one or more pipeline tasks.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will return one or more pipeline tasks available in your organization. If no parameters is given it will return all tasks installed in your Azure DevOps environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSPipelineTask</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 task to search for. Exact matches, no wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization to search for tasks in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Version</maml:name> <maml:description> <maml:para>Major version of task(s) to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the task to search for. Exact matches, no wildcards.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization to search for tasks in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Version</maml:name> <maml:description> <maml:para>Major version of task(s) to return</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSPipelineTask</dev:code> <dev:remarks> <maml:para>This command will return all pipeline tasks and all versions available in your organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipelineTask -Name 'PowerShell'</dev:code> <dev:remarks> <maml:para>This command will return pipeline tasks with the exact name "PowerShell", All versions available in your organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipelineTask -Version 1</dev:code> <dev:remarks> <maml:para>This command will return all pipeline tasks with major version 1 available in your organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSPipelineTask -Name 'PowerShell' -Version 2</dev:code> <dev:remarks> <maml:para>This command will return the PowerShell pipeline task version 2.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSPool</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSPool</command:noun> <maml:description> <maml:para>Get one or more Azure DevOps Agent pools.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get one or more Azure DevOps Agent pools.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSPool</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeLegacy</maml:name> <maml:description> <maml:para>Includes all legacy agent pools.</maml: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>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSPool</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The Agent Pool id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSPool</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PoolName</maml:name> <maml:description> <maml:para>The name of the Agent pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeLegacy</maml:name> <maml:description> <maml:para>Includes all legacy agent pools.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>The identifier of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The Agent Pool id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PoolName</maml:name> <maml:description> <maml:para>The name of the Agent pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Get-ADOPSPool -Organization 'adops' -IncludeLegacy</dev:code> <dev:remarks> <maml:para>Get all the Azure DevOps Agent Pools in the Organization of adops and includes Legacy agent pools.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-ADOPSPool -Organization 'adops' -PoolName 'agentpool1'</dev:code> <dev:remarks> <maml:para>Get the Azure DevOps Agent Pools with the name of agentpool1 in the Organization of adops.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-ADOPSPool -Organization 'adops' -PoolId 10</dev:code> <dev:remarks> <maml:para>Get the Azure DevOps Agent Pools with the pool id of 10 in the Organization of adops.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>get-agent-pools</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get-agent-pools?view=azure-devops-rest-7.1</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSProject</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSProject</command:noun> <maml:description> <maml:para>Gets one or several projects in an Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or several projects in an Azure DevOps organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the project to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The name of the organization 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:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Project"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The name of the organization 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id (GUID) of the project to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Project"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the project to find.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The name of the organization 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSProject -Organization 'ADOPS' -Name 'ADOPSproj'</dev:code> <dev:remarks> <maml:para>Gets the project called "ADOPSproj" from the organization "ADOPS".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSProject -Name 'ADOPSproj'</dev:code> <dev:remarks> <maml:para>Gets the project called "ADOPSproj" from the default organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSRepository</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>Gets one or more repositories from a project in Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets one or more repositories from a project in Azure DevOps.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get repositories 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="1" aliases="none"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The repository to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization to get repositories 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get repositories 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="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get repositories 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="1" aliases="none"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The repository to get.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSRepository -Organization 'ADOPS' -Project 'ADOPSproj'</dev:code> <dev:remarks> <maml:para>Gets all repositories from the project "ADOPSproj" in the organization "ADOPS".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSRepository -Project 'ADOPSproj' -Repository 'ADOPSrepo'</dev:code> <dev:remarks> <maml:para>Gets the repository "ADOPSrepo" from the project "ADOPSproj", from the organization set as default amongst the established Azure DevOps connections.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSServiceConnection</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSServiceConnection</command:noun> <maml:description> <maml:para>Get a specific ServiceConnection or all ServiceConnections in a DevOps project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Lists a specific ServiceConnection or all ServiceConnections in a Project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSServiceConnection</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>Specify the name of a service connection to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project to get ServiceConnection/s 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="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get ServiceConnection/s 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: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>Specify the name of a service connection to get.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization to get ServiceConnection/s 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get ServiceConnection/s 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSServiceConnection -Organization $OrganizationName -Project $Project -Name $Name</dev:code> <dev:remarks> <maml:para>Get ServiceConnection with name $Name from $Project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSServiceConnection -Organization $OrganizationName -Project $Project</dev:code> <dev:remarks> <maml:para>List all ServiceConnection in $Project</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSServiceConnection -Project $Project</dev:code> <dev:remarks> <maml:para>List all ServiceConnection in $Project and uses Default Organization.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSUsageData</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSUsageData</command:noun> <maml:description> <maml:para>Gets the usage data of your organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets usage data for you organization, such as</maml:para> <maml:para>- Currently running requests</maml:para> <maml:para>- Limits to your resource usage</maml:para> <maml:para>- Parallel sessions</maml:para> <maml:para>- Used minutes and hosts</maml:para> <maml:para></maml:para> <maml:para>Note: This API is not public, and user data is dependent on current status, and is due to change with no notice.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSUsageData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ProjectVisibility</maml:name> <maml:description> <maml:para>List usage data for private or public projects</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="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get usage data 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>SelfHosted</maml:name> <maml:description> <maml:para>If set, returns usage data for self hosted agents. If not set, returns usage data for Microsoft hosted agents.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get usage data 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="0" aliases="none"> <maml:name>ProjectVisibility</maml:name> <maml:description> <maml:para>List usage data for private or public projects</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SelfHosted</maml:name> <maml:description> <maml:para>If set, returns usage data for self hosted agents. If not set, returns usage data for Microsoft hosted agents.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSUsageData</dev:code> <dev:remarks> <maml:para>This command will return usage statistics and data for your public projects (default), and Microsoft hosted agents (default).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSUsageData -ProjectVisibility Private -SelfHosted</dev:code> <dev:remarks> <maml:para>This command will return usage statistics and data for your private projects, and self hosted agents.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSUsageData -ProjectVisibility Public</dev:code> <dev:remarks> <maml:para>This command will return usage statistics and data for your public projects (default), and Microsoft hosted agents (default).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSUser</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSUser</command:noun> <maml:description> <maml:para>Fetch one or more users</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Fetch user(s) by name or descriptor</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>Used to fetch the new page from the API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get users 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:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>A unique descriptor ID for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get users 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:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The query that will match name, display name, email fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get users 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ContinuationToken</maml:name> <maml:description> <maml:para>Used to fetch the new page from the API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>A unique descriptor ID for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The query that will match name, display name, email fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get users 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSUser</dev:code> <dev:remarks> <maml:para>Fetch all users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSUser -Name 'john doe'</dev:code> <dev:remarks> <maml:para>Search for anyone that has `john doe` in it's name, display name or email.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSUser -Descriptor 'aad.am9obiBkb2Vqb2huIGRvZWpvaG4gZG9lam9obiBkb2U'</dev:code> <dev:remarks> <maml:para>Search for a single user that has the corresponding descriptor.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>user-entitlements/search-user-entitlements</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user-entitlements/search-user-entitlements?view=azure-devops-rest-6.0</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>users/get</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/get?view=azure-devops-rest-6.0</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>users/list</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list?view=azure-devops-rest-6.0</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSVariableGroup</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSVariableGroup</command:noun> <maml:description> <maml:para>This command gets one or more variable groups from Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command gets one or more variable groups from Azure DevOps. If no matching variable group is found it outputs nothing. Searches can be done by Name or Id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Variable group id to search for.</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>Organization</maml:name> <maml:description> <maml:para>Organization to search in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to search in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-ADOPSVariableGroup</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Variable group name to search for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization to search in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to search in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Variable group id to search for.</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>Name</maml:name> <maml:description> <maml:para>Variable group name to search for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization to search in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to search in.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSVariableGroup -Project MyAzureDevOpsProject</dev:code> <dev:remarks> <maml:para>This command will return all variable groups in the MyAzureDevOpsProject project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSVariableGroup -Project MyAzureDevOpsProject -Name MyVariableGroup</dev:code> <dev:remarks> <maml:para>This command will return the "MyVariableGroup" variable group in the MyAzureDevOpsProject project.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSVariableGroup -Project MyAzureDevOpsProject -Id 4</dev:code> <dev:remarks> <maml:para>This command will return the variable group with id 4 in the MyAzureDevOpsProject project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ADOPSWiki</command:name> <command:verb>Get</command:verb> <command:noun>ADOPSWiki</command:noun> <maml:description> <maml:para>Gets one or more wikis from a Azure DevOps project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command returns Azure DevOPs wikis from a project. If a wiki name is given it will return any wikis with that exact name. Wildcards are not supported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ADOPSWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get wiki(s) 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="1" aliases="none"> <maml:name>WikiId</maml:name> <maml:description> <maml:para>Name or ID of a specific 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="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get wikis 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get wikis 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="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get wiki(s) 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="1" aliases="none"> <maml:name>WikiId</maml:name> <maml:description> <maml:para>Name or ID of a specific wiki to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Get-ADOPSWiki -Project MyProject -WikiId MyProject.wiki</dev:code> <dev:remarks> <maml:para>This command will return the MyProject.wiki wiki from the MyProject project. If no MyProjet.wiki exists it will return nothing.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-ADOPSWiki -Project MyProject</dev:code> <dev:remarks> <maml:para>This command will return all wikis from the MyProject 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>Grant-ADOPSPipelinePermission</command:name> <command:verb>Grant</command:verb> <command:noun>ADOPSPipelinePermission</command:noun> <maml:description> <maml:para>Grants pipeline permission to a resource of type VariableGroup, Queue, SecureFile, or Environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Grants pipeline permissions to a resource of type VariableGroup, Queue, SecureFile, or Environment. Specify a PipelineId to grant permissions to a single pipeline, or use the AllPipelines parameter to grant permissions to all pipelines.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Grant-ADOPSPipelinePermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllPipelines</maml:name> <maml:description> <maml:para>Grant access for all pipelines. This is equivalent to disable the restrictions on the resource.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to grant permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to grant permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Grant-ADOPSPipelinePermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the pipeline to grant permissions for.</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>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to grant permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to grant permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</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>AllPipelines</maml:name> <maml:description> <maml:para>Grant access for all pipelines. This is equivalent to disable the restrictions on the resource.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the pipeline to grant permissions for.</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>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to grant permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to grant permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Grant-ADOPSPipelinePermission -Pipeline 42 -ResourceType SecureFile -ResourceId '88d047be-7e59-4eda-b1fe-1614c7a69e16' -Project 'MyProject'</dev:code> <dev:remarks> <maml:para>Grant pipeline 42 permission to the secure file with id 88d047be-7e59-4eda-b1fe-1614c7a69e16 in project MyProject.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-ADOPSRepository</command:name> <command:verb>Import</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>Import an external public git repo to Azure DevOps repos.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will import any public git repo using http or https git link. It requires a precreated empty git repo target. You van assign the target using repository name or repository Id</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GitSource</maml:name> <maml:description> <maml:para>The source repo to fetch. Must be a public accessable http or https link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Your Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The Azure DevOps project where your local repo exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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>Repository id where to import the GitSource. This must be an empty Azure DevOps repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If defined this command will wait for the import to complete. Default will return the process started.</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>Import-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GitSource</maml:name> <maml:description> <maml:para>The source repo to fetch. Must be a public accessable http or https link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Your Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The Azure DevOps project where your local repo exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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>Repository name where to import the GitSource. This must be an empty Azure DevOps repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If defined this command will wait for the import to complete. Default will return the process started.</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>GitSource</maml:name> <maml:description> <maml:para>The source repo to fetch. Must be a public accessable http or https link.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Your Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The Azure DevOps project where your local repo exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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>Repository id where to import the GitSource. This must be an empty Azure DevOps repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RepositoryName</maml:name> <maml:description> <maml:para>Repository name where to import the GitSource. This must be an empty Azure DevOps repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If defined this command will wait for the import to complete. Default will return the process started.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Import-ADOPSRepository -Project MyProject -GitSource https://github.com/AZDOPS/AZDOPS.git -RepositoryName MyLocalRepo</dev:code> <dev:remarks> <maml:para>This command will import all data from the `https://github.com/AZDOPS/AZDOPS.git` repo to the local Azure DevOps repo `MyLocalRepo`</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>Initialize-ADOPSRepository</command:name> <command:verb>Initialize</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>This command will initialize a newly created Azure DevOps repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will initialize a newly created Azure DevOps repository. It can do so by adding a default README.md template, Any of the existing .gitignore templates, or a custom file.</maml:para> <maml:para>If only one .gitignore template is selected it will be named ".gitignore". If more than one is selected they will be named as the templates, and they will not work right away. Combine your chosen templates in to one and update it manually.</maml:para> <maml:para>If a repository is already initiated this command will fail with any of a number of different messages depending on what files or templates are selected.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Initialize-ADOPSRepository</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Commit message to use when initializing repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Which branch to initialize. Defaults to 'refs/heads/main'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>Id (GUID) of the repository to initialize.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>NewContentTemplate</maml:name> <maml:description> <maml:para>Initialize the repo with one or more of the existing .gitignore templates. If one template is selected it will be given the name '.gitignore' If 2 or more templates are given they will be named as the template name.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Actionscript.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ada.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Agda.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Android.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AppceleratorTitanium.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AppEngine.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArchLinuxPackages.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Autotools.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">C++.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">C.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CakePHP.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CFWheels.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ChefCookbook.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Clojure.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CMake.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CodeIgniter.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CommonLisp.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Composer.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Concrete5.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Coq.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CraftCMS.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CUDA.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">D.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Dart.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delphi.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DM.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Drupal.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Eagle.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Elisp.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Elixir.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Elm.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EPiServer.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Erlang.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExpressionEngine.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ExtJs.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fancy.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Finale.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ForceDotCom.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Fortran.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FuelPHP.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">gcov.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GitBook.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Go.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Godot.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Gradle.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grails.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GWT.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Haskell.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Idris.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IGORPro.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Java.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Jboss.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Jekyll.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">JENKINS_HOME.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Joomla.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Julia.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">KiCAD.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Kohana.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Kotlin.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LabVIEW.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Laravel.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Leiningen.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LemonStand.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Lilypond.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Lithium.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Lua.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Magento.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Maven.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Mercury.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MetaProgrammingSystem.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">nanoc.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Nim.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Node.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Objective-C.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OCaml.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Opa.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">opencart.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">OracleForms.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Packer.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Perl.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Phalcon.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlayFramework.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Plone.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Prestashop.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Processing.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PureScript.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Python.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Qooxdoo.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Qt.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">R.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rails.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Raku.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RhodesRhomobile.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ROS.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ruby.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rust.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Sass.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scala.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scheme.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SCons.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scrivener.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Sdcc.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SeamGen.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SketchUp.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Smalltalk.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">stella.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SugarCRM.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Swift.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Symfony.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SymphonyCMS.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terraform.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TeX.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Textpattern.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TurboGears2.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Typo3.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Umbraco.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Unity.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UnrealEngine.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualStudio.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VVVV.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Waf.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">WordPress.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Xojo.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yeoman.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Yii.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ZendFramework.gitignore</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zephir.gitignore</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="4" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>If combined with the `-Content` parameter this will create a custom file with this content. If a path is given without `-Content` the default message 'Repo initialized using ADOPS module.' will be set in this file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>If combined with the `-Path` parameter this will create a custom file with this content.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Readme</maml:name> <maml:description> <maml:para>Initialize the repo with the default Azure DevOps README template</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Which branch to initialize. Defaults to 'refs/heads/main'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Content</maml:name> <maml:description> <maml:para>If combined with the `-Path` parameter this will create a custom file with this content.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>Commit message to use when initializing repository</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>If combined with the `-Content` parameter this will create a custom file with this content. If a path is given without `-Content` the default message 'Repo initialized using ADOPS module.' will be set in this file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Readme</maml:name> <maml:description> <maml:para>Initialize the repo with the default Azure DevOps README template</maml:para> </maml:description> <command:parameterValue required="false" 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="2" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Id (GUID) of the repository to initialize.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>NewContentTemplate</maml:name> <maml:description> <maml:para>Initialize the repo with one or more of the existing .gitignore templates. If one template is selected it will be given the name '.gitignore' If 2 or more templates are given they will be named as the template 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $r = New-ADOPSRepository -Name "myNewRepo" -Project 'myProject' -Organization 'myOrg' PS C:\> Initialize-ADOPSRepository</dev:code> <dev:remarks> <maml:para>This command will initialize the repo with only the default "README.md" template.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $r = New-ADOPSRepository -Name "myNewRepo" -Project 'myProject' -Organization 'myOrg' PS C:\> Initialize-ADOPSRepository -RepositoryId $r.id -Message 'my initial commit message' -NewContentTemplate Actionscript.gitignore, Ada.gitignore, Android.gitignore -Path '/newCustomFile.txt' -Readme</dev:code> <dev:remarks> <maml:para>This command will initialize a repository containing the files - Actionscript.gitignore</maml:para> <maml:para>- Ada.gitignore</maml:para> <maml:para>- Android.gitignore</maml:para> <maml:para>- newCustomFile.txt</maml:para> <maml:para>- README.md</maml:para> <maml:para></maml:para> <maml:para>newCustomFile.txt will contain the default message 'Repo initialized using ADOPS module.'</maml:para> <maml:para>README.md is the default readme template from Azure DevOps</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $r = New-ADOPSRepository -Name "myNewRepo" -Project 'myProject' -Organization 'myOrg' PS C:\> $content = @' This is a multiline file. It contains multiple lines, Since, by definition, if it didn't it wouldn't be a multiline file '@ PS C:\> Initialize-ADOPSRepository -RepositoryId $r.id -Path '/newCustomFile.txt' -Content $content</dev:code> <dev:remarks> <maml:para>This command will initialize the repo by creating the file 'newCustomFile.txt' in the root folder, and setting contents of the file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-ADOPSRestMethod</command:name> <command:verb>Invoke</command:verb> <command:noun>ADOPSRestMethod</command:noun> <maml:description> <maml:para>Invoke a ADOPS rest API call.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command invokes a API call to Azure DevOps using the standard ADOPS logged in account. If you do not give the full Uri to call, for example 'https://dev.azure.com/myOrganization/_api/GetStuff', it will append 'https://dev.azure.com/$Organization', where $Organization is the one you are connected to, to your URI.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-ADOPSRestMethod</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Full Uri to call, including "https://dev.azure.com/organization"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Method</maml:name> <maml:description> <maml:para>API method to use</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Get</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Head</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Post</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Put</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Delete</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Options</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Merge</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Patch</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WebRequestMethod</command:parameterValue> <dev:type> <maml:name>WebRequestMethod</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>Body</maml:name> <maml:description> <maml:para>Body to include in the API call</maml:para> </maml:description> <command:parameterValue required="true" 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="2" aliases="none"> <maml:name>Body</maml:name> <maml:description> <maml:para>Body to include in the API call</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Method</maml:name> <maml:description> <maml:para>API method to use</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WebRequestMethod</command:parameterValue> <dev:type> <maml:name>WebRequestMethod</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Uri</maml:name> <maml:description> <maml:para>Full Uri to call, including "https://dev.azure.com/organization"</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Invoke-ADOPSRestMethod -Uri "https://dev.azure.com/$Organization/_apis/distributedtask/tasks"</dev:code> <dev:remarks> <maml:para>This command will return whatever this API endpoint returns.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ADOPSRestMethod -Uri "/_apis/distributedtask/tasks"</dev:code> <dev:remarks> <maml:para>This command will append 'https://dev.azure.com/$Organization' to URI and return whatever the full API endpoint 'https://dev.azure.com/$Organization/_apis/distributedtask/tasks' returns.</maml:para> <maml:para>$Organization is taken from the current ADOPS connection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Invoke-ADOPSRestMethod -Uri "https://dev.azure.com/$Organization/_apis/distributedtask/tasks" -Method Post -Body $BodyObject</dev:code> <dev:remarks> <maml:para>This command will perform a Post call to the API endpoint. It will perform the API call using the logged in ADOPS credentials. It will include the body object in the call. It will not format or validate any of the input values.</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>New-ADOPSArtifactFeed</command:name> <command:verb>New</command:verb> <command:noun>ADOPSArtifactFeed</command:noun> <maml:description> <maml:para>This command creates a new artifact feed</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command creates a new artifact feed. It will try to add the Project build account as contributor to the feed in order for builds to be able to automatically publish packages. If -IncludeUpstream is set it will add all currently available upstreams.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSArtifactFeed</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project in which the feed 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="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Feed 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>Description</maml:name> <maml:description> <maml:para>Add a description to the feed description field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeUpstream</maml:name> <maml:description> <maml:para>Enable upstreams and add all currently available upstreams</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Add a description to the feed description field.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeUpstream</maml:name> <maml:description> <maml:para>Enable upstreams and add all currently available upstreams</maml:para> </maml:description> <command:parameterValue required="false" 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="2" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Feed 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="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project in which the feed 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSArtifactFeed -Project 'MyProject' -Name 'MyNewFeed'</dev:code> <dev:remarks> <maml:para>This command will add a new feed named `MyNewFeed` to the `MyProject` project. It will try to add the account `MyProject build service (ConnectedOrg)` as contributor. It will not enable upstreams.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSArtifactFeed -Project 'MyProject' -Name 'MyNewFeed' -IncludeUpstreams</dev:code> <dev:remarks> <maml:para>This command will add a new feed named `MyNewFeed` to the `MyProject` project. It will try to add the account `MyProject build service (ConnectedOrg)` as contributor. It will enable upstreams and add all currently available sources.</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>New-ADOPSAuditStream</command:name> <command:verb>New</command:verb> <command:noun>ADOPSAuditStream</command:noun> <maml:description> <maml:para>Sets up an audit stream from Azure DevOps to supported external logging services.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command sets up a log stream from Azure DevOps to an external supported service. It only sets up log forwarding. You need to enable logging separately from this command. (Organization settings -> Policies -> Log audit events)</maml:para> <maml:para>Supported services are - Azure Monitor</maml:para> <maml:para>- Splunk</maml:para> <maml:para>- Azure Event grid</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSAuditStream</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventGridTopicAccessKey</maml:name> <maml:description> <maml:para>Access key to Azure Eventgrid</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventGridTopicHostname</maml:name> <maml:description> <maml:para>Azure Eventgrid host to send logs to. Must start with 'http://' or 'https://'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set up forwarding 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:syntaxItem> <command:syntaxItem> <maml:name>New-ADOPSAuditStream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set up forwarding 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>SharedKey</maml:name> <maml:description> <maml:para>Azure Monitor shared access key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Azure monitor workspace ID. Must be in GUID format.</maml:para> </maml:description> <command:parameterValue required="true" 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>New-ADOPSAuditStream</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set up forwarding 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>SplunkEventCollectorToken</maml:name> <maml:description> <maml:para>Splunk event collector token. Must be in GUID format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SplunkUrl</maml:name> <maml:description> <maml:para>URL to Splunk log host. Must start with 'http://' or 'https://'</maml:para> </maml:description> <command:parameterValue required="true" 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>EventGridTopicAccessKey</maml:name> <maml:description> <maml:para>Access key to Azure Eventgrid</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EventGridTopicHostname</maml:name> <maml:description> <maml:para>Azure Eventgrid host to send logs to. Must start with 'http://' or 'https://'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set up forwarding 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>SharedKey</maml:name> <maml:description> <maml:para>Azure Monitor shared access key</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SplunkEventCollectorToken</maml:name> <maml:description> <maml:para>Splunk event collector token. Must be in GUID format.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SplunkUrl</maml:name> <maml:description> <maml:para>URL to Splunk log host. Must start with 'http://' or 'https://'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Azure monitor workspace ID. Must be in GUID format.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSAuditStream -WorkspaceId "11111111-1111-1111-1111-111111111111" -SharedKey "123456"</dev:code> <dev:remarks> <maml:para>This command sets up log forwarding to Azure Monitor using the workspace id '11111111-1111-1111-1111-111111111111' and the shared key '123456'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSAuditStream -SplunkUrl 'http://Splunkurl' -SplunkEventCollectorToken '11111111-1111-1111-1111-111111111111'</dev:code> <dev:remarks> <maml:para>This command sets up log forwarding to splunk using the token '11111111-1111-1111-1111-111111111111' and the splunk url 'http://Splunkurl'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $Bytes = [System.Text.Encoding]::Unicode.GetBytes('EventGridTopicAccessKey') PS C:\> $Base64 =[Convert]::ToBase64String($Bytes) PS C:\> New-ADOPSAuditStream -EventGridTopicHostname 'http://eventgridUri' -EventGridTopicAccessKey $Base64</dev:code> <dev:remarks> <maml:para>This command sets up log forwarding to Azure eventgrid using the hostname 'http://eventgridUri' and the access key 'EventGridTopicAccessKey' Access key must be base64 encoded.</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>New-ADOPSBuildPolicy</command:name> <command:verb>New</command:verb> <command:noun>ADOPSBuildPolicy</command:noun> <maml:description> <maml:para>Creates a build validation policy for a repository</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command creates a build validation policy for a repository. It only creates the policy. You have to create the validation pipeline to be run manually.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSBuildPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the pipeline and repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Id of the repository in which to create the policy. Can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Branch</maml:name> <maml:description> <maml:para>git branch to trigger on. Accepts both branch name ('main') or full git path ('refs/heads/main') If only path name is given it will append "refs/heads/"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>PipelineId, or build definition id. Can be found using the `Get-ADOPSPipeline` command</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="5" aliases="none"> <maml:name>Displayname</maml:name> <maml:description> <maml:para>Display name of the policy setting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>filenamePatterns</maml:name> <maml:description> <maml:para>Filter validation trigger on repository path(s)</maml:para> </maml:description> <command:parameterValue required="true" 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="3" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>git branch to trigger on. Accepts both branch name ('main') or full git path ('refs/heads/main') If only path name is given it will append "refs/heads/"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Displayname</maml:name> <maml:description> <maml:para>Display name of the policy setting</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>PipelineId, or build definition id. Can be found using the `Get-ADOPSPipeline` command</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="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the pipeline and repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>Id of the repository in which to create the policy. Can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>filenamePatterns</maml:name> <maml:description> <maml:para>Filter validation trigger on repository path(s)</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSBuildPolicy -Project 'MyProject' -RepositoryId 62a7c071-1a60-44a9-a151-d17cd4d367da -Branch 'main' -PipelineId 1 -Displayname 'MyVerificationPolicy' -filenamePatterns '/root/*','/side/*'</dev:code> <dev:remarks> <maml:para>This command will create a policy named `MyVerificationPolicy` on the repository with id `62a7c071-1a60-44a9-a151-d17cd4d367da` in the `MyProject` project, that triggers on branch `main`. It will filter the validation to run only on changes in folder `/root/` or `/side/`.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $ADOPSProject = 'MyProject' PS C:\> $RepoId = Get-ADOPSRepository -Project $ADOPSProject -Repository 'MyRepo' | Select-Object -ExpandProperty Id PS C:\> $PipelineId = Get-ADOPSPipeline -Project $ADOPSProject -Name 'MyPipeline' | Select-Object -ExpandProperty id PS C:\> New-ADOPSBuildPolicy -Project $ADOPSProject -RepositoryId $RepoId -Branch 'refs/heads/main' -PipelineId $PipelineId -Displayname 'MyVerificationPolicy'</dev:code> <dev:remarks> <maml:para>This command will create a policy named `MyVerificationPolicy` running the `MyPipeline` pipeline on the repository `MyRepo` in the `MyProject` project, that triggers on branch `main`.</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>New-ADOPSElasticPool</command:name> <command:verb>New</command:verb> <command:noun>ADOPSElasticPool</command:noun> <maml:description> <maml:para>Create an Azure DevOps Elastic pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create an Azure DevOps Elastic pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSElasticPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolName</maml:name> <maml:description> <maml:para>Name of the Elastic Pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ElasticPoolObject</maml:name> <maml:description> <maml:para>The full request body in json or as a pscustom object. The Help function New-ElasticPoolObject can help generate a powershell object/json string.</maml:para> <maml:para>| Name | Type | Description | |----------------------|---------------------|-------------------------------------------------------------------------------| | agentInteractiveUI | boolean | Set whether agents should be configured to run with interactive UI | | azureId | string | Azure string representing to location of the resource | | desiredIdle | integer | Number of agents to have ready waiting for jobs | | desiredSize | integer | The desired size of the pool | | maxCapacity | integer | Maximum number of nodes that will exist in the elastic pool | | maxSavedNodeCount | integer | Keep nodes in the pool on failure for investigation | | offlineSince | string | Timestamp the pool was first detected to be offline | | osType | OperatingSystemType | Operating system type of the nodes in the pool | | poolId | integer | Id of the associated TaskAgentPool | | recycleAfterEachUse | boolean | Discard node after each job completes | | serviceEndpointId | string | Id of the Service Endpoint used to connect to Azure | | serviceEndpointScope | string | Scope the Service Endpoint belongs to | | sizingAttempts | integer | The number of sizing attempts executed while trying to achieve a desired size | | state | ElasticPoolState | State of the pool | | timeToLiveMinutes | integer | The minimum time in minutes to keep idle agents alive |</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>If provided, a new TaskAgentQueue will be created in the specified 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="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizeAllPipelines</maml:name> <maml:description> <maml:para>Setting to determine if all pipelines are authorized to use this TaskAgentPool by default.</maml: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>AutoProvisionProjectPools</maml:name> <maml:description> <maml:para>Setting to automatically provision TaskAgentQueues in every project for the new pool.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AuthorizeAllPipelines</maml:name> <maml:description> <maml:para>Setting to determine if all pipelines are authorized to use this TaskAgentPool by default.</maml:para> </maml:description> <command:parameterValue required="false" 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>AutoProvisionProjectPools</maml:name> <maml:description> <maml:para>Setting to automatically provision TaskAgentQueues in every project for the new pool.</maml:para> </maml:description> <command:parameterValue required="false" 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="1" aliases="none"> <maml:name>ElasticPoolObject</maml:name> <maml:description> <maml:para>The full request body in json or as a pscustom object. The Help function New-ElasticPoolObject can help generate a powershell object/json string.</maml:para> <maml:para>| Name | Type | Description | |----------------------|---------------------|-------------------------------------------------------------------------------| | agentInteractiveUI | boolean | Set whether agents should be configured to run with interactive UI | | azureId | string | Azure string representing to location of the resource | | desiredIdle | integer | Number of agents to have ready waiting for jobs | | desiredSize | integer | The desired size of the pool | | maxCapacity | integer | Maximum number of nodes that will exist in the elastic pool | | maxSavedNodeCount | integer | Keep nodes in the pool on failure for investigation | | offlineSince | string | Timestamp the pool was first detected to be offline | | osType | OperatingSystemType | Operating system type of the nodes in the pool | | poolId | integer | Id of the associated TaskAgentPool | | recycleAfterEachUse | boolean | Discard node after each job completes | | serviceEndpointId | string | Id of the Service Endpoint used to connect to Azure | | serviceEndpointScope | string | Scope the Service Endpoint belongs to | | sizingAttempts | integer | The number of sizing attempts executed while trying to achieve a desired size | | state | ElasticPoolState | State of the pool | | timeToLiveMinutes | integer | The minimum time in minutes to keep idle agents alive |</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolName</maml:name> <maml:description> <maml:para>Name of the Elastic Pool.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>If provided, a new TaskAgentQueue will be created in the specified 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>$Params = @{ AuthorizeAllPipelines = $true AutoProvisionProjectPools = $true PoolName = ManagedPool1 } New-ADOPSElasticPool @Params -ElasticPoolObject @" { "serviceEndpointId": "44868479-e856-42bf-9a2b-74bb500d8e36", "serviceEndpointScope": "421eb3c8-1ca4-4a53-b93c-58997b9eb5e1", "azureId": "/subscriptions/d83a7278-278c-4671-9a3e-a4cd81cd1194/resourceGroups/RG-TEST/providers/Microsoft.Compute/virtualMachineScaleSets/vmss-test", "maxCapacity": 1, "desiredIdle": 0, "recycleAfterEachUse": true, "maxSavedNodeCount": 0, "osType": "linux", "state": "online", "offlineSince": null, "desiredSize": 0, "sizingAttempts": 0, "agentInteractiveUI": false, "timeToLiveMinutes": 15 } "@</dev:code> <dev:remarks> <maml:para>To find your serviceEndpointScope, use Get-ADOPSProject as the scope is the project where the Service connection is bound. Create a Azure DevOps Elastic pool that Auto provisions in project and Authorizes the pool to be consumed by all pipelines. It also attaches to a Virtual Machine Scale Set using the azureId. Full description of the request body can be found at: https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/elasticpools/create?view=azure-devops-rest-7.1</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Params = @{ AuthorizeAllPipelines = $true AutoProvisionProjectPools = $true PoolName = ManagedPool1 } $ElasticPoolObject = New-ADOPSElasticPoolObject -ServiceEndpointId '44868479-e856-42bf-9a2b-74bb500d8e36' -ServiceEndpointScope '421eb3c8-1ca4-4a53-b93c-58997b9eb5e1' -AzureId '/subscriptions/8961f1f1-0bd1-4be0-b73c-6a8f3b304cf6/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/vmss-test' New-ADOPSElasticPool @Params -ElasticPoolObject $ElasticPoolObject</dev:code> <dev:remarks> <maml:para>To find your serviceEndpointScope, use Get-ADOPSProject as the scope is the project where the Service connection is bound. Create a Azure DevOps Elastic pool that Auto provisions in project and Authorizes the pool to be consumed by all pipelines. It also attaches to a Virtual Machine Scale Set using the azureId. Full description of the request body can be found at: https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/elasticpools/create?view=azure-devops-rest-7.1</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>elasticpools-create</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/elasticpools/create?view=azure-devops-rest-7.1</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>New-ADOPSElasticPoolObject</command:name> <command:verb>New</command:verb> <command:noun>ADOPSElasticPoolObject</command:noun> <maml:description> <maml:para>Creates an Elastic pool object that can be used.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an Elastic pool object that can be used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSElasticPoolObject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceEndpointId</maml:name> <maml:description> <maml:para>Id of the Service connection used to connect to Azure. (Get-ADOPSServiceConnection -Project MyAzureDevOpsProject -Name MyServiceConnection).id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ServiceEndpointScope</maml:name> <maml:description> <maml:para>Scope the Service Endpoint belongs to. Azure DevOps project ID (Get-ADOPSProject -Project MyAzureDevOpsProject).id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>MaxSavedNodeCount</maml:name> <maml:description> <maml:para>Keep nodes in the pool on failure for investigation</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>In what format should the output be in.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">json</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">pscustomobject</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>pscustomobject</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AzureId</maml:name> <maml:description> <maml:para>The full resource id for the Virtual Machine Scale Set in Azure. /subscriptions/subscriptionID/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/vmssName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>OsType</maml:name> <maml:description> <maml:para>Operating system type of the nodes in the pool</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">linux</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">windows</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>linux</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>MaxCapacity</maml:name> <maml:description> <maml:para>Maximum number of nodes that will exist in the elastic pool</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DesiredIdle</maml:name> <maml:description> <maml:para>Number of agents to have ready waiting for jobs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>RecycleAfterEachUse</maml:name> <maml:description> <maml:para>Discard node after each job completes</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>DesiredSize</maml:name> <maml:description> <maml:para>The desired size of the pool</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>AgentInteractiveUI</maml:name> <maml:description> <maml:para>Set whether agents should be configured to run with interactive UI</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>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>TimeToLiveMinutes</maml:name> <maml:description> <maml:para>The minimum time in minutes to keep idle agents alive</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>15</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>AgentInteractiveUI</maml:name> <maml:description> <maml:para>Set whether agents should be configured to run with interactive UI</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AzureId</maml:name> <maml:description> <maml:para>The full resource id for the Virtual Machine Scale Set in Azure. /subscriptions/subscriptionID/resourceGroups/resourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/vmssName</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>DesiredIdle</maml:name> <maml:description> <maml:para>Number of agents to have ready waiting for jobs</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>DesiredSize</maml:name> <maml:description> <maml:para>The desired size of the pool</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>MaxCapacity</maml:name> <maml:description> <maml:para>Maximum number of nodes that will exist in the elastic pool</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>MaxSavedNodeCount</maml:name> <maml:description> <maml:para>Keep nodes in the pool on failure for investigation</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>OsType</maml:name> <maml:description> <maml:para>Operating system type of the nodes in the pool</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>linux</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="11" aliases="none"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>In what format should the output be in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>pscustomobject</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>RecycleAfterEachUse</maml:name> <maml:description> <maml:para>Discard node after each job completes</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>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ServiceEndpointId</maml:name> <maml:description> <maml:para>Id of the Service connection used to connect to Azure. (Get-ADOPSServiceConnection -Project MyAzureDevOpsProject -Name MyServiceConnection).id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ServiceEndpointScope</maml:name> <maml:description> <maml:para>Scope the Service Endpoint belongs to. Azure DevOps project ID (Get-ADOPSProject -Project MyAzureDevOpsProject).id</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>TimeToLiveMinutes</maml:name> <maml:description> <maml:para>The minimum time in minutes to keep idle agents alive</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>15</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>$AzureDevOpsProject = Get-ADOPSProject -Project 'Azure' $AzureVMSS = Get-AzVmss -VMScaleSetName 'vmss-test' New-ADOPSElasticPoolObject -ServiceEndpointId '44868479-e856-42bf-9a2b-74bb500d8e36' -ServiceEndpointScope $AzureDevOpsProject.Id -AzureId $AzureVMSS.id</dev:code> <dev:remarks> <maml:para>Gets the Azure DevOps project where the Service endpoint is provisioned. Gets the Azure Virtual Machine Scale Set named vmss-test. Creates a new Azure DevOps Elastic Pool object with the correct references to the Azure path to the VMSS and DevOps project scope.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-ADOPSElasticPoolObject -ServiceEndpointId '44868479-e856-42bf-9a2b-74bb500d8e36' -ServiceEndpointScope '421eb3c8-1ca4-4a53-b93c-58997b9eb5e1' -AzureId '/subscriptions/8961f1f1-0bd1-4be0-b73c-6a8f3b304cf6/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/vmss-test'</dev:code> <dev:remarks> <maml:para>Creates a new Azure DevOps Elastic Pool by using the VMSS 'vmss-test' in the '8961f1f1-0bd1-4be0-b73c-6a8f3b304cf6' subscription.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>elasticpools-create</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/elasticpools/create?view=azure-devops-rest-7.1</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>New-ADOPSEnvironment</command:name> <command:verb>New</command:verb> <command:noun>ADOPSEnvironment</command:noun> <maml:description> <maml:para>Creates a new environment and sets up a better default access rule to it.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command creates a new environment in Azure DevOps. It also adds an admin to it that is not the creator, in order to fix this issue (https://developercommunity.visualstudio.com/t/Pipeline-environment-security-enhancemen/1236351?space=21&q=environment+permission&sort=votes&page=4)It does not support adding resources to the created environment.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSEnvironment</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization to connect 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to create the environment in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Name</maml:name> <maml:description> <maml:para>Name of the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Description</maml:name> <maml:description> <maml:para>Description of the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>AdminGroup</maml:name> <maml:description> <maml:para>Custom group principalName to add as administrator in the environment. Can be found using the `Get-ADOPSGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAdmin</maml:name> <maml:description> <maml:para>Skip adding an administrative group. This will lead to only the creator of the environment having administrative rights on the environment.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>AdminGroup</maml:name> <maml:description> <maml:para>Custom group principalName to add as administrator in the environment. Can be found using the `Get-ADOPSGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Description</maml:name> <maml:description> <maml:para>Description of the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Name</maml:name> <maml:description> <maml:para>Name of the environment</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Organization to connect 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project to create the environment in</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipAdmin</maml:name> <maml:description> <maml:para>Skip adding an administrative group. This will lead to only the creator of the environment having administrative rights on the environment.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSEnvironment -Project 'myProject' -Name 'MyEnv'</dev:code> <dev:remarks> <maml:para>This command will create an environment named 'MyEnv' in the 'MyProject' project. It will add the '[myProject]\Project Administrators' group as administrator to the environment.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSEnvironment -Project 'myProject' -Name 'MyEnv' -SkipAdmin</dev:code> <dev:remarks> <maml:para>This command will create an environment named 'MyEnv' in the 'MyProject' project. It will not add any group as administrator to the environment resulting in only the user running the command having admin access to the environment (default behaviour)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSEnvironment -Project 'myProject' -Name 'MyEnv' -Description 'MyEnvironment description' -AdminGroup '[myProject]\myProject Team'</dev:code> <dev:remarks> <maml:para>This command will create an environment named 'MyEnv' with the description 'MyEnvironment description' in the 'MyProject' project. It will also add the '[myProject]\myProject Team' group as administrator to the environment.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADOPSGitBranch</command:name> <command:verb>New</command:verb> <command:noun>ADOPSGitBranch</command:noun> <maml:description> <maml:para>Create a new branch in a Azure DevOps git repo.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command creates a new branch in an Azure DevOps git repo without the need to clone the repo or have any git tools installed. It creates the branch from the submitted commit id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSGitBranch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to connect 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="1" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The ID of the repository in GUID format. This can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>BranchName</maml:name> <maml:description> <maml:para>Name of the new branch 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="4" aliases="none"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>Full hash commit id to use as base of the new branch. This can be found using `Invoke-ADOPSRestMethod` (see example), or by running the command `git log -1 --format=format:"%H"` inside a git repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>BranchName</maml:name> <maml:description> <maml:para>Name of the new branch 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="4" aliases="none"> <maml:name>CommitId</maml:name> <maml:description> <maml:para>Full hash commit id to use as base of the new branch. This can be found using `Invoke-ADOPSRestMethod` (see example), or by running the command `git log -1 --format=format:"%H"` inside a git repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to connect 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="2" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project where the repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>The ID of the repository in GUID format. This can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSGitBranch -RepositoryId 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' -Project 'MyProj' -BranchName 'NewBranch' -CommitId '12345678910111213141516171819202122232425'</dev:code> <dev:remarks> <maml:para>This will create a new branch in the repository with id 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' from the commit with id '12345678910111213141516171819202122232425' with name 'NewBranch'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $Project = 'myProject' PS C:\> $RepoName = 'myRepo' PS C:\> $BranchName = 'NewBranch' PS C:\> $repo = Get-ADOPSRepository -Project $Project -Repository $RepoName PS C:\> $AllCommits = Invoke-ADOPSRestMethod -Uri $repo._links.commits.href -Method Get | Select-Object -ExpandProperty value PS C:\> $LatestCommit = ($AllCommits | Sort-Object -Property @{Expression = {$_.author.date}} -Descending | Select-Object -First 1).commitId PS C:\> New-ADOPSGitBranch -RepositoryId $repo.id -Project $Project -BranchName $BranchName -CommitId $CommitId</dev:code> <dev:remarks> <maml:para>This command shows how to get all git history directly from a repository using the `Invoke-ADOPSRestMethod` command and use this to create a new branch from the latest commit.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADOPSMergePolicy</command:name> <command:verb>New</command:verb> <command:noun>ADOPSMergePolicy</command:noun> <maml:description> <maml:para>This command sets the Limit merge types setting of a repository git branch.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This setting creates and enables a merge restriction policy on a git branch on a Azure DevOps repository. It will allow only those merge types activated.</maml:para> <maml:para>WARNING: It is possible to allow no merge types at all, effectively preventing any code from being merged to a repository. Make sure to activate at least one policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSMergePolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the pipeline and repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Id of the repository in which to create the policy. Can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Branch</maml:name> <maml:description> <maml:para>git branch to trigger on. Accepts both branch name ('main') or full git path ('refs/heads/main') If only path name is given it will append "refs/heads/"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>allowNoFastForward</maml:name> <maml:description> <maml:para>Enables basic merge (No fast forward)</maml: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>allowRebase</maml:name> <maml:description> <maml:para>Enables Rebase and fast-forward</maml: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>allowRebaseMerge</maml:name> <maml:description> <maml:para>Enables Rebase with merge commit</maml: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>allowSquash</maml:name> <maml:description> <maml:para>Enables Squash merge</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="3" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>git branch to trigger on. Accepts both branch name ('main') or full git path ('refs/heads/main') If only path name is given it will append "refs/heads/"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the pipeline and repository is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>RepositoryId</maml:name> <maml:description> <maml:para>Id of the repository in which to create the policy. Can be found using the `Get-ADOPSRepository` command</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>allowNoFastForward</maml:name> <maml:description> <maml:para>Enables basic merge (No fast forward)</maml:para> </maml:description> <command:parameterValue required="false" 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>allowRebase</maml:name> <maml:description> <maml:para>Enables Rebase and fast-forward</maml:para> </maml:description> <command:parameterValue required="false" 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>allowRebaseMerge</maml:name> <maml:description> <maml:para>Enables Rebase with merge commit</maml:para> </maml:description> <command:parameterValue required="false" 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>allowSquash</maml:name> <maml:description> <maml:para>Enables Squash merge</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSMergePolicy -Project 'MyProject' -RepositoryId 62a7c071-1a60-44a9-a151-d17cd4d367da -Branch 'main'-allowSquash</dev:code> <dev:remarks> <maml:para>This command will create a merge policy only allowing squash merges to the main branch of the repository with id 62a7c071-1a60-44a9-a151-d17cd4d367da</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $ADOPSProject = 'MyProject' PS C:\> $RepoId = Get-ADOPSRepository -Project $ADOPSProject -Repository 'MyRepo' | Select-Object -ExpandProperty Id PS C:\> New-ADOPSMergePolicy -Project $ADOPSProject -RepositoryId $RepoId -Branch 'refs/heads/main' -allowNoFastForward -allowSquash -allowRebase -allowRebaseMerge</dev:code> <dev:remarks> <maml:para>This command will create a merge policy allowing any type of merges to the main branch of the repository MyRepo</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>New-ADOPSPipeline</command:name> <command:verb>New</command:verb> <command:noun>ADOPSPipeline</command:noun> <maml:description> <maml:para>Create a new pipeline from a existing yaml file in your repository.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new pipeline from a existing yaml file in your repository.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSPipeline</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project to add the pipeline 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="2" aliases="none"> <maml:name>YamlPath</maml:name> <maml:description> <maml:para>The path to the Yaml file in your repository. Like: File.yaml or Folder/Folder/File.yaml</maml:para> <maml:para>Only allows extensions .yaml or .yml</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Repository</maml:name> <maml:description> <maml:para>The Repository Name where the Pipeline Yaml file is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>FolderPath</maml:name> <maml:description> <maml:para>Folderpath to add your pipelines to under Devops Pipelines. Like: PipelineFolder or PipelineFolder1\PipelineSubFolder2</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to add pipeline 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>FolderPath</maml:name> <maml:description> <maml:para>Folderpath to add your pipelines to under Devops Pipelines. Like: PipelineFolder or PipelineFolder1\PipelineSubFolder2</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to add pipeline 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to add the pipeline 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="3" aliases="none"> <maml:name>Repository</maml:name> <maml:description> <maml:para>The Repository Name where the Pipeline Yaml file is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>YamlPath</maml:name> <maml:description> <maml:para>The path to the Yaml file in your repository. Like: File.yaml or Folder/Folder/File.yaml</maml:para> <maml:para>Only allows extensions .yaml or .yml</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSPipeline -Name $PipelineName -Project $ProjectName -YamlPath 'pipelines/pipeline1.yaml' -Repository $RepositoryName -Organization $OrganizationName</dev:code> <dev:remarks> <maml:para>Create pipeline in $ProjectName</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSPipeline -Name $PipelineName -Project $ProjectName -YamlPath 'pipelines/pipeline1.yaml' -Repository $RepositoryName -FolderPath 'folder1\folder2'</dev:code> <dev:remarks> <maml:para>Create pipeline in $ProjectName and use Default Organization and put the pipeline in subfolder folder2 under DevOps Pipelines.</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>New-ADOPSProject</command:name> <command:verb>New</command:verb> <command:noun>ADOPSProject</command:noun> <maml:description> <maml:para>Creates a new project in Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new project in Azure DevOps.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new 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="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new 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="False" position="2" 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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>SourceControlType</maml:name> <maml:description> <maml:para>The source control type to use in the project. The default is git.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Git</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tfvc</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>Git</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>ProcessTypeName</maml:name> <maml:description> <maml:para>The name of a process to use in the project.</maml:para> <maml:para>This can be the name of an existing process such as Basic, Agile, Scrum or CMMI. It can also be the name of a custom process created in the organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to create the project in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If defined this command will wait for the project to be created and return the project object. Default will return the process started.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description of the new 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="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new 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="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to create the project in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>ProcessTypeName</maml:name> <maml:description> <maml:para>The name of a process to use in the project.</maml:para> <maml:para>This can be the name of an existing process such as Basic, Agile, Scrum or CMMI. It can also be the name of a custom process created in the organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>SourceControlType</maml:name> <maml:description> <maml:para>The source control type to use in the project. The default is git.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Git</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>If defined this command will wait for the project to be created and return the project object. Default will return the process started.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSProject -Name 'ADOPSproj' -Description 'an example project' -Visibility Public -Organization 'ADOPS'</dev:code> <dev:remarks> <maml:para>Creates a new, public project called "ADOPSproj" with a description in the organization "ADOPS".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSProject -Name 'ADOPSproj' -Visibility Private -ProcessTypeName 'Agile'</dev:code> <dev:remarks> <maml:para>Creates a new, private project called "ADOPSproj" with the process type "Agile" in the default organization.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSProject -Name 'ADOPSproj' -Visibility Private -ProcessTypeName 'MyOwnProcess' -SourceControlType 'Tfvc'</dev:code> <dev:remarks> <maml:para>Creates a new, private project called "ADOPSproj" with an existing, custom process type "MyOwnProcess" in the default organization, with the source control type set to Team Foundation Version Control.</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>New-ADOPSRepository</command:name> <command:verb>New</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>Create a new Azure DevOps Git repository</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will create a new Git repository in your Azure DevOps project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Git repo.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project in which the repo 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="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization in which the repo 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the new Git repo.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization in which the repo 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="False" position="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project in which the repo 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSRepository -Project 'MyProject' -Name 'MyNewRepo'</dev:code> <dev:remarks> <maml:para>This command will add a new empty repo named 'MyNewRepo' in the MyProject 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>New-ADOPSServiceConnection</command:name> <command:verb>New</command:verb> <command:noun>ADOPSServiceConnection</command:noun> <maml:description> <maml:para>Create an Azure DevOps Service Connection to Azure.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates an Azure DevOps Service Connection to Azure subscription using an existing Service Principal. Assign the necessary permissions in Azure for the service principal.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSServiceConnection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AzureScope</maml:name> <maml:description> <maml:para>resource group ID where the app registration will be granted contributor access. /subscriptions/4ba9b4a1-dc0d-4ec8-adaf-061771ccd1da/resourceGroups/MyAzureRG</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of Azure DevOps 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="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WorkloadIdentityFederation</maml:name> <maml:description> <maml:para>If Workload identity federation will be used for the connection.</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>New-ADOPSServiceConnection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>If a managed identity will be used for the connection.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Azure AD Service principal, Application (Client) ID and valid secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" 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>New-ADOPSServiceConnection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Azure AD Service principal, Application (Client) ID and valid secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" 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>AzureScope</maml:name> <maml:description> <maml:para>resource group ID where the app registration will be granted contributor access. /subscriptions/4ba9b4a1-dc0d-4ec8-adaf-061771ccd1da/resourceGroups/MyAzureRG</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>If a managed identity will be used for the connection.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServicePrincipal</maml:name> <maml:description> <maml:para>Azure AD Service principal, Application (Client) ID and valid secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WorkloadIdentityFederation</maml:name> <maml:description> <maml:para>If Workload identity federation will be used for the connection.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>$Params = @{ TenantId = "32238a3e-4aae-4a9d-a3be-5c2912088b9b" SubscriptionName = "My Subscription" SubscriptionId = "34dacce0-5332-4b27-a804-4352202aca27" ServicePrincipal = Get-Credential Project = "My DevOps Project" ConnectionName = "My Service Connection Name" } New-ADOPSServiceConnection @Params</dev:code> <dev:remarks> <maml:para>Creates an Azure DevOps Service Connection to an Azure subscription using an existing Service Principal object in Azure AD.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>$Params = @{ TenantId = "32238a3e-4aae-4a9d-a3be-5c2912088b9b" SubscriptionName = "My Subscription" SubscriptionId = "34dacce0-5332-4b27-a804-4352202aca27" ServicePrincipal = Get-Credential Project = "My DevOps Project" ConnectionName = "My Service Connection Name" ManagedIdentity = $true } New-ADOPSServiceConnection @Params</dev:code> <dev:remarks> <maml:para>Creates an Azure DevOps Service Connection to an Azure subscription using a managed service principal in Azure AD.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>$Params = @{ TenantId = "32238a3e-4aae-4a9d-a3be-5c2912088b9b" SubscriptionName = "My Subscription" SubscriptionId = "34dacce0-5332-4b27-a804-4352202aca27" Project = "My DevOps Project" ConnectionName = "My Service Connection Name" WorkloadIdentityFederation = $true AzureScope = (Get-AzResourceGroup -Name MyAzureRG).ResourceId } New-ADOPSServiceConnection @Params</dev:code> <dev:remarks> <maml:para>Creates an Azure DevOps Service Connection to an Azure resource group using workload identity federation (OAuth) and automatically creating an app registration in Azure AD.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>serviceconnection-create</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/create?view=azure-devops-rest-6.0</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>New-ADOPSUserStory</command:name> <command:verb>New</command:verb> <command:noun>ADOPSUserStory</command:noun> <maml:description> <maml:para>Create User Story in DevOps Project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a User Story (Work Item) in an Azure DevOps Project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSUserStory</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the User Story.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>ProjectName</maml:name> <maml:description> <maml:para>Name of the DevOps project 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="2" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description text for the User Story 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="3" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Tags to use for the user story. Multiple tags can be added and separated by comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Priority</maml:name> <maml:description> <maml:para>User Story priority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description text for the User Story 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="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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>Priority</maml:name> <maml:description> <maml:para>User Story priority.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>ProjectName</maml:name> <maml:description> <maml:para>Name of the DevOps project 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="3" aliases="none"> <maml:name>Tags</maml:name> <maml:description> <maml:para>Tags to use for the user story. Multiple tags can be added and separated by comma.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the User Story.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>New-ADOPSUserStory -Organization 'myOrganization' -ProjectName 'myProject' -Title 'My user story' -Description 'User story description' -Tags 'ADOPS' -Priority 1</dev:code> <dev:remarks> <maml:para>Creates a user story with the title 'My user story' in the DevOps Project 'myProject'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>New-ADOPSUserStory -Organization 'myOrganization' -ProjectName 'myProject' -Title 'My user story' -Description 'User story description' -Tags 'ADOPS,Important' -Priority 1</dev:code> <dev:remarks> <maml:para>Creates a user story with multiple tags.</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>New-ADOPSVariableGroup</command:name> <command:verb>New</command:verb> <command:noun>ADOPSVariableGroup</command:noun> <maml:description> <maml:para>Creates a new variable group in an Azure DevOps project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new variable group in an Azure DevOps project.</maml:para> <maml:para>The command only supports a single variable being created together with the variable group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSVariableGroup</maml:name> <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 variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSecret</maml:name> <maml:description> <maml:para>Whether or not the variable created should be considered a secret.</maml: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>Organization</maml:name> <maml:description> <maml:para>The organization of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableGroupName</maml:name> <maml:description> <maml:para>The name of the new variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableName</maml:name> <maml:description> <maml:para>The name of the variable to be created with the variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableValue</maml:name> <maml:description> <maml:para>The value of the variable to be created with the variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-ADOPSVariableGroup</maml:name> <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 variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableGroupName</maml:name> <maml:description> <maml:para>The name of the new variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableHashtable</maml:name> <maml:description> <maml:para>A hashtable containing the variable to be created with the variable group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>@( @{ Name = "Key1" value = "Key1Value" IsSecret = $true }, @{ Name = "Key2" value = "Key2Value" IsSecret = $false } )</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:syntaxItem> </command:syntax> <command:parameters> <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 variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IsSecret</maml:name> <maml:description> <maml:para>Whether or not the variable created should be considered a secret.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>The organization of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project to create the variable group in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableGroupName</maml:name> <maml:description> <maml:para>The name of the new variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableHashtable</maml:name> <maml:description> <maml:para>A hashtable containing the variable to be created with the variable group.</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>@( @{ Name = "Key1" value = "Key1Value" IsSecret = $true }, @{ Name = "Key2" value = "Key2Value" IsSecret = $false } )</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="False" position="named" aliases="none"> <maml:name>VariableName</maml:name> <maml:description> <maml:para>The name of the variable to be created with the variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>VariableValue</maml:name> <maml:description> <maml:para>The value of the variable to be created with the variable group.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $Hashtable = @( @{ Name = "Key1" value = "Key1Value" IsSecret = $true }, @{ Name = "Key2" value = "Key2Value" IsSecret = $false } ) PS C:\> New-ADOPSVariableGroup -Project 'ADOPSproj' -Organization 'ADOPS' -VariableGroupName 'ADOPSvars' -Description 'vargroup example' -VariableHashtable $Hashtable</dev:code> <dev:remarks> <maml:para>Creates a new variable group called "ADOPSvars" in the project "ADOPSproj" in the organization "ADOPS" with a description, providing a hashtable to create one non-secret variable called "Key2" with the value "Key2Value" and one secret variable called "Key1" with the value "Key1Value".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSVariableGroup -Project 'ADOPSproj' -VariableGroupName 'ADOPSvars' -VariableName 'var-name' -VariableValue 'var-value'</dev:code> <dev:remarks> <maml:para>Creates a new variable group called "ADOPSvars" in the project "ADOPSproj" in the default organization, creating a variable called "var-name" with the value "var-value".</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-ADOPSWiki</command:name> <command:verb>New</command:verb> <command:noun>ADOPSWiki</command:noun> <maml:description> <maml:para>Creates a new Azure DevOps code wiki.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command lets you create a new Azure DevOps code wiki. This wiki is editable by changing markdown files directly in a repository in your Azure DevOps project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-ADOPSWiki</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>WikiName</maml:name> <maml:description> <maml:para>Name of the wiki.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>WikiRepository</maml:name> <maml:description> <maml:para>The Git repository that will host the markdown wiki files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project in which to create the wiki.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>WikiRepositoryPath</maml:name> <maml:description> <maml:para>Path relative to the root where the wiki home will be.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>'/'</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>GitBranch</maml:name> <maml:description> <maml:para>The git branch used for wiki markdown pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Main</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>GitBranch</maml:name> <maml:description> <maml:para>The git branch used for wiki markdown pages.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Main</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project in which to create the wiki.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>WikiName</maml:name> <maml:description> <maml:para>Name of the wiki.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>WikiRepository</maml:name> <maml:description> <maml:para>The Git repository that will host the markdown wiki files.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>WikiRepositoryPath</maml:name> <maml:description> <maml:para>Path relative to the root where the wiki home will be.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>'/'</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> New-ADOPSWiki -Project 'myproject' -WikiName 'MyWikiName' -WikiRepository 'MyWikiRepo'</dev:code> <dev:remarks> <maml:para>This command will create a new wiki named "MyWikiName", in the "MyProject" project in your current default logged in Azure DevOps environment. It will store the markdown files in the "MyWikiRepo" repository, using the root folder in the main branch.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-ADOPSWiki -Project 'myproject' -WikiName 'MyWikiName' -WikiRepository 'MyWikiRepo' -WikiRepositoryPath '/MyWikiFiles' -GitBranch 'PublicWiki'</dev:code> <dev:remarks> <maml:para>This command will create a new wiki named "MyWikiName", in the "MyProject" project in your current default logged in Azure DevOps environment. It will store the markdown files in the "MyWikiRepo" repository. The Markdown files will be stored in the "/MyWikiFiles" subfolder of the repository. The wiki will be published from the "PublicWiki" branch of the "MyWikiRepo" repository.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ADOPSRepository</command:name> <command:verb>Remove</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>Deletes a repository from an Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command deletes a repository from an Azure DevOps organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RepositoryID</maml:name> <maml:description> <maml:para>The repositoru ID, GUID, to delet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project in which the repository exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization to connect 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to connect 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project in which the repository exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RepositoryID</maml:name> <maml:description> <maml:para>The repositoru ID, GUID, to delet.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Remove-ADOPSRepository -Project MyProject -RepositoryID 1bb0b904-27b7-414d-811e-f51085e7ad02</dev:code> <dev:remarks> <maml:para>This command will delete the repository with id '1bb0b904-27b7-414d-811e-f51085e7ad02' from the 'MyProject' project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-ADOPSVariableGroup</command:name> <command:verb>Remove</command:verb> <command:noun>ADOPSVariableGroup</command:noun> <maml:description> <maml:para>Removes a variable group from Azure DevOps.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes a variable group from Azure DevOps.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-ADOPSVariableGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>VariableGroupName</maml:name> <maml:description> <maml:para>Name of the variable group to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the Azure DevOps 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="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" 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="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>Name of the Azure DevOps 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="False" position="0" aliases="none"> <maml:name>VariableGroupName</maml:name> <maml:description> <maml:para>Name of the variable group to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Remove-ADOPSVariableGroup -Organization 'ADOPS' -Project 'ADOPSproj' -VariableGroupName 'ExampleVarGroup'</dev:code> <dev:remarks> <maml:para>Removes the variable group called "ExampleVarGroup" from the project "ADOPSproj" in the organization "ADOPS".</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Remove-ADOPSVariableGroup -Project 'ADOPSproj' -VariableGroupName 'ExampleVarGroup'</dev:code> <dev:remarks> <maml:para>Removes the variable group called "ExampleVarGroup" from the project "ADOPSproj" in the default organization.</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>Revoke-ADOPSPipelinePermission</command:name> <command:verb>Revoke</command:verb> <command:noun>ADOPSPipelinePermission</command:noun> <maml:description> <maml:para>Revokes pipeline permission to a resource of type VariableGroup, Queue, SecureFile, or Environment.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Revokes pipeline permissions to a resource of type VariableGroup, Queue, SecureFile, or Environment. Specify a PipelineId to grant permissions to a single pipeline, or use the AllPipelines parameter to grant permissions to all pipelines.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Revoke-ADOPSPipelinePermission</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AllPipelines</maml:name> <maml:description> <maml:para>Revoke access for all pipelines. This is equivalent to enable the restrictions on the resource.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to revoke permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to revoke permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Revoke-ADOPSPipelinePermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the pipeline to revoke permissions for.</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>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to revoke permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to revoke permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">VariableGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Queue</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SecureFile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</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>AllPipelines</maml:name> <maml:description> <maml:para>Revoke access for all pipelines. This is equivalent to enable the restrictions on the resource.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization. Defaults to the current organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Id of the pipeline to revoke permissions for.</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>Project</maml:name> <maml:description> <maml:para>Name of project containing the resource.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResourceId</maml:name> <maml:description> <maml:para>Id of the resource to revoke permissions 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>ResourceType</maml:name> <maml:description> <maml:para>Resource type to revoke permissions to. Valid values are VariableGroup, Queue, SecureFile, and Environment.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ResourceType</command:parameterValue> <dev:type> <maml:name>ResourceType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Revoke-ADOPSPipelinePermission -Pipeline 42 -ResourceType SecureFile -ResourceId '88d047be-7e59-4eda-b1fe-1614c7a69e16' -Project 'MyProject'</dev:code> <dev:remarks> <maml:para>Revoke pipeline 42 permission to the secure file with id 88d047be-7e59-4eda-b1fe-1614c7a69e16 in project MyProject.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-ADOPSPipelineTask</command:name> <command:verb>Save</command:verb> <command:noun>ADOPSPipelineTask</command:noun> <maml:description> <maml:para>Saves the zip file of any task installed in an Azure DevOps organization.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will download a zip file containing any task from yourAzure DevOps organization for you to explore or security review.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-ADOPSPipelineTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Filename to output the zipfile as.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization where your tasks are installed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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 where zip files will be output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Id of the task to download. Can be found using the command `Get-ADOPSPipelineTask`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TaskVersion</maml:name> <maml:description> <maml:para>Version in the format 'major.minor.build' of the task to download. Can be found using the command `Get-ADOPSPipelineTask`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Save-ADOPSPipelineTask</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A list of tasks to download. This list must contain the following properties: id = guid of task name = task name for file output version = @{ major = 1 minor = 2 patch = 3 }</maml:para> <maml:para>You may use the command `Get-ADOPSPipelineTask` to get a properly created object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization where your tasks are installed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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 where zip files will be output.</maml:para> </maml:description> <command:parameterValue required="true" 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>FileName</maml:name> <maml:description> <maml:para>Filename to output the zipfile as.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>A list of tasks to download. This list must contain the following properties: id = guid of task name = task name for file output version = @{ major = 1 minor = 2 patch = 3 }</maml:para> <maml:para>You may use the command `Get-ADOPSPipelineTask` to get a properly created object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization where your tasks are installed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev: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 where zip files will be output.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Id of the task to download. Can be found using the command `Get-ADOPSPipelineTask`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TaskVersion</maml:name> <maml:description> <maml:para>Version in the format 'major.minor.build' of the task to download. Can be found using the command `Get-ADOPSPipelineTask`.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Version</command:parameterValue> <dev:type> <maml:name>Version</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Save-ADOPSPipelineTask -TaskId 6c731c3c-3c68-459a-a5c9-bde6e6595b5b -TaskVersion 2.206.1</dev:code> <dev:remarks> <maml:para>This command will download a zip file to the current folder. The zip file will contain the task with task id "6c731c3c-3c68-459a-a5c9-bde6e6595b5b" (bash) The zip file will be named "6c731c3c-3c68-459a-a5c9-bde6e6595b5b.2.206.1.zip" (taskid.version.zip)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Save-ADOPSPipelineTask -Path C:\temp\tasks\ -TaskId 6c731c3c-3c68-459a-a5c9-bde6e6595b5b -TaskVersion 2.206.1 -FileName MyBashTask.zip</dev:code> <dev:remarks> <maml:para>This command will download a zip file named "MyBashTask.zip" to the "C:\temp\tasks\" folder. The zip file will contain the task with task id "6c731c3c-3c68-459a-a5c9-bde6e6595b5b" (bash)</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $r = Get-ADOPSPipelineTask PS C:\> $r.Where({$_.name -eq 'PowerShell'}) | Save-ADOPSPipelineTask -Path c:\temp\tasks\</dev:code> <dev:remarks> <maml:para>This command uses the Get-ADOPSPipelineTask to get all installed pipeline tasks. It filters the tasks on the name "PowerShell" and downloads all matching tasks to the "c:\temp\tasks\" folder. The zip files will be named "TaskName-TaskId-version.zip" (for example: "PowerShell-e213ff0f-5d5c-4791-802d-52ea3e7be1f1-1.2.3.zip")</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS C:\> Save-ADOPSPipelineTask -Path c:\temp\tasks\ -InputObject @( @{ id = "e213ff0f-5d5c-4791-802d-52ea3e7be1f1" name = "PowerShell" version = @{ major = 1 minor = 2 patch = 3 } }, @{ id = "e213ff0f-5d5c-4791-802d-52ea3e7be1f1" name = "PowerShell" version = @{ major = 2 minor = 212 patch = 0 } } )</dev:code> <dev:remarks> <maml:para>This command uses a list of hashtables to download two different tasks. The properties listed in the example must be included in the objects to process.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSArtifactFeed</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSArtifactFeed</command:noun> <maml:description> <maml:para>Changes a setting for an artifact feed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Changes a setting for an artifact feed. Currently only supports Description and enabling or disabling upstreams.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSArtifactFeed</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the feed is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Feed Id in gui format or 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>Description</maml:name> <maml:description> <maml:para>Set the feed 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="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>UpstreamEnabled</maml:name> <maml:description> <maml:para>Enable or Disable upstreams. If enabling it will also add all current upstream sources.</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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set the feed 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="False" position="2" aliases="none"> <maml:name>FeedId</maml:name> <maml:description> <maml:para>Feed Id in gui format or 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="1" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project where the feed is located</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>UpstreamEnabled</maml:name> <maml:description> <maml:para>Enable or Disable upstreams. If enabling it will also add all current upstream sources.</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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $i = (Get-ADOPSArtifactFeed -Project 'MyProject' -FeedId 'MyCustomFeed').id PS C:\> Set-ADOPSArtifactFeed -Project 'MyProject' -FeedId $i -Description 'Update the description' -UpstreamEnabled:$true</dev:code> <dev:remarks> <maml:para>This command will set the description for artifact feed 'MyCustomFeed' in the 'MyProject' project. It will also enable upstreams and add all currently supported upstream sources.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSBuildDefinition</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSBuildDefinition</command:noun> <maml:description> <maml:para>This command will update a build definition.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will update a build definition. Because the build definition object is multilevel and intricate, and you will need to have the correct definition revision and metadata, you must use `Get-ADOPSBuildDefinition` and alter the output object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSBuildDefinition</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set definitions in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="Definition"> <maml:name>DefinitionObject</maml:name> <maml:description> <maml:para>Complete object returned from `Get-ADOPSBuildDefinition`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Definition"> <maml:name>DefinitionObject</maml:name> <maml:description> <maml:para>Complete object returned from `Get-ADOPSBuildDefinition`</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to set definitions in.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $Definition = Get-ADOPSBuildDefinition -Project MyProject -Id 123 PS C:\> $Definition.queueStatus = 'disabled' PS C:\> Set-ADOPSBuildDefinition -DefinitionObject $Definition</dev:code> <dev:remarks> <maml:para>This command will set the build definition with id 123 to status 'disabled'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSElasticPool</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSElasticPool</command:noun> <maml:description> <maml:para>Updates an Azure DevOps Elastic pool.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates an Azure DevOps Elastic pool.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSElasticPool</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The unique Azure DevOps Pool id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ElasticPoolObject</maml:name> <maml:description> <maml:para>The full request body in json or as a pscustom object. The Help function New-ElasticPoolObject can help generate a powershell object/json string.</maml:para> <maml:para>| Name | Type | Description | |----------------------|---------------------|-------------------------------------------------------------------------------| | agentInteractiveUI | boolean | Set whether agents should be configured to run with interactive UI | | azureId | string | Azure string representing to location of the resource | | desiredIdle | integer | Number of agents to have ready waiting for jobs | | desiredSize | integer | The desired size of the pool | | maxCapacity | integer | Maximum number of nodes that will exist in the elastic pool | | maxSavedNodeCount | integer | Keep nodes in the pool on failure for investigation | | offlineSince | string | Timestamp the pool was first detected to be offline | | osType | OperatingSystemType | Operating system type of the nodes in the pool | | poolId | integer | Id of the associated TaskAgentPool | | recycleAfterEachUse | boolean | Discard node after each job completes | | serviceEndpointId | string | Id of the Service Endpoint used to connect to Azure | | serviceEndpointScope | string | Scope the Service Endpoint belongs to | | sizingAttempts | integer | The number of sizing attempts executed while trying to achieve a desired size | | state | ElasticPoolState | State of the pool | | timeToLiveMinutes | integer | The minimum time in minutes to keep idle agents alive |</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" 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="1" aliases="none"> <maml:name>ElasticPoolObject</maml:name> <maml:description> <maml:para>The full request body in json or as a pscustom object. The Help function New-ElasticPoolObject can help generate a powershell object/json string.</maml:para> <maml:para>| Name | Type | Description | |----------------------|---------------------|-------------------------------------------------------------------------------| | agentInteractiveUI | boolean | Set whether agents should be configured to run with interactive UI | | azureId | string | Azure string representing to location of the resource | | desiredIdle | integer | Number of agents to have ready waiting for jobs | | desiredSize | integer | The desired size of the pool | | maxCapacity | integer | Maximum number of nodes that will exist in the elastic pool | | maxSavedNodeCount | integer | Keep nodes in the pool on failure for investigation | | offlineSince | string | Timestamp the pool was first detected to be offline | | osType | OperatingSystemType | Operating system type of the nodes in the pool | | poolId | integer | Id of the associated TaskAgentPool | | recycleAfterEachUse | boolean | Discard node after each job completes | | serviceEndpointId | string | Id of the Service Endpoint used to connect to Azure | | serviceEndpointScope | string | Scope the Service Endpoint belongs to | | sizingAttempts | integer | The number of sizing attempts executed while trying to achieve a desired size | | state | ElasticPoolState | State of the pool | | timeToLiveMinutes | integer | The minimum time in minutes to keep idle agents alive |</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>PoolId</maml:name> <maml:description> <maml:para>The unique Azure DevOps Pool id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $AzureDevOpsProject = Get-ADOPSProject -Project 'ADOPS' $AzureVMSS = Get-AzVmss -VMScaleSetName 'adops-vmss' $PoolInformation = Get-ADOPSPool -PoolName 'adopsPool' $ElasticPoolObject = New-ADOPSElasticPoolObject -ServiceEndpointId 'd6040a29-d507-43b0-a72d-99a50cb3a9d3' -ServiceEndpointScope $AzureDevOpsProject.Id -AzureId $AzureVMSS.id -DesiredIdle 2 -MaxCapacity 2 Set-ADOPSElasticPool -PoolId $PoolInformation.id -ElasticPoolObject $ElasticPoolObject</dev:code> <dev:remarks> <maml:para>Retrieves the Azure DevOps Project specified, the Azure Virtual Machine Scale-set. Generates a Elastic pool object using the New-ADOPSElasticPoolObject function and then updates the Elastic Pool id Azure using it's unique id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSGitPermission</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSGitPermission</command:noun> <maml:description> <maml:para>Sets git ref permissions on a Azure DevOps git repo</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This function sets Git ref access rights for a user or group in Azure DevOps. You may select the same rule for Allow and Deny, but it should not work and may lead to unexpected behaviours.</maml:para> <maml:para>The following settings are possible to set. bit name displayName --- ---- ----------- 1 Administer Administer 2 GenericRead Read 4 GenericContribute Contribute 8 ForcePush Force push (rewrite history and delete branches) 16 CreateBranch Create branch 32 CreateTag Create tag 64 ManageNote Manage notes 128 PolicyExempt Bypass policies when pushing 256 CreateRepository Create repository 512 DeleteRepository Delete repository 1024 RenameRepository Rename repository 2048 EditPolicies Edit policies 4096 RemoveOthersLocks Remove others' locks 8192 ManagePermissions Manage permissions 16384 PullRequestContribute Contribute to pull requests 32768 PullRequestBypassPolicy Bypass policies when completing pull requests</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSGitPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="ProjectId"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID or Project Name where the repo is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="RepositoryId"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository ID or Repository Name to set access 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="3" aliases="none"> <maml:name>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of a user or group in Azure DevOps. Can be found using the `Get-ADOPSUser` or `Get-ADOPSGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Allow</maml:name> <maml:description> <maml:para>Enum of access rights to grant a user or group. Can be either the topic or the value.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Administer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GenericContribute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ForcePush</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateTag</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ManageNote</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PolicyExempt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeleteRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RenameRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EditPolicies</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RemoveOthersLocks</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ManagePermissions</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PullRequestContribute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PullRequestBypassPolicy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AccessLevels[]</command:parameterValue> <dev:type> <maml:name>AccessLevels[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Enum of access rights to deny a user or group. Can be either the topic or the value.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Administer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GenericRead</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GenericContribute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ForcePush</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateTag</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ManageNote</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PolicyExempt</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CreateRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DeleteRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RenameRepository</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EditPolicies</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">RemoveOthersLocks</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ManagePermissions</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PullRequestContribute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PullRequestBypassPolicy</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AccessLevels[]</command:parameterValue> <dev:type> <maml:name>AccessLevels[]</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="4" aliases="none"> <maml:name>Allow</maml:name> <maml:description> <maml:para>Enum of access rights to grant a user or group. Can be either the topic or the value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessLevels[]</command:parameterValue> <dev:type> <maml:name>AccessLevels[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Deny</maml:name> <maml:description> <maml:para>Enum of access rights to deny a user or group. Can be either the topic or the value.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AccessLevels[]</command:parameterValue> <dev:type> <maml:name>AccessLevels[]</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>Descriptor</maml:name> <maml:description> <maml:para>Descriptor of a user or group in Azure DevOps. Can be found using the `Get-ADOPSUser` or `Get-ADOPSGroup` command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="ProjectId"> <maml:name>Project</maml:name> <maml:description> <maml:para>Project ID or Project Name where the repo is located.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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="RepositoryId"> <maml:name>Repository</maml:name> <maml:description> <maml:para>Repository ID or Repository Name to set access 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> $s = @{ ProjectId = 'aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa' RepositoryId = '11111111-1111-1111-1111-111111111111' Descriptor = 'aad.AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA' Allow = 'RenameRepository','ForcePush' } PS C:\> Set-ADOPSGitPermission @s</dev:code> <dev:remarks> <maml:para>This command will grant the user with descriptor `aad.AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA` the force push, and rename repository rights on the repo with id `11111111-1111-1111-1111-111111111111`</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $s = @{ ProjectId = Get-ADOPSProject MyProject | Select-Object -ExpandProperty id RepositoryId = Get-ADOPSRepository -Project $projectId -Repository MyRepo | Select-Object -ExpandProperty id Descriptor = Get-ADOPSUser -Name 'userEmail@domain.onmicrosoft.com' | Select-Object -ExpandProperty descriptor Allow = 6235 } PS C:\> Set-ADOPSGitPermission @s</dev:code> <dev:remarks> <maml:para>This command will grant the user `userEmail@domain.onmicrosoft.com` the Administer, GenericRead, ForcePush, CreateBranch, ManageNote, EditPolicies, RemoveOthersLocks repository rights on the `MyRepo` repo</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> $s = @{ ProjectId = Get-ADOPSProject MyProject | Select-Object -ExpandProperty id RepositoryId = Get-ADOPSRepository -Project $projectId -Repository MyRepo | Select-Object -ExpandProperty id Descriptor = Get-ADOPSUser -Name 'userEmail@domain.onmicrosoft.com' | Select-Object -ExpandProperty descriptor Deny = Administer } PS C:\> Set-ADOPSGitPermission @s</dev:code> <dev:remarks> <maml:para>This command will deny the user `userEmail@domain.onmicrosoft.com` the Administer repository rights on the `MyRepo` repo</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSPipelineRetentionSettings</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSPipelineRetentionSettings</command:noun> <maml:description> <maml:para>Set pipeline retention settings for a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will set the retention settings values for a project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSPipelineRetentionSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline retention settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline retention settings 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="2" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Pipeline retention settings to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline retention settings 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="1" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The project to get pipeline retention settings 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="2" aliases="none"> <maml:name>Values</maml:name> <maml:description> <maml:para>Pipeline retention settings to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>A Key/value custom object of all the pipeline retention value</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>PS C:\> Set-ADOPSPipelineRetentionSettings -Project 'MyProject' -Values @{ artifactsRetention = 51 runRetention = 37 pullRequestRunRetention = 4 retainRunsPerProtectedBranch = 0 }</dev:code> <dev:remarks> <maml:para>This command will set all pipeline retention settings.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSPipelineRetentionSettings -Project 'MyProject' -Values @{ artifactsRetention = 51 }</dev:code> <dev:remarks> <maml:para>This command will set a single pipeline retention settings.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSPipelineSettings</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSPipelineSettings</command:noun> <maml:description> <maml:para>Set pipeline settings for a project.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will set pipeline settings for a project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSPipelineSettings</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline settings 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>Project</maml:name> <maml:description> <maml:para>The project to get pipeline settings 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>Values</maml:name> <maml:description> <maml:para>Pipeline settings to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to get pipeline settings 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>Project</maml:name> <maml:description> <maml:para>The project to get pipeline settings 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>Values</maml:name> <maml:description> <maml:para>Pipeline settings to set.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>A key/value custom object of all pipeline settings is returned.</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>PS C:\> Set-ADOPSPipelineSettings -Project 'MyProject' -Values @{ statusBadgesArePrivate }</dev:code> <dev:remarks> <maml:para>This command will set a single setting `statusBadgesArePrivate`</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSPipelineSettings -Project 'MyProject' -Values @{ statusBadgesArePrivate = $false disableImpliedYAMLCiTrigger = $true }</dev:code> <dev:remarks> <maml:para>This command will set multiple settings</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSProject</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSProject</command:noun> <maml:description> <maml:para>Updates Azure DevOps project information.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will update information of an Azure DevOps project.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set the Project 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to update the project in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Project ID of the project to update. Only needed if no ProjectName is given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Sets project visibility.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the status update to be set to 'Complete', 'Failed', or 'Cancelled'</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-ADOPSProject</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set the Project 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to update the project in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Project, Name"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name of the project to update. Only needed if no ProjectId is given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Sets project visibility.</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the status update to be set to 'Complete', 'Failed', or 'Cancelled'</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>Set the Project 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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization to update the project in.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProjectId</maml:name> <maml:description> <maml:para>Project ID of the project to update. Only needed if no ProjectName is given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Project, Name"> <maml:name>ProjectName</maml:name> <maml:description> <maml:para>Project name of the project to update. Only needed if no ProjectId is given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Visibility</maml:name> <maml:description> <maml:para>Sets project visibility.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Wait</maml:name> <maml:description> <maml:para>Wait for the status update to be set to 'Complete', 'Failed', or 'Cancelled'</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Set-ADOPSProject -ProjectName 'myProject' -Description 'New description' -Visibility Private -Wait</dev:code> <dev:remarks> <maml:para>This command will set the properties 'Description' and 'Visibility' of the 'myProject' project. It will wait until the status of the update is completed, failed, or cancelled before returning the result.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSProject -ProjectName 'myProject' -Description ([string]::Empty)</dev:code> <dev:remarks> <maml:para>This command will clear the 'myProject' project description. It will return the status even if the update is not yet completed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSRepository</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSRepository</command:noun> <maml:description> <maml:para>Changes or updates repository settings</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command changes or updates one or more repository settings. It can change one or all settings in one call. It will not ask for confirmation before updating or changing a value.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSRepository</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Repository ID. This can be found using Get-ADOPSRepository -Project MyProject</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project in which the repositoryID exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>The organization in which the repositoryID exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>DefaultBranch</maml:name> <maml:description> <maml:para>Sets the default branch to this value. If only branch name is given it will automatically add 'refs/heads/' to the path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>IsDisabled</maml:name> <maml:description> <maml:para>Sets the isDisabled flag of the repository to true or false.</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="False" position="5" aliases="none"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Renames the directory to this name</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DefaultBranch</maml:name> <maml:description> <maml:para>Sets the default branch to this value. If only branch name is given it will automatically add 'refs/heads/' to the path.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>IsDisabled</maml:name> <maml:description> <maml:para>Sets the isDisabled flag of the repository to true or false.</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="False" position="5" aliases="none"> <maml:name>NewName</maml:name> <maml:description> <maml:para>Renames the directory to this 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="2" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>The organization in which the repositoryID exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>The project in which the repositoryID exists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>Repository ID. This can be found using Get-ADOPSRepository -Project MyProject</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Set-ADOPSRepository -IsDisabled:$true -Project 'DummyProj' -RepositoryId 'd5f24968-f2ab-4048-bd65-58711420f6fa'</dev:code> <dev:remarks> <maml:para>This will set the repository with id d5f24968-f2ab-4048-bd65-58711420f6fa to status disabled. This repo will not be possible to work from after this action.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSRepository -NewName 'NewName'-Project 'DummyProj' -RepositoryId 'd5f24968-f2ab-4048-bd65-58711420f6fa'</dev:code> <dev:remarks> <maml:para>This will rename the repository with id d5f24968-f2ab-4048-bd65-58711420f6fa to 'NewName'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSRepository -DefaultBranch 'defBranch' -Project 'DummyProj' -RepositoryId 'd5f24968-f2ab-4048-bd65-58711420f6fa'</dev:code> <dev:remarks> <maml:para>This will set the default branch of the repository with id d5f24968-f2ab-4048-bd65-58711420f6fa to 'refs/heads/defBranch'. If only branch name is given it will automatically add 'refs/heads/' to the branch path.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ADOPSRepository -IsDisabled:$false -NewName 'NewName' -DefaultBranch 'refs/heads/NewBranch' -Project 'DummyProj' -RepositoryId 'd5f24968-f2ab-4048-bd65-58711420f6fa'</dev:code> <dev:remarks> <maml:para>This willperform all of the following actions on the repository with id d5f24968-f2ab-4048-bd65-58711420f6fa: - Set status to enabled.</maml:para> <maml:para>- Rename the repository to 'NewName'</maml:para> <maml:para>- set the default branch to 'refs/heads/NewBranch'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ADOPSServiceConnection</command:name> <command:verb>Set</command:verb> <command:noun>ADOPSServiceConnection</command:noun> <maml:description> <maml:para>Allows update of a Azure DevOps Service Connection.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If a managed identity will be used for the connection.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ADOPSServiceConnection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description field of the Service connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointOperation</maml:name> <maml:description> <maml:para>Undocumented.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>If a managed identity is to be used by the Service Connection.</maml: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>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServiceEndpointId</maml:name> <maml:description> <maml:para>The GUID of the Azure DevOps Service Endpoint.</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>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-ADOPSServiceConnection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description field of the Service connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointOperation</maml:name> <maml:description> <maml:para>Undocumented.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServiceEndpointId</maml:name> <maml:description> <maml:para>The GUID of the Azure DevOps Service Endpoint.</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>ServicePrincipal</maml:name> <maml:description> <maml:para>Azure AD Service principal, Application (Client) ID and valid secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" 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>ConnectionName</maml:name> <maml:description> <maml:para>Name of Service Connection in Azure DevOps.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description field of the Service connection.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndpointOperation</maml:name> <maml:description> <maml:para>Undocumented.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ManagedIdentity</maml:name> <maml:description> <maml:para>If a managed identity is to be used by the Service Connection.</maml:para> </maml:description> <command:parameterValue required="false" 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>Organization</maml:name> <maml:description> <maml:para>Name of Azure DevOps organization.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>Name of the Azure DevOps 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="False" position="named" aliases="none"> <maml:name>ServiceEndpointId</maml:name> <maml:description> <maml:para>The GUID of the Azure DevOps Service Endpoint.</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>ServicePrincipal</maml:name> <maml:description> <maml:para>Azure AD Service principal, Application (Client) ID and valid secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The subscription id that the service connection will be connected 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>SubscriptionName</maml:name> <maml:description> <maml:para>The subscription name that the service connection will be connected 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>TenantId</maml:name> <maml:description> <maml:para>The tenant id connected to your Azure AD and subscriptions.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>$ApplicationName = 'demo-vmss-scaling-app' $App = Get-AzADApplication -DisplayName $ApplicationName $AppCreds = New-AzADAppCredential -ApplicationId $App.AppId -EndDate (Get-Date).AddDays(7) $ServicePrincipal = Get-AzADServicePrincipal -ApplicationId $App.AppId $ServiceEndpoint = Get-ADOPSServiceConnection -Name "$ApplicationName-serviceconnection" -Project 'Azure' $ServiceConnectionParams = @{ TenantId = '34ca78c2-d872-455a-9977-88e161bd4ac0' SubscriptionName = 'MySubscriptionName' SubscriptionId = '8671f1d1-0bb1-4be0-b73c-6a8f3b354cf6' ConnectionName = $ServiceEndpoint.name Project = 'Azure' Organization = 'MyOrganization' ServiceEndpointId = $ServiceEndpoint.id Description = 'Service Principal to manage scaling of the VMSS.' ServicePrincipal= [pscredential]::new($ServicePrincipal.AppId,$(ConvertTo-SecureString -AsPlainText -Force $AppCreds.SecretText)) } Set-ADOPSServiceConnection @ServiceConnectionParams</dev:code> <dev:remarks> <maml:para>Updates the Service Connection called 'demo-vmss-scaling-app-serviceconnection' in the project called 'Azure' with a new secret.</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>Start-ADOPSPipeline</command:name> <command:verb>Start</command:verb> <command:noun>ADOPSPipeline</command:noun> <maml:description> <maml:para>Starts an Azure DevOps Pipeline.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Starts an Azure DevOps Pipeline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ADOPSPipeline</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the DevOps Pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>Name of the DevOps 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="2" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Name of the branch 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="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the DevOps Organization</maml:para> </maml:description> <command:parameterValue required="true" 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="2" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Name of the branch to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the DevOps Pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the DevOps Organization</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Project</maml:name> <maml:description> <maml:para>Name of the DevOps 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:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>Start-ADOPSPipeline -Name 'myPipeline' -Project 'myProject' -Organization 'ADOPS' -Branch 'main'</dev:code> <dev:remarks> <maml:para>Starts the DevOps Pipeline 'myPipeline' in the project 'myProject'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Start-ADOPSPipeline -Name 'myPipeline' -Project 'myProject' -Organization 'ADOPS' -Branch 'refs/other/branch'</dev:code> <dev:remarks> <maml:para>Starts the DevOps Pipeline 'myPipeline' in the project 'myProject' using the git ref 'refs/other/branch'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-ADOPSYamlFile</command:name> <command:verb>Test</command:verb> <command:noun>ADOPSYamlFile</command:noun> <maml:description> <maml:para>Test a yaml file against the Azure DevOps schema validator.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will test a yaml file against the yaml validation schema in Azure DevOps. It uses the same validation as the built in Azure DevOps yaml editor. The command needs a pipeline id to run against, but will not replace any code in the pipeline. False positives are possible if you use nested or external repos in your yaml code for example by using templates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-ADOPSYamlFile</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project where the pipeline is.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>File</maml:name> <maml:description> <maml:para>Path to the .yaml or .yml file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>PipelineId</maml:name> <maml:description> <maml:para>Pipeline Id to run the verification against. Can be found by running the command</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Get-ADOPSPipeline -Project MyProject -Name MyPipelineName</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="3" aliases="none"> <maml:name>Organization</maml:name> <maml:description> <maml:para>Name of the organization 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:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>File</maml:name> <maml:description> <maml:para>Path to the .yaml or .yml file</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</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>Organization</maml:name> <maml:description> <maml:para>Name of the organization to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>PipelineId</maml:name> <maml:description> <maml:para>Pipeline Id to run the verification against. Can be found by running the command</maml:para> <maml:para></maml:para> <maml:para></maml:para> <maml:para>Get-ADOPSPipeline -Project MyProject -Name MyPipelineName</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="0" aliases="none"> <maml:name>Project</maml:name> <maml:description> <maml:para>The name of the project where the pipeline is.</maml:para> </maml:description> <command:parameterValue required="true" 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>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>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>PS C:\> Test-ADOPSYamlFile -Project MyProject -File C:\GoodYamlFile.yml -PipelineId 3</dev:code> <dev:remarks> <maml:para>This command will validate "C:\GoodYamlFile" against pipeline id 3 in the "MyProject" project.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |