diff --git a/.github/workflows/OnIssue.yml b/.github/workflows/OnIssue.yml new file mode 100644 index 00000000..ac67416f --- /dev/null +++ b/.github/workflows/OnIssue.yml @@ -0,0 +1,31 @@ + +name: OnIssueChanged +on: + issues: + workflow_dispatch: +jobs: + RunGitPub: + runs-on: ubuntu-latest + if: ${{ success() }} + steps: + - name: Check out repository + uses: actions/checkout@v2 + - name: Use GitPub Action + uses: StartAutomating/GitPub@main + id: GitPub + with: + TargetBranch: edits-$([DateTime]::Now.ToString("r").Replace(":","-").Replace(" ", "")) + CommitMessage: Posting with GitPub [skip ci] + PublishParameters: | + { + "Get-GitPubIssue": { + "Repository": '${{github.repository}}' + }, + "Get-GitPubRelease": { + "Repository": '${{github.repository}}' + }, + "Publish-GitPubJekyll": { + "OutputPath": "docs/_posts" + } + } + diff --git a/.github/workflows/TestAndPublish.yml b/.github/workflows/TestAndPublish.yml index 83a1da7e..bcd50a5a 100644 --- a/.github/workflows/TestAndPublish.yml +++ b/.github/workflows/TestAndPublish.yml @@ -306,6 +306,8 @@ jobs: $Parameters.UserName = ${env:UserName} $Parameters.TagVersionFormat = ${env:TagVersionFormat} $Parameters.ReleaseNameFormat = ${env:ReleaseNameFormat} + $Parameters.ReleaseAsset = ${env:ReleaseAsset} + $Parameters.ReleaseAsset = $parameters.ReleaseAsset -split ';' -replace '^[''"]' -replace '[''"]$' foreach ($k in @($parameters.Keys)) { if ([String]::IsNullOrEmpty($parameters[$k])) { $parameters.Remove($k) @@ -331,7 +333,11 @@ jobs: # The release name format (default value: '$($imported.Name) $($imported.Version)') [string] - $ReleaseNameFormat = '$($imported.Name) $($imported.Version)' + $ReleaseNameFormat = '$($imported.Name) $($imported.Version)', + + # Any assets to attach to the release. Can be a wildcard or file name. + [string[]] + $ReleaseAsset ) @@ -377,32 +383,80 @@ jobs: if ($releaseExists) { "::warning::Release '$($releaseExists.Name )' Already Exists" | Out-Host - return + $releasedIt = $releaseExists + } else { + $releasedIt = Invoke-RestMethod -Uri $releasesURL -Method Post -Body ( + [Ordered]@{ + owner = '${{github.owner}}' + repo = '${{github.repository}}' + tag_name = $targetVersion + name = $ExecutionContext.InvokeCommand.ExpandString($ReleaseNameFormat) + body = + if ($env:RELEASENOTES) { + $env:RELEASENOTES + } elseif ($imported.PrivateData.PSData.ReleaseNotes) { + $imported.PrivateData.PSData.ReleaseNotes + } else { + "$($imported.Name) $targetVersion" + } + draft = if ($env:RELEASEISDRAFT) { [bool]::Parse($env:RELEASEISDRAFT) } else { $false } + prerelease = if ($env:PRERELEASE) { [bool]::Parse($env:PRERELEASE) } else { $false } + } | ConvertTo-Json + ) -Headers @{ + "Accept" = "application/vnd.github.v3+json" + "Content-type" = "application/json" + "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + } } - Invoke-RestMethod -Uri $releasesURL -Method Post -Body ( - [Ordered]@{ - owner = '${{github.owner}}' - repo = '${{github.repository}}' - tag_name = $targetVersion - name = $ExecutionContext.InvokeCommand.ExpandString($ReleaseNameFormat) - body = - if ($env:RELEASENOTES) { - $env:RELEASENOTES - } elseif ($imported.PrivateData.PSData.ReleaseNotes) { - $imported.PrivateData.PSData.ReleaseNotes - } else { - "$($imported.Name) $targetVersion" + + + + if (-not $releasedIt) { + throw "Release failed" + } else { + $releasedIt | Out-Host + } + + $releaseUploadUrl = $releasedIt.upload_url -replace '\{.+$' + + if ($ReleaseAsset) { + $fileList = Get-ChildItem -Recurse + $filesToRelease = + @(:nextFile foreach ($file in $fileList) { + foreach ($relAsset in $ReleaseAsset) { + if ($relAsset -match '[\*\?]') { + if ($file.Name -like $relAsset) { + $file; continue nextFile + } + } elseif ($file.Name -eq $relAsset -or $file.FullName -eq $relAsset) { + $file; continue nextFile + } } - draft = if ($env:RELEASEISDRAFT) { [bool]::Parse($env:RELEASEISDRAFT) } else { $false } - prerelease = if ($env:PRERELEASE) { [bool]::Parse($env:PRERELEASE) } else { $false } - } | ConvertTo-Json - ) -Headers @{ - "Accept" = "application/vnd.github.v3+json" - "Content-type" = "application/json" - "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + }) + + $releasedFiles = @{} + foreach ($file in $filesToRelease) { + if ($releasedFiles[$file.Name]) { + Write-Warning "Already attached file $($file.Name)" + continue + } else { + $fileBytes = [IO.File]::ReadAllBytes($file.FullName) + $releasedFiles[$file.Name] = + Invoke-RestMethod -Uri "${releaseUploadUrl}?name=$($file.Name)" -Headers @{ + "Accept" = "application/vnd.github+json" + "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + } -Body $fileBytes -ContentType Application/octet-stream + $releasedFiles[$file.Name] + } + } + + "Attached $($releasedFiles.Count) file(s) to release" | Out-Host } + + + } @Parameters - name: PublishPowerShellGallery id: PublishPowerShellGallery @@ -410,6 +464,8 @@ jobs: run: | $Parameters = @{} $Parameters.ModulePath = ${env:ModulePath} + $Parameters.Exclude = ${env:Exclude} + $Parameters.Exclude = $parameters.Exclude -split ';' -replace '^[''"]' -replace '[''"]$' foreach ($k in @($parameters.Keys)) { if ([String]::IsNullOrEmpty($parameters[$k])) { $parameters.Remove($k) @@ -418,12 +474,20 @@ jobs: Write-Host "::debug:: PublishPowerShellGallery $(@(foreach ($p in $Parameters.GetEnumerator()) {'-' + $p.Key + ' ' + $p.Value}) -join ' ')" & {param( [string] - $ModulePath + $ModulePath, + + [string[]] + $Exclude = @('*.png', '*.mp4', '*.jpg','*.jpeg', '*.gif', 'docs[/\]*') ) + $gitHubEvent = if ($env:GITHUB_EVENT_PATH) { [IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json } else { $null } + if (-not $Exclude) { + $Exclude = @('*.png', '*.mp4', '*.jpg','*.jpeg', '*.gif','docs[/\]*') + } + @" ::group::GitHubEvent @@ -431,6 +495,12 @@ jobs: ::endgroup:: "@ | Out-Host + @" + ::group::PSBoundParameters + $($PSBoundParameters | ConvertTo-Json -Depth 100) + ::endgroup:: + "@ | Out-Host + if (-not ($gitHubEvent.head_commit.message -match "Merge Pull Request #(?\d+)") -and (-not $gitHubEvent.psobject.properties['inputs'])) { "::warning::Pull Request has not merged, skipping Gallery Publish" | Out-Host @@ -448,9 +518,9 @@ jobs: if (-not $imported) { return } - $foundModule = try { Find-Module -Name $imported.Name -ErrorAction SilentlyContinue } catch {} + $foundModule = try { Find-Module -Name $imported.Name -ErrorAction SilentlyContinue} catch {} - if ($foundModule -and $foundModule.Version -ge $imported.Version) { + if ($foundModule -and (([Version]$foundModule.Version) -ge ([Version]$imported.Version))) { "::warning::Gallery Version of $moduleName is more recent ($($foundModule.Version) >= $($imported.Version))" | Out-Host } else { @@ -473,9 +543,24 @@ jobs: if (Test-Path $moduleGitPath) { Remove-Item -Recurse -Force $moduleGitPath } + + if ($Exclude) { + "::notice::Attempting to Exlcude $exclude" | Out-Host + Get-ChildItem $moduleTempPath -Recurse | + Where-Object { + foreach ($ex in $exclude) { + if ($_.FullName -like $ex) { + "::notice::Excluding $($_.FullName)" | Out-Host + return $true + } + } + } | + Remove-Item + } + Write-Host "Module Files:" Get-ChildItem $moduleTempPath -Recurse - Write-Host "Publishing $moduleName [$($imported.Version)] to Gallery" + Write-Host "Publishing $moduleName [$($imported.Version)] to Gallery" Publish-Module -Path $moduleTempPath -NuGetApiKey $gk if ($?) { Write-Host "Published to Gallery" @@ -485,25 +570,21 @@ jobs: } } } @Parameters - HelpOut: - runs-on: ubuntu-latest - if: ${{ success() }} - steps: - - name: Check out repository - uses: actions/checkout@v2 - - name: UseHelpOut - uses: StartAutomating/HelpOut@master - RunEZOut: + BuildPSDevOps: runs-on: ubuntu-latest if: ${{ success() }} steps: - name: Check out repository uses: actions/checkout@v2 + - name: Use PSSVG Action + uses: StartAutomating/PSSVG@main + id: PSSVG + - name: BuildPipeScript + uses: StartAutomating/PipeScript@main - name: UseEZOut uses: StartAutomating/EZOut@master - - name: Push Changes - shell: pwsh - run: git push; exit 0 + - name: UseHelpOut + uses: StartAutomating/HelpOut@master env: - SYSTEM_ACCESSTOKEN: ${{ secrets.AZUREDEVOPSPAT }} NoCoverage: true + SYSTEM_ACCESSTOKEN: ${{ secrets.AZUREDEVOPSPAT }} diff --git a/Assets/PSDevOps.svg b/Assets/PSDevOps.svg new file mode 100644 index 00000000..53a58792 --- /dev/null +++ b/Assets/PSDevOps.svg @@ -0,0 +1,14 @@ + + + + + + + + + PSDevOps + + ∞ + + + \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 894469f1..766f7426 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,22 @@ -## 0.5.8: +## 0.5.9: +* New-GitHubAction: Adding -OutputPath (#162) +* New-GitHubWorkflow: Adding -OutputPath (#163) +* New-ADOPipeline: Adding -OutputPath (#164) +* Updating Action (Preferring local bits and other cleanup) (#165) +* Import-BuildStep: Adding -SourceFile and -BuildStepName (Fixes #153) +* Updating ReleaseModule Step: Allowing -ReleaseAsset (Fixes #160) +* PublishPowerShellGallery : Adding -Exclude (Fixes #159). Fixing Module Version Comparison (Fixes #149) +* Connect-ADO: Adding -NoCache (Fixes #150) +* Convert-BuildStep: Fixing Github object parameter behavior (Fixes #158) +* Adding Get-ADOServiceHealth (Fixes #152) +* Adding Get-ADOAuditLog (Fixes #151) +* Adding PSDevOps.PSSVG.ps1 (Fixes #157) +* Updating Workflow (Fixes #155 Fixes #156) +* Adding GitHub/On/Issue (Fixes #154) + +--- + +## 0.5.8: * Running EZOut in Workflow (#148) * Adding support for HelpOut (#147) * Updating action (pushing changes) #144 @@ -13,6 +31,7 @@ * Get-ADOBuild: Passing along ProjectID and ProjectName * Get/Set-ADOPermission: Repov2 issue (#140) * Recategorizing Functions + --- ## 0.5.7: @@ -21,6 +40,7 @@ * Get/Set-ADOPermission: Support for ServiceEndpoints (#137) * Set-ADOPermission: Exposing specialized parameter sets (#138) * PSDevOps.WorkProcess objects now return .ProcessName and .ProcessID as alias properties + --- ## 0.5.6: @@ -34,12 +54,15 @@ * Adding "On" files for issue creation, deletion, or modification (Fixes #132) * Adding "On" files for common scheduling needs (Fixes #134) * ReleaseNameFormat can not be customized in ReleaseModule step (Fixes #130) + --- ## 0.5.5.1: * Allowing for [Reflection.AssemblyMetaData] attributes on step .ps1 files (to customize YAML). Issue #123 * Better support for Object and array parameters in Azure DevOps. Issue #125. + --- + ## 0.5.5: * Azure DevOps: Adding support for Shared Queries (Fixes #117) * Get-ADOWorkItem -SharedQuery can get shared queries @@ -49,14 +72,20 @@ * Adding Job/Step definitions to Release Module * Adding -NoCoverage to RunPester Step * Creating Example workflow that publishes PSDevOps. + --- + ## 0.5.4.2: * Adding Register-ADOArtifactFeed (Fixes #118) + --- + ## 0.5.4.1: * Fixing Invoke-ADORestApi issues: #111,#114,#115 * Attaching .BuildID and .DefinitionID properties to Get-ADOBuild where appropriate. + --- + ## 0.5.4: * Formatting Improvments: * Get-ADOField now includes .Type @@ -74,11 +103,15 @@ * TagModuleVersion * New-GitHubWorkflow/New-ADOPipeline now support -RootDirectory * Fixing pluralization / list issue with multiple GitHub Workflow "On" + --- + ## 0.5.3 * Get-ADORepository : Adding -PullRequestID * New/Set-ADOWorkItem: Fixing pipelining issue + --- + ## 0.5.2 * Get-ADOTeam: Adding alias -AreaPath for -TeamFieldValue, carrying on team property * Set-ADOTeam: Support for -DefaultAreaPath/-AreaPath (TeamFieldValues api, fixing issue #92) @@ -93,12 +126,16 @@ * Improving Formatting of Work Items (#82) * Adding -Tag * Invoke-ADORestAPI: Fixing issue with -QueryParameter + --- + ## 0.5.1 * Bugfixes: * Get-ADOTest: Fixing parameter sets and adding formatting. * Invoke-GitHubRESTAPI: Only using .ContentEncoding when present. + --- + ## 0.5 * Improved Git Functionality * New-GitHubAction @@ -117,7 +154,9 @@ * Get-ADOTest [new] * New-ADOPipeline now has -RootDirectory * Tons of New Type Definitions and Formatters - --- + +--- + ## 0.4.9 * New Command: Wait-ADOBuild * Start-ADOBuild @@ -129,6 +168,7 @@ * PSDevOps now includes a file to generate it's own build * PublishTest/CodeCoverage Results steps will always() run * Convert-BuildStep will add a .Name to each script step. + --- ## 0.4.8 @@ -141,7 +181,9 @@ * Get-ADOProject now has -TestRun, -TestPlan, -Release, and -PendingApproval (and better progress bars) * Get-ADOWorkItemType now has -Field * Commands for Picklists: Add/Get/Remove/Update-ADOPicklist + --- + ## 0.4.7 * New Commands: * Add/Get/Remove-ADOWiki @@ -149,7 +191,9 @@ * Bugfixes: * Honoring Get-ADOBuild -DefinitionName * Disconnect-ADO is now run prior at the start of Connect-ADO, and on module unload. ----- + +--- + ## 0.4.6 * New-ADOPipeline/New-GitHubWorkflow: Adding -BuildScript * Connect-ADO: Auto-detecting connected user's teams and adding tab completion for -Project/-ProjectID/-Team/-TeamID @@ -160,7 +204,9 @@ * Get-ADOBuild: Adding -DefinitionName * Invoke-ADORestAPI: Passing content length of 0 when body is empty. * Updating README + --- + ## 0.4.5 * New Commands: * Connect/Disconnect-ADO: Caching connection info and saving default parameters! @@ -174,14 +220,18 @@ * Updated Commands: * Get-ADOUser/Get-ADOTeam : Additional Graph scenarios added. * New/Set-ADOWorkItem : Added -BypassRule, -ValidateOnly, -SkipNotification + --- + ## 0.4.4 * Get-ADOTask: Adding -YAMLSchema. * Get-ADOTeam: Adding -Setting/-FieldValue/-Iteration/-Board. * Get-ADOAreaPath/ADOIterationPath: Making parameter names match cmdlet. Honoring -AreaPath/-IterationPath. * Get-ADOProject: Adding -ProcessConfiguration, -Plan, -PlanID, and -DeliveryTimeline. * New Command: Set-ADOTeam + --- + ## 0.4.3 * Renaming commands: * New-ADODashboard -> Add-ADODashboard @@ -191,7 +241,9 @@ * New Command: Get-ADOUser * Get-ADOAgentPool: Fixed pipelining bug, added -AgentName/-IncludeCapability/-IncludeLastCompletedRequest/-IncludeAssignedRequest. * Set-ADOProject: Can now -EnableFeature and -DisableFeature + --- + ## 0.4.2 * Build Step Improvements: * New-ADOPipeline now has -PowerShellCore and -WindowsPowerShell @@ -204,7 +256,9 @@ * New Extension Commands: Enable/Disbale-ADOExtension * Improved formatting/types for Extensions. * Breaking change: Install/Uninstall-ADOExtension now accept -PublisherID and -ExtensionID, not -PublisherName and -ExtensionName. + --- + ## 0.4.1 * More GitHub Functionality: * Write-GitHubDebug @@ -219,7 +273,9 @@ * Set-ADOProject * Repositories returned from a build definition are now decorated as PSDevOps.Repository * Improved testing and static analysis compliance + --- + ## 0.4 * Overhaul of GitHub Workflow functionality. * New-GitHubAction renamed to New-GitHubWorkflow @@ -228,54 +284,76 @@ * Added Write-GitHubError/GitHubWarning (updating Write-ADOError/Write-ADOWarning for consistency) * Cleaning up GitHub Workflow parts * Get-ADOTask no longer has -ApiVersion parameter + --- + ## 0.3.9 * New/Get/Remove-ADOWorkItemType: Create/get/remove work custom work item types, states, rules, and behaviors. * Added Get-ADOBuild -IncludeAllProperty/-IncludeLatestBuild. * ScriptCop Integration: PowerShelllStaticAnalysis stage now runs ScriptCop as well. * Improved ScriptAnalyzer Integration: Rule name is now outputted. + --- + ## 0.3.8 * Add/Remove-ADOAreaPath * Formatter for AreaPaths + --- + ## 0.3.7 * Convert-ADOPipeline now has -Passthru and -Wherefore * Get-ADOWorkProcess now has -Behavior and -WorkItemType * Get-ADOWorkItem now has -Mine, -CurrentIteration, -Comment, -Update, -Revision. + --- + ## 0.3.6.1 * Convert-ADOPipeline now binds to .Variables property * Fixing bug in PSDevOps.WorkItem types file, which displayed in formatting. + --- + ## 0.3.6 * Added: Get-ADOTask, Convert-ADOPipeline + --- + ## 0.3.5 * New Command: Get-ADOTeam * Get-ADOBuild -CodeCoverage * Progress bars on Get-ADORepository * Slight refactoring to make progress bars easier in any function + --- + ## 0.3.4.1 * Removing supplied parameters in commands generated by Import-ADOProxy. + --- + ## 0.3.4 * New capability: Import-ADOProxy (Import a proxy module with for your ADO / TFS instance) * New REST Commands: Get-ADOAreaPath, Get-ADOIterationPath, Get-ADOExtension * More Features: Get-ADORepository -FileList * Massive Internal Refactoring (switching to dynamic parameters for -PersonalAccessToken etc, standardizing pstypenames) + --- + ## 0.3.3 * Now Caching Personal Access Tokens! * URLEncoding all segments in Parts/ReplaceRouteParameter. * Ensuring all Azure DevOps YAML Parameters are wrapped in a string. + --- + ## 0.3.2 * Pester workarounds - Steps/InstallPester and Steps/RunPester now accept a PesterMaxVersion (defaulting to 4.99.99) * Convert-BuildStep handles blank parameter defaults correctly * Get-ADOBuild can get yaml definitions directly, e.g Get-ADOBuild -DefinitionID 123 -DefinitionYaml + --- + ## 0.3.1 * Bugfixes and Improvements to Convert/Import/Expand-BuildStep: 1. Enforcing pluralization of certain fields within Azure DevOps @@ -285,29 +363,39 @@ * Added Convert/Import/Expand-BuildStep * Allowing build steps to be defined in functions * Automagically importing build step parameters + --- + ## 0.2.9 * Get/New/Remove-ADORepository * Get/New/Remove-ADOServiceEndpoint * Get-ADOAgentPool * Improvements to New-ADOPipeline to avoid unexpected singletons + --- + ## 0.2.8 * Get/New/Update-ADOBuild * Improving New-ADOPipeline: * Unknown -InputObject properties will no longer be pluralized * Added 'Pool' to list of known singletons + --- + ## 0.2.7 * New Cmdlet: Set-ADOArtifactFeed * Improvements to New/Get/Remove-ADOArtifactFeed (better pipelining, renaming -FullyQualifiedID to -FeedID) + --- + ## 0.2.6 * New Cmdlets: * New/Get/Remove-ADOArtifactFeed * New/Remove-ADOProject * New-GitHubAction + --- + ## 0.2.5 * Improving Get-ADOWorkItem: * -Title allows getting work items by title @@ -318,15 +406,22 @@ * Formatting improved * Adding Get-ADOWorkProcess * Fixing issues with -ADOField commands when not provided a -Project + +--- + ## 0.2.4 * Adding Adding -CanSortBy, -IsQueryable, and -ReadOnly to New-ADOField. * Adding parameter help to New-ADOField + --- + ## 0.2.3 * Adding New/Remove-ADOField * Adding help to Get-ADOField * Adding formatting for fields + --- + ## 0.2.2 * Adding New/Set/Remove-ADOWorkItem * Adding Get-ADOField @@ -334,13 +429,19 @@ * New Parameter: New-ADOPipeline -Option * Initial formatting * Switching Parts to use latest VMImage + --- + ## 0.2.1 * Added Get-ADOWorkItem + --- + ## 0.2 * Added Invoke-ADORestAPI + --- + ## 0.1 Initial Commit --- \ No newline at end of file diff --git a/Formatting/ADO.Service.Health.format.ps1 b/Formatting/ADO.Service.Health.format.ps1 new file mode 100644 index 00000000..ac62da49 --- /dev/null +++ b/Formatting/ADO.Service.Health.format.ps1 @@ -0,0 +1,34 @@ +Write-FormatView -TypeName ADO.Service.Health -Action { + Write-FormatViewExpression -If { $_.Status.Health -eq 'Healthy'} -ForegroundColor 'Success' -ScriptBlock { + "Healthy @ $(($_.LastUpdated.ToLocalTime() | Out-String).Trim())" + } + Write-FormatViewExpression -If { $_.Status.Health -ne 'Healthy'} -ForegroundColor 'Warning' -ScriptBlock { + "$($_.Status.Health) @ $(($_.LastUpdated.ToLocalTime() | Out-String).Trim())" + } + Write-FormatViewExpression -Newline + + Write-FormatViewExpression -Property Services -Enumerate -ControlName ADO.Service.Health.ServiceGeographies -if { $_.Status.Health -ne 'Healthy'} +} + +Write-FormatView -Name ADO.Service.Health.ServiceGeographies -TypeName n/a -Action { + Write-FormatViewExpression -If { -not @($_.geographies.Health -ne 'Healthy') } -ForegroundColor 'Success' -ScriptBlock { + "* $($_.id)" + } + Write-FormatViewExpression -If { @($_.geographies.Health -ne 'Healthy')} -ForegroundColor 'Warning' -ScriptBlock { + "* $($_.id)" + } + Write-FormatViewExpression -Newline + + Write-FormatViewExpression -If { @($_.geographies.Health -ne 'Healthy')} -ControlName ADO.Service.Health.Geography -Property geographies -Enumerate +} -AsControl + +Write-FormatView -Name ADO.Service.Health.Geography -TypeName n/a -Action { + Write-FormatViewExpression -If { $_.Health -eq 'Healthy'} -ForegroundColor 'Success' -ScriptBlock { + " * $($_.Name) (Healthy)" + } + Write-FormatViewExpression -If { $_.Health -ne 'Healthy'} -ForegroundColor 'Warning' -ScriptBlock { + " * $($_.Name) ($($_.Health))" + } + Write-FormatViewExpression -Newline +} -AsControl + diff --git a/Functions/AzureDevOps/Connect-ADO.ps1 b/Functions/AzureDevOps/Connect-ADO.ps1 index a22a9e77..d8c9b3f7 100644 --- a/Functions/AzureDevOps/Connect-ADO.ps1 +++ b/Functions/AzureDevOps/Connect-ADO.ps1 @@ -42,7 +42,12 @@ # The Server. If this points to a TFS server, it should be the root TFS url, i.e. http://localhost:8080/tfs [Parameter(ValueFromPipelineByPropertyName)] [uri] - $Server + $Server, + + # If set, will not cache teams and projects in order to create argument completers. + # If you are using a restricted Personal Access Token, this may prevent errors. + [switch] + $NoCache ) begin { @@ -87,14 +92,14 @@ #region Cache PersonalAccessToken if ($PersonalAccessToken) { $Script:CachedPersonalAccessToken = $PersonalAccessToken - $getProjects = @(Get-ADOProject @PSBoundParameters) - $getMyTeams = @(Get-ADOTeam @PSBoundParameters -Mine) - if (-not ($getMyTeams -or $getProjects)) { - Disconnect-ADO - return - } - - + if (-not $NoCache) { + $getProjects = @(Get-ADOProject @PSBoundParameters) + $getMyTeams = @(Get-ADOTeam @PSBoundParameters -Mine) + if (-not ($getMyTeams -or $getProjects)) { + Disconnect-ADO + return + } + } } #endregion Cache PersonalAccessToken @@ -107,6 +112,8 @@ $output #endregion Cache and Output Connection + if ($NoCache) { return } + $registerArgumentCompleter = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Register-ArgumentCompleter','Cmdlet') diff --git a/Functions/AzureDevOps/Get-ADOAuditLog.ps.ps1 b/Functions/AzureDevOps/Get-ADOAuditLog.ps.ps1 new file mode 100644 index 00000000..762d27ff --- /dev/null +++ b/Functions/AzureDevOps/Get-ADOAuditLog.ps.ps1 @@ -0,0 +1,57 @@ +function Get-ADOAuditLog { + <# + .SYNOPSIS + Gets the Azure DevOps Audit Log + .DESCRIPTION + Gets the Azure DevOps Audit Log for a Given Organization + .EXAMPLE + Get-ADOAuditLog + .LINK + https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/audit-log/query + #> + [Rest("https://auditservice.dev.azure.com/{Organization}/_apis/audit/auditlog", + Invoker='Invoke-ADORestAPI', + UriParameterHelp={ + @{Organization = "The Organization"} + }, + QueryParameter = { +# QueryParameter can be many types, including a [ScriptBlock]. +# So in order to work as expected, we need to return a [ScriptBlock] +{ + param( + # The size of the batch of audit log entries. + [Parameter(ValueFromPipelineByPropertyName)] + [int] + $BatchSize, + + # The start time. + [Parameter(ValueFromPipelineByPropertyName)] + [DateTime] + $StartTime, + + # The end time. + [Parameter(ValueFromPipelineByPropertyName)] + [DateTime] + $EndTime, + + # The api-version. By default, 7.1-preview.1 + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("api-version")] + [string] + $ApiVersion = '7.1-preview.1' + ) +} +} + )] + param() + + dynamicParam { . $GetInvokeParameters -DynamicParameter } + + begin { + #region Copy Invoke-ADORestAPI parameters + $invokeParams = . $getInvokeParameters $PSBoundParameters + $invokeParams.ExpandProperty = 'decoratedAuditLogEntries' + $invokeParams.PSTypeName = "ADO.AuditLog.Entry" + #endregion Copy Invoke-ADORestAPI parameters + } +} diff --git a/Functions/AzureDevOps/Get-ADOAuditLog.ps1 b/Functions/AzureDevOps/Get-ADOAuditLog.ps1 new file mode 100644 index 00000000..73c55df9 --- /dev/null +++ b/Functions/AzureDevOps/Get-ADOAuditLog.ps1 @@ -0,0 +1,233 @@ +function Get-ADOAuditLog { +<# + .SYNOPSIS + Gets the Azure DevOps Audit Log + .DESCRIPTION + Gets the Azure DevOps Audit Log for a Given Organization + .EXAMPLE + Get-ADOAuditLog + .LINK + https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/audit-log/query + +#> + + param( +# The Organization +[Parameter(Mandatory,ValueFromPipelineByPropertyName,ParameterSetName='https://auditservice.dev.azure.com/{Organization}/_apis/audit/auditlog')] +[string] +$Organization, +# The size of the batch of audit log entries. + [Parameter(ValueFromPipelineByPropertyName)] + [int] + $BatchSize, +# The start time. + [Parameter(ValueFromPipelineByPropertyName)] + [DateTime] + $StartTime, +# The end time. + [Parameter(ValueFromPipelineByPropertyName)] + [DateTime] + $EndTime, +# The api-version. By default, 7.1-preview.1 + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("api-version")] + [string] + $ApiVersion = '7.1-preview.1' + ) + dynamicParam { . $GetInvokeParameters -DynamicParameter +} + begin { + #region Copy Invoke-ADORestAPI parameters + $invokeParams = . $getInvokeParameters $PSBoundParameters + $invokeParams.ExpandProperty = 'decoratedAuditLogEntries' + $invokeParams.PSTypeName = "ADO.AuditLog.Entry" + #endregion Copy Invoke-ADORestAPI parameters + + # Declare a Regular Expression to match URL variables. + $RestVariable = [Regex]::new(@' +# Matches URL segments and query strings containing variables. +# Variables can be enclosed in brackets or curly braces, or preceeded by a $ or : +(?> # A variable can be in a URL segment or subdomain + (?[/\.]) # Match the ing slash|dot ... + (?\?)? # ... an optional ? (to indicate optional) ... + (?: + \{(?\w+)\}| # ... A name in {} OR + \[(?\w+)\]| # A name in [] OR + \<(?\w+)\>| # A name in <> OR + \:(?\w+) # A : followed by a + ) +| + (? # If it's optional it can also be + [{\[](?/) # a bracket or brace, followed by a slash + ) + (?\w+)[}\]] # then a name followed by } or ] +| # OR it can be in a query parameter: + (?[?&]) # Match The ing ? or & ... + (?[\w\-]+) # ... the parameter name ... + = # ... an equals ... + (?\?)? # ... an optional ? (to indicate optional) ... + (?: + \{(?\w+)\}| # ... A name in {} OR + \[(?\w+)\]| # A name in [] OR + \<(?\w+)\>| # A name in <> OR + \:(?\w+) # A : followed by a + ) +) +'@, 'IgnoreCase,IgnorePatternWhitespace') + + # Next declare a script block that will replace the rest variable. + $ReplaceRestVariable = { + param($match) + if ($uriParameter -and $uriParameter[$match.Groups["Variable"].Value]) { + return $match.Groups["Start"].Value + $( + if ($match.Groups["Query"].Success) { $match.Groups["Query"].Value + '=' } + ) + + ([Web.HttpUtility]::UrlEncode( + $uriParameter[$match.Groups["Variable"].Value] + )) + } else { + return '' + } + } + $myCmd = $MyInvocation.MyCommand + function ConvertRestInput { + param([Collections.IDictionary]$RestInput = @{}, [switch]$ToQueryString) + foreach ($ri in @($RestInput.GetEnumerator())) { + $RestParameterAttributes = @($myCmd.Parameters[$ri.Key].Attributes) + $restParameterName = $ri.Key + $restParameterValue = $ri.Value + foreach ($attr in $RestParameterAttributes) { + if ($attr -is [ComponentModel.AmbientValueAttribute] -and + $attr.Value -is [ScriptBlock]) { + $_ = $this = $ri.Value + $restParameterValue = & $attr.Value + } + if ($attr -is [ComponentModel.DefaultBindingPropertyAttribute]) { + $restParameterName = $attr.Name + } + } + $restParameterValue = + if ($restParameterValue -is [DateTime]) { + $restParameterValue.Tostring('o') + } + elseif ($restParameterValue -is [switch]) { + $restParameterValue -as [bool] + } + else { + if ($ToQueryString -and + $restParameterValue -is [Array] -and + $JoinQueryValue) { + $restParameterValue -join $JoinQueryValue + } else { + $restParameterValue + } + + } + + if ($restParameterValue -is [Collections.IDictionary]) { + $RestInput.Remove($ri.Key) + foreach ($kv in $restParameterValue.GetEnumerator()) { + $RestInput[$kv.Key] = $kv.Value + } + } elseif ($restParameterName -ne $ri.Key) { + $RestInput.Remove($ri.Key) + $RestInput[$restParameterName] = $restParameterValue + } else { + $RestInput[$ri.Key] = $restParameterValue + } + } + $RestInput + + } + +} +process { + $InvokeCommand = 'Invoke-ADORestAPI' + $invokerCommandinfo = + $ExecutionContext.SessionState.InvokeCommand.GetCommand('Invoke-ADORestAPI', 'All') + $method = '' + $contentType = '' + $bodyParameterNames = @('') + $queryParameterNames = @('BatchSize','StartTime','EndTime','ApiVersion') + $joinQueryValue = '' + $uriParameterNames = @('Organization') + $endpoints = @("https://auditservice.dev.azure.com/{Organization}/_apis/audit/auditlog") + $ForEachOutput = { + + } + if ($ForEachOutput -match '^\s{0,}$') { + $ForEachOutput = $null + } + if (-not $invokerCommandinfo) { + Write-Error "Unable to find invoker '$InvokeCommand'" + return + } + if (-not $psParameterSet) { $psParameterSet = $psCmdlet.ParameterSetName} + if ($psParameterSet -eq '__AllParameterSets') { $psParameterSet = $endpoints[0]} + $originalUri = "$psParameterSet" + if (-not $PSBoundParameters.ContainsKey('UriParameter')) { + $uriParameter = [Ordered]@{} + } + foreach ($uriParameterName in $uriParameterNames) { + if ($psBoundParameters.ContainsKey($uriParameterName)) { + $uriParameter[$uriParameterName] = $psBoundParameters[$uriParameterName] + } + } + $uri = $RestVariable.Replace($originalUri, $ReplaceRestVariable) + $invokeSplat = @{} + $invokeSplat.Uri = $uri + if ($method) { + $invokeSplat.Method = $method + } + if ($ContentType -and $invokerCommandInfo.Parameters.ContentType) { + $invokeSplat.ContentType = $ContentType + } + if ($InvokeParams -and $InvokeParams -is [Collections.IDictionary]) { + $invokeSplat += $InvokeParams + } + $QueryParams = [Ordered]@{} + foreach ($QueryParameterName in $QueryParameterNames) { + if ($PSBoundParameters.ContainsKey($QueryParameterName)) { + $QueryParams[$QueryParameterName] = $PSBoundParameters[$QueryParameterName] + } else { + $queryDefault = $ExecutionContext.SessionState.PSVariable.Get($QueryParameterName).Value + if ($null -ne $queryDefault) { + $QueryParams[$QueryParameterName] = $queryDefault + } + } + } + $queryParams = ConvertRestInput $queryParams -ToQueryString + if ($invokerCommandinfo.Parameters['QueryParameter'] -and + $invokerCommandinfo.Parameters['QueryParameter'].ParameterType -eq [Collections.IDictionary]) { + $invokeSplat.QueryParameter = $QueryParams + } else { + $queryParamStr = + @(foreach ($qp in $QueryParams.GetEnumerator()) { + $qpValue = $qp.value + if ($JoinQueryValue -eq '&') { + foreach ($qVal in $qpValue -split '&') { + "$($qp.Key)=$([Web.HttpUtility]::UrlEncode($qValue).Replace('+', '%20'))" + } + } else { + "$($qp.Key)=$([Web.HttpUtility]::UrlEncode($qpValue).Replace('+', '%20'))" + } + }) -join '&' + if ($invokeSplat.Uri.Contains('?')) { + $invokeSplat.Uri = "$($invokeSplat.Uri)" + '&' + $queryParamStr + } else { + $invokeSplat.Uri = "$($invokeSplat.Uri)" + '?' + $queryParamStr + } + } + Write-Verbose "$($invokeSplat.Uri)" + if ($ForEachOutput) { + if ($ForEachOutput.Ast.ProcessBlock) { + & $invokerCommandinfo @invokeSplat | & $ForEachOutput + } else { + & $invokerCommandinfo @invokeSplat | ForEach-Object -Process $ForEachOutput + } + } else { + & $invokerCommandinfo @invokeSplat + } +} +} + diff --git a/Functions/AzureDevOps/Get-ADOServiceHealth.ps.ps1 b/Functions/AzureDevOps/Get-ADOServiceHealth.ps.ps1 new file mode 100644 index 00000000..07659729 --- /dev/null +++ b/Functions/AzureDevOps/Get-ADOServiceHealth.ps.ps1 @@ -0,0 +1,59 @@ +function Get-ADOServiceHealth { + <# + .SYNOPSIS + Gets the Azure DevOps Service Health + .DESCRIPTION + Gets the Service Health of Azure DevOps. + .EXAMPLE + Get-ADOServiceHealth + .LINK + https://docs.microsoft.com/en-us/rest/api/azure/devops/status/health/get + #> + [Rest("https://status.dev.azure.com/_apis/status/health", + Invoker='Invoke-ADORestAPI', + UriParameterHelp={ + @{Organization = "The Organization"} + }, + JoinQueryValue = ',', + QueryParameter = { +# QueryParameter can be many types, including a [ScriptBlock]. +# So in order to work as expected, we need to return a [ScriptBlock] +{ + param( + # If provided, will query for health in a given geographic region. + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("services")] + [Alias('Services')] + [ValidateSet('Artifacts', 'Boards', 'Core services', 'Other services', 'Pipelines', 'Repos', 'Test Plans')] + [string[]] + $Service, + + # If provided, will query for health in a given geographic region. + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("geographies")] + [Alias('Geographies','Region', 'Regions')] + [ValidateSet('APAC', 'AU', 'BR', 'CA', 'EU', 'IN', 'UK', 'US')] + [string[]] + $Geography, + + # The api-version. By default, 6.0 + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("api-version")] + [string] + $ApiVersion = '6.0-preview' + ) +} +} + )] + param() + + dynamicParam { . $GetInvokeParameters -DynamicParameter } + + begin { + #region Copy Invoke-ADORestAPI parameters + $invokeParams = . $getInvokeParameters $PSBoundParameters + $invokeParams.PSTypeName = "ADO.Service.Health" + #endregion Copy Invoke-ADORestAPI parameters + } +} + diff --git a/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 b/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 new file mode 100644 index 00000000..c4ea6073 --- /dev/null +++ b/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 @@ -0,0 +1,177 @@ +function Get-ADOServiceHealth { +<# + .SYNOPSIS + Gets the Azure DevOps Service Health + .DESCRIPTION + Gets the Service Health of Azure DevOps. + .EXAMPLE + Get-ADOServiceHealth + .LINK + https://docs.microsoft.com/en-us/rest/api/azure/devops/status/health/get + +#> + + param( +# If provided, will query for health in a given geographic region. + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("services")] + [Alias('Services')] + [ValidateSet('Artifacts', 'Boards', 'Core services', 'Other services', 'Pipelines', 'Repos', 'Test Plans')] + [string[]] + $Service, +# If provided, will query for health in a given geographic region. + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("geographies")] + [Alias('Geographies','Region', 'Regions')] + [ValidateSet('APAC', 'AU', 'BR', 'CA', 'EU', 'IN', 'UK', 'US')] + [string[]] + $Geography, +# The api-version. By default, 6.0 + [Parameter(ValueFromPipelineByPropertyName)] + [ComponentModel.DefaultBindingProperty("api-version")] + [string] + $ApiVersion = '6.0-preview' + ) + dynamicParam { . $GetInvokeParameters -DynamicParameter +} + begin { + #region Copy Invoke-ADORestAPI parameters + $invokeParams = . $getInvokeParameters $PSBoundParameters + $invokeParams.PSTypeName = "ADO.Service.Health" + #endregion Copy Invoke-ADORestAPI parameters + + $myCmd = $MyInvocation.MyCommand + function ConvertRestInput { + param([Collections.IDictionary]$RestInput = @{}, [switch]$ToQueryString) + foreach ($ri in @($RestInput.GetEnumerator())) { + $RestParameterAttributes = @($myCmd.Parameters[$ri.Key].Attributes) + $restParameterName = $ri.Key + $restParameterValue = $ri.Value + foreach ($attr in $RestParameterAttributes) { + if ($attr -is [ComponentModel.AmbientValueAttribute] -and + $attr.Value -is [ScriptBlock]) { + $_ = $this = $ri.Value + $restParameterValue = & $attr.Value + } + if ($attr -is [ComponentModel.DefaultBindingPropertyAttribute]) { + $restParameterName = $attr.Name + } + } + $restParameterValue = + if ($restParameterValue -is [DateTime]) { + $restParameterValue.Tostring('o') + } + elseif ($restParameterValue -is [switch]) { + $restParameterValue -as [bool] + } + else { + if ($ToQueryString -and + $restParameterValue -is [Array] -and + $JoinQueryValue) { + $restParameterValue -join $JoinQueryValue + } else { + $restParameterValue + } + + } + + if ($restParameterValue -is [Collections.IDictionary]) { + $RestInput.Remove($ri.Key) + foreach ($kv in $restParameterValue.GetEnumerator()) { + $RestInput[$kv.Key] = $kv.Value + } + } elseif ($restParameterName -ne $ri.Key) { + $RestInput.Remove($ri.Key) + $RestInput[$restParameterName] = $restParameterValue + } else { + $RestInput[$ri.Key] = $restParameterValue + } + } + $RestInput + + } + +} +process { + $InvokeCommand = 'Invoke-ADORestAPI' + $invokerCommandinfo = + $ExecutionContext.SessionState.InvokeCommand.GetCommand('Invoke-ADORestAPI', 'All') + $method = '' + $contentType = '' + $bodyParameterNames = @('') + $queryParameterNames = @('Service','Geography','ApiVersion') + $joinQueryValue = ',' + $uriParameterNames = @('') + $endpoints = @("https://status.dev.azure.com/_apis/status/health") + $ForEachOutput = { + + } + if ($ForEachOutput -match '^\s{0,}$') { + $ForEachOutput = $null + } + if (-not $invokerCommandinfo) { + Write-Error "Unable to find invoker '$InvokeCommand'" + return + } + if (-not $psParameterSet) { $psParameterSet = $psCmdlet.ParameterSetName} + if ($psParameterSet -eq '__AllParameterSets') { $psParameterSet = $endpoints[0]} + $uri = $endpoints[0] + + $invokeSplat = @{} + $invokeSplat.Uri = $uri + if ($method) { + $invokeSplat.Method = $method + } + if ($ContentType -and $invokerCommandInfo.Parameters.ContentType) { + $invokeSplat.ContentType = $ContentType + } + if ($InvokeParams -and $InvokeParams -is [Collections.IDictionary]) { + $invokeSplat += $InvokeParams + } + $QueryParams = [Ordered]@{} + foreach ($QueryParameterName in $QueryParameterNames) { + if ($PSBoundParameters.ContainsKey($QueryParameterName)) { + $QueryParams[$QueryParameterName] = $PSBoundParameters[$QueryParameterName] + } else { + $queryDefault = $ExecutionContext.SessionState.PSVariable.Get($QueryParameterName).Value + if ($null -ne $queryDefault) { + $QueryParams[$QueryParameterName] = $queryDefault + } + } + } + $queryParams = ConvertRestInput $queryParams -ToQueryString + if ($invokerCommandinfo.Parameters['QueryParameter'] -and + $invokerCommandinfo.Parameters['QueryParameter'].ParameterType -eq [Collections.IDictionary]) { + $invokeSplat.QueryParameter = $QueryParams + } else { + $queryParamStr = + @(foreach ($qp in $QueryParams.GetEnumerator()) { + $qpValue = $qp.value + if ($JoinQueryValue -eq '&') { + foreach ($qVal in $qpValue -split '&') { + "$($qp.Key)=$([Web.HttpUtility]::UrlEncode($qValue).Replace('+', '%20'))" + } + } else { + "$($qp.Key)=$([Web.HttpUtility]::UrlEncode($qpValue).Replace('+', '%20'))" + } + }) -join '&' + if ($invokeSplat.Uri.Contains('?')) { + $invokeSplat.Uri = "$($invokeSplat.Uri)" + '&' + $queryParamStr + } else { + $invokeSplat.Uri = "$($invokeSplat.Uri)" + '?' + $queryParamStr + } + } + Write-Verbose "$($invokeSplat.Uri)" + if ($ForEachOutput) { + if ($ForEachOutput.Ast.ProcessBlock) { + & $invokerCommandinfo @invokeSplat | & $ForEachOutput + } else { + & $invokerCommandinfo @invokeSplat | ForEach-Object -Process $ForEachOutput + } + } else { + & $invokerCommandinfo @invokeSplat + } +} +} + + diff --git a/Functions/AzureDevOps/New-ADOPipeline.ps1 b/Functions/AzureDevOps/New-ADOPipeline.ps1 index aa4fab35..bb71560c 100644 --- a/Functions/AzureDevOps/New-ADOPipeline.ps1 +++ b/Functions/AzureDevOps/New-ADOPipeline.ps1 @@ -17,10 +17,10 @@ [CmdletBinding()] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "", Justification="Does not change state")] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSPossibleIncorrectComparisonWithNull", "", Justification="Explicitly checking for null (0 is ok)")] - [OutputType([string],[PSObject])] + [OutputType([string],[PSObject], [IO.FileInfo])] param( - # The InputObject - [Parameter(ValueFromPipeline)] + # The InputObject + [Parameter(ValueFromPipeline)] [PSObject]$InputObject, # If set, will use map the system access token to an environment variable in each script step. @@ -63,8 +63,8 @@ $DefaultParameter = @{}, - # A list of build scripts. Each build script will run as a step in the same job. - [string[]] + # A list of build scripts. Each build script will run as a step in the same job. + [string[]] $BuildScript, # If set, will output the created objects instead of creating YAML. @@ -81,7 +81,11 @@ # If provided, will directly reference build steps beneath this directory. [string] - $RootDirectory + $RootDirectory, + + # If provided, will output to a given path and return a file. + [string] + $OutputPath ) dynamicParam { @@ -120,15 +124,15 @@ if ($ThingNames[$kv.Key]) { $stepsByType[$kv.Key] = $kv.Value } elseif ($kv.Key -eq 'InputObject') { - if ($InputObject -is [Collections.IDictionary]) { - foreach ($key in $InputObject.Keys) { - $stepsByType[$key] = $InputObject.$key - } - } - elseif ($InputObject) { - foreach ($property in $InputObject.psobject.properties) { - $stepsByType[$property.name] = $InputObject.$key - } + if ($InputObject -is [Collections.IDictionary]) { + foreach ($key in $InputObject.Keys) { + $stepsByType[$key] = $InputObject.$key + } + } + elseif ($InputObject) { + foreach ($property in $InputObject.psobject.properties) { + $stepsByType[$property.name] = $InputObject.$key + } } } else { $adoOptions[$kv.Key] = $kv.Value @@ -136,12 +140,12 @@ } #endregion Map Parameters - if ($BuildScript) { - $stepsByType['steps'] = - @( - Get-Item $BuildScript -ErrorAction SilentlyContinue | - Convert-BuildStep -BuildSystem ADOPipeline - ) + if ($BuildScript) { + $stepsByType['steps'] = + @( + Get-Item $BuildScript -ErrorAction SilentlyContinue | + Convert-BuildStep -BuildSystem ADOPipeline + ) } #region Expand Map @@ -160,6 +164,11 @@ if ($PassThru) { $yamlToBe + } elseif ($OutputPath) { + @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine | + Set-Content -Path $OutputPath + + Get-Item -Path $OutputPath } else { @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine } diff --git a/Functions/Convert-BuildStep.ps1 b/Functions/Convert-BuildStep.ps1 index f2759dca..9167dd91 100644 --- a/Functions/Convert-BuildStep.ps1 +++ b/Functions/Convert-BuildStep.ps1 @@ -386,9 +386,9 @@ "`$Parameters.$ParameterName = `$parameters.$ParameterName -match 'true';" } if ([psobject], [object],[PSObject[]] -contains $paramType) { - "`$Parameters.$ParameterName = ConvertFrom-JSON @'" + + "`$Parameters.$ParameterName = ConvertFrom-JSON @`"" + [Environment]::NewLine + - '${{parameters.$ParameterName}}' + [Environment]::NewLine + "'@" + "`$(`$Parameters.$ParameterName)" + [Environment]::NewLine + '"@' } # If the parameter type was a scriptblock if ([ScriptBlock], [ScriptBlock[]] -contains $paramType) { diff --git a/Functions/GitHub/New-GitHubAction.ps1 b/Functions/GitHub/New-GitHubAction.ps1 index 2e200ec1..20bb3dee 100644 --- a/Functions/GitHub/New-GitHubAction.ps1 +++ b/Functions/GitHub/New-GitHubAction.ps1 @@ -100,7 +100,11 @@ # The color used for branding. By default, blue. [ValidateSet('white', 'yellow', 'blue', 'green', 'orange', 'red', 'purple', 'gray-dark')] [string] - $Color = 'blue' + $Color = 'blue', + + # If provided, will output to a given path and return a file. + [string] + $OutputPath ) begin { @@ -223,7 +227,14 @@ if ($PassThru) { $yamlToBe - } else { + } + elseif ($OutputPath) { + @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine | + Set-Content -Path $OutputPath + + Get-Item -Path $OutputPath + } + else { @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine } diff --git a/Functions/GitHub/New-GitHubWorkflow.ps1 b/Functions/GitHub/New-GitHubWorkflow.ps1 index 339208ea..8db9c2cf 100644 --- a/Functions/GitHub/New-GitHubWorkflow.ps1 +++ b/Functions/GitHub/New-GitHubWorkflow.ps1 @@ -24,83 +24,88 @@ function New-GitHubWorkflow { # A table of additional settings to apply wherever a part is used. # For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessToken)'}} [Collections.IDictionary] - $Option, - - # A collection of environment variables used throughout the build. - [Parameter(ValueFromPipelineByPropertyName)] - [Alias('Env')] - [Collections.IDictionary] - $Environment, - - # The name of parameters that should be supplied from an event. - # Wildcards accepted. - [Parameter(ValueFromPipelineByPropertyName)] - [Alias('InputParameters')] - [Collections.IDictionary] - $InputParameter, - - # The name of parameters that should be supplied from build variables. - # Wildcards accepted. - [Parameter(ValueFromPipelineByPropertyName)] - [Alias('VariableParameters')] - [string[]] - $VariableParameter, - - # The name of parameters that should be excluded. - [Parameter(ValueFromPipelineByPropertyName)] - [Alias('ExcludeParameters')] - [string[]] - $ExcludeParameter, - - # The name of parameters that should be referred to uniquely. - # For instance, if converting function foo($bar) {} and -UniqueParameter is 'bar' - # The build parameter would be foo_bar. - [Parameter(ValueFromPipelineByPropertyName)] - [Alias('UniqueParameters')] - [string[]] - $UniqueParameter, - - # A collection of default parameters. - [Parameter(ValueFromPipelineByPropertyName)] - [Collections.IDictionary] + $Option, + + # A collection of environment variables used throughout the build. + [Parameter(ValueFromPipelineByPropertyName)] + [Alias('Env')] + [Collections.IDictionary] + $Environment, + + # The name of parameters that should be supplied from an event. + # Wildcards accepted. + [Parameter(ValueFromPipelineByPropertyName)] + [Alias('InputParameters')] + [Collections.IDictionary] + $InputParameter, + + # The name of parameters that should be supplied from build variables. + # Wildcards accepted. + [Parameter(ValueFromPipelineByPropertyName)] + [Alias('VariableParameters')] + [string[]] + $VariableParameter, + + # The name of parameters that should be excluded. + [Parameter(ValueFromPipelineByPropertyName)] + [Alias('ExcludeParameters')] + [string[]] + $ExcludeParameter, + + # The name of parameters that should be referred to uniquely. + # For instance, if converting function foo($bar) {} and -UniqueParameter is 'bar' + # The build parameter would be foo_bar. + [Parameter(ValueFromPipelineByPropertyName)] + [Alias('UniqueParameters')] + [string[]] + $UniqueParameter, + + # A collection of default parameters. + [Parameter(ValueFromPipelineByPropertyName)] + [Collections.IDictionary] $DefaultParameter = @{}, - # If set, will output the created objects instead of creating YAML. - [switch] + # If set, will output the created objects instead of creating YAML. + [switch] $PassThru, # A list of build scripts. Each build script will run as a step in the same job. [string[]] $BuildScript, + # If provided, will directly reference build steps beneath this directory. [string] - $RootDirectory - ) + $RootDirectory, + + # If provided, will output to a given path and return a file. + [string] + $OutputPath + ) dynamicParam { $DynamicParameters = [Management.Automation.RuntimeDefinedParameterDictionary]::new() $mynoun = $MyInvocation.MyCommand.Noun - $ThingNames = $script:ComponentNames.$mynoun - if ($ThingNames) { - foreach ($kv in $ThingNames.GetEnumerator()) { - $k = $kv.Key.Substring(0,1).ToUpper() + $kv.Key.Substring(1) - $DynamicParameters.Add($k, $(& $newDynamicParameter $k $kv.Value ([string[]]))) - } + $ThingNames = $script:ComponentNames.$mynoun + if ($ThingNames) { + foreach ($kv in $ThingNames.GetEnumerator()) { + $k = $kv.Key.Substring(0,1).ToUpper() + $kv.Key.Substring(1) + $DynamicParameters.Add($k, $(& $newDynamicParameter $k $kv.Value ([string[]]))) + } } return $DynamicParameters } - begin { - $expandBuildStepCmd = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Expand-BuildStep','Function') - $workflowOptions = @{} - $expandGitHubBuildStep = @{ - BuildSystem = $mynoun - SingleItemName = 'Name','On' - DictionaryItemName = 'Jobs', 'Inputs','Outputs' - BuildOption = $workflowOptions - } - $DoNotExpandParameters = 'InputObject', 'BuildScript', 'RootDirectory' + begin { + $expandBuildStepCmd = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Expand-BuildStep','Function') + $workflowOptions = @{} + $expandGitHubBuildStep = @{ + BuildSystem = $mynoun + SingleItemName = 'Name','On' + DictionaryItemName = 'Jobs', 'Inputs','Outputs' + BuildOption = $workflowOptions + } + $DoNotExpandParameters = 'InputObject', 'BuildScript', 'RootDirectory' } process { @@ -114,7 +119,7 @@ function New-GitHubWorkflow { foreach ($kv in $myParams.GetEnumerator()) { if ($ThingNames[$kv.Key]) { $stepsByType[$kv.Key] = $kv.Value - } elseif ($DoNotExpandParameters -notcontains $kv.Key) { + } elseif ($DoNotExpandParameters -notcontains $kv.Key) { $workflowOptions[$kv.Key] = $kv.Value } } @@ -136,11 +141,11 @@ function New-GitHubWorkflow { if ($RootDirectory) { $workflowOptions.RootDirectory = $RootDirectory} #region Expand Input - $expandSplat = @{} + $PSBoundParameters - foreach ($k in @($expandSplat.Keys)) { - if (-not $expandBuildStepCmd.Parameters[$k]) { - $expandSplat.Remove($k) - } + $expandSplat = @{} + $PSBoundParameters + foreach ($k in @($expandSplat.Keys)) { + if (-not $expandBuildStepCmd.Parameters[$k]) { + $expandSplat.Remove($k) + } } #endregion Expand Input $yamlToBe = Expand-BuildStep -StepMap $stepsByType @expandSplat @expandGitHubBuildStep @@ -167,10 +172,15 @@ function New-GitHubWorkflow { } } - if ($PassThru) { - $yamlToBe - } else { - @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine + if ($PassThru) { + $yamlToBe + } elseif ($OutputPath) { + @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine | + Set-Content -Path $OutputPath + + Get-Item -Path $OutputPath + } else { + @($yamlToBe | & $toYaml -Indent -2) -join '' -replace "$([Environment]::NewLine * 2)", [Environment]::NewLine } } } \ No newline at end of file diff --git a/Functions/Import-BuildStep.ps1 b/Functions/Import-BuildStep.ps1 index 7a5f34a6..8139933d 100644 --- a/Functions/Import-BuildStep.ps1 +++ b/Functions/Import-BuildStep.ps1 @@ -27,6 +27,23 @@ [string] $SourcePath, + # The source path to a single item. + [Parameter(Mandatory,ParameterSetName="SourceFile",ValueFromPipelineByPropertyName)] + [Alias('ScriptFile','ScriptPath','Source')] + [string] + $SourceFile, + + # The type the source file will be in a given build system. By default, step. + [Parameter(ParameterSetName="SourceFile",ValueFromPipelineByPropertyName)] + [string] + $BuildStepType = "step", + + # An optional name for the build step. If none is provided, the filename will be used + [Parameter(ParameterSetName="SourceFile",ValueFromPipelineByPropertyName)] + [string] + $BuildStepName, + + # A list of commands to include. [Parameter(ParameterSetName='Module',ValueFromPipelineByPropertyName)] [string[]] @@ -191,7 +208,7 @@ } } #endregion Import Module Commands - } + } elseif ($PSCmdlet.ParameterSetName -eq 'SourcePath') { @@ -263,13 +280,35 @@ Path = $f.FullName BuildSystem = $bs } - - $stepData.pstypenames.add("PSDevOps.$bs.BuildStep") $ThingData["$($t).$($n)"] = $stepData } #endregion Import Files for a BuildSystem } } + elseif ($PSCmdlet.ParameterSetName -eq 'SourceFile') { + $resolvedSourceFile = $executionContext.SessionState.Path.GetResolvedPSPathFromPSPath($SourceFile) + if (-not $resolvedSourceFile) { return } + $fileItem = Get-Item -LiteralPath $resolvedSourceFile + foreach ($bs in $BuildSystem) { + $stepData = [PSCustomObject][Ordered]@{ + PSTypeName = "PSDevOps.BuildStep" + Name = $fileItem.Name -replace '\.[^\.]+$' + Type = $BuildStepType + Extension = $fileItem.Extension + Path = $fileItem.FullName + BuildSystem = $bs + } + $t, $n = $stepData.Type, $stepData.Name + + $ThingNames = $script:ComponentNames[ $bs] + $ThingData = $script:ComponentMetaData[$bs] + + $stepData.pstypenames.add("PSDevOps.$bs.BuildStep") + $ThingNames[$t].add($stepData.Name) + $ThingData["$($t).$($n)"] = $stepData + } + + } } } \ No newline at end of file diff --git a/GitHub/Actions/PSDevOpsAction.ps1 b/GitHub/Actions/PSDevOpsAction.ps1 index 26724fb6..2f909fa3 100644 --- a/GitHub/Actions/PSDevOpsAction.ps1 +++ b/GitHub/Actions/PSDevOpsAction.ps1 @@ -47,43 +47,111 @@ $UserEmail, $UserName ) +#region Initial Logging + +# Output the parameters passed to this script (for debugging) "::group::Parameters" | Out-Host [PSCustomObject]$PSBoundParameters | Format-List | Out-Host "::endgroup::" | Out-Host -if ($env:GITHUB_ACTION_PATH) { - $PSDevOpsModulePath = Join-Path $env:GITHUB_ACTION_PATH 'PSDevOps.psd1' - if (Test-path $PSDevOpsModulePath) { - Import-Module $PSDevOpsModulePath -Force -PassThru | Out-String - } else { - throw "PSDevOps not found" - } -} elseif (-not (Get-Module PSDevOps)) { - throw "Action Path not found" +# Get the GitHub Event +$gitHubEvent = + if ($env:GITHUB_EVENT_PATH) { + [IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json + } else { $null } + +# Log the GitHub Event +@" +::group::GitHubEvent +$($gitHubEvent | ConvertTo-Json -Depth 100) +::endgroup:: +"@ | Out-Host + +# Check that there is a workspace (and throw if there is not) +if (-not $env:GITHUB_WORKSPACE) { throw "No GitHub workspace" } + +#endregion Initial Logging + +# Check to ensure we are on a branch +$branchName = git rev-parse --abrev-ref HEAD +# If we were not, return. +if (-not $branchName) { + "::warning::Not on a branch" | Out-Host + return } -"::notice title=ModuleLoaded::PSDevOps Loaded from Path - $($PSDevOpsModulePath)" | Out-Host +#region Configure UserName and Email +if (-not $UserName) { + $UserName = + if ($env:GITHUB_TOKEN) { + Invoke-RestMethod -uri "https://api.github.com/user" -Headers @{ + Authorization = "token $env:GITHUB_TOKEN" + } | + Select-Object -First 1 -ExpandProperty name + } else { + $env:GITHUB_ACTOR + } +} +if (-not $UserEmail) { + $GitHubUserEmail = + if ($env:GITHUB_TOKEN) { + Invoke-RestMethod -uri "https://api.github.com/user/emails" -Headers @{ + Authorization = "token $env:GITHUB_TOKEN" + } | + Select-Object -First 1 -ExpandProperty email + } else {''} + $UserEmail = + if ($GitHubUserEmail) { + $GitHubUserEmail + } else { + "$UserName@github.com" + } +} +git config --global user.email $UserEmail +git config --global user.name $UserName +#endregion Configure UserName and Email -$ght = - if ($GitHubToken) { - $GitHubToken - } elseif ($env:GITHUB_TOKEN) { - $env:GITHUB_TOKEN +git pull | Out-Host + + +#region Load Action Module +$ActionModuleName = "EZOut" +$ActionModuleFileName = "$ActionModuleName.psd1" + +# Try to find a local copy of the action's module. +# This allows the action to use the current branch's code instead of the action's implementation. +$PSD1Found = Get-ChildItem -Recurse -Filter "*.psd1" | + Where-Object Name -eq $ActionModuleFileName | + Select-Object -First 1 + +$ActionModulePath, $ActionModule = + # If there was a .PSD1 found + if ($PSD1Found) { + $PSD1Found.FullName # import from there. + Import-Module $PSD1Found.FullName -Force -PassThru + } + # Otherwise, if we have a GITHUB_ACTION_PATH + elseif ($env:GITHUB_ACTION_PATH) + { + $actionModulePath = Join-Path $env:GITHUB_ACTION_PATH $ActionModuleFileName + if (Test-path $actionModulePath) { + $actionModulePath + Import-Module $actionModulePath -Force -PassThru + } else { + throw "$actionModuleName not found" + } + } + elseif (-not (Get-Module $ActionModuleName)) { + throw "$actionModulePath could not be loaded." } -"::group::Connecting to Github" | Out-Host -$connectStart = [DateTime]::now -Connect-GitHub -PersonalAccessToken $GitHubToken -PassThru | - ForEach-Object { - $githubModule = $_ - "::notice title=Connected::Connect-GitHub finished - $($githubModule.ExportedCommands.Count) Commands Imported" | Out-Host - $githubModule.ExportedCommands.Keys -join [Environment]::Newline | Out-Host - } | - Out-Host -"::endgroup::" | Out-Host + +"::notice title=ModuleLoaded::$actionModuleName Loaded from Path - $($actionModulePath)" | Out-Host +#endregion Load Action Module + $anyFilesChanged = $false -$processScriptOutput = { process { +filter ProcessScriptOutput { $out = $_ $outItem = Get-Item -Path $out -ErrorAction SilentlyContinue $fullName, $shouldCommit = @@ -98,11 +166,32 @@ $processScriptOutput = { process { git commit -m "$($out.Message)" } elseif ($out.CommitMessage) { git commit -m "$($out.CommitMessage)" + } elseif ($gitHubEvent.head_commit.message) { + git commit -m "$($gitHubEvent.head_commit.message)" } $anyFilesChanged = $true } $out -} } +} + +#endregion Declare Functions and Variables + +$ght = + if ($GitHubToken) { + $GitHubToken + } elseif ($env:GITHUB_TOKEN) { + $env:GITHUB_TOKEN + } +"::group::Connecting to Github" | Out-Host +$connectStart = [DateTime]::now +Connect-GitHub -PersonalAccessToken $GitHubToken -PassThru | + ForEach-Object { + $githubModule = $_ + "::notice title=Connected::Connect-GitHub finished - $($githubModule.ExportedCommands.Count) Commands Imported" | Out-Host + $githubModule.ExportedCommands.Keys -join [Environment]::Newline | Out-Host + } | + Out-Host +"::endgroup::" | Out-Host if (-not $UserName) { $UserName = $env:GITHUB_ACTOR } @@ -117,11 +206,11 @@ git pull | Out-Host $PSDevOpsScriptStart = [DateTime]::Now if ($PSDevOpsScript) { Invoke-Expression -Command $PSDevOpsScript | - . $processScriptOutput | + ProcessScriptOutput | Out-Host } $PSDevOpsScriptTook = [Datetime]::Now - $PSDevOpsScriptStart -"::set-output name=PSDevOpsScriptRuntime::$($PSDevOpsScriptTook.TotalMilliseconds)" | Out-Host +# "::set-output name=PSDevOpsScriptRuntime::$($PSDevOpsScriptTook.TotalMilliseconds)" | Out-Host $PSDevOpsPS1Start = [DateTime]::Now $PSDevOpsPS1List = @() @@ -134,15 +223,15 @@ if (-not $SkipPSDevOpsPS1) { $PSDevOpsPS1Count++ "::notice title=Running::$($_.Fullname)" | Out-Host . $_.FullName | - . $processScriptOutput | + ProcessScriptOutput | Out-Host } } $PSDevOpsPS1EndStart = [DateTime]::Now $PSDevOpsPS1Took = [Datetime]::Now - $PSDevOpsPS1Start -"::set-output name=PSDevOpsPS1Count::$($PSDevOpsPS1List.Length)" | Out-Host -"::set-output name=PSDevOpsPS1Files::$($PSDevOpsPS1List -join ';')" | Out-Host -"::set-output name=PSDevOpsPS1Runtime::$($PSDevOpsPS1Took.TotalMilliseconds)" | Out-Host +# "::set-output name=PSDevOpsPS1Count::$($PSDevOpsPS1List.Length)" | Out-Host +# "::set-output name=PSDevOpsPS1Files::$($PSDevOpsPS1List -join ';')" | Out-Host +# "::set-output name=PSDevOpsPS1Runtime::$($PSDevOpsPS1Took.TotalMilliseconds)" | Out-Host if ($CommitMessage -or $anyFilesChanged) { if ($CommitMessage) { dir $env:GITHUB_WORKSPACE -Recurse | @@ -155,10 +244,7 @@ if ($CommitMessage -or $anyFilesChanged) { git commit -m $ExecutionContext.SessionState.InvokeCommand.ExpandString($CommitMessage) } - - - - + $checkDetached = git symbolic-ref -q HEAD if (-not $LASTEXITCODE) { "::notice::Pushing Changes" | Out-Host diff --git a/GitHub/Jobs/BuildModule.psd1 b/GitHub/Jobs/BuildModule.psd1 new file mode 100644 index 00000000..9499d023 --- /dev/null +++ b/GitHub/Jobs/BuildModule.psd1 @@ -0,0 +1,17 @@ +@{ + "runs-on" = "ubuntu-latest" + if = '${{ success() }}' + steps = @( + @{ + name = 'Check out repository' + uses = 'actions/checkout@v2' + }, + 'RunPipeScript', + 'RunEZOut', + 'RunHelpOut' + ) +} + + + + diff --git a/GitHub/Jobs/BuildPSDevOps.psd1 b/GitHub/Jobs/BuildPSDevOps.psd1 new file mode 100644 index 00000000..d9d89db3 --- /dev/null +++ b/GitHub/Jobs/BuildPSDevOps.psd1 @@ -0,0 +1,18 @@ +@{ + "runs-on" = "ubuntu-latest" + if = '${{ success() }}' + steps = @( + @{ + name = 'Check out repository' + uses = 'actions/checkout@v2' + }, + @{ + name = 'Use PSSVG Action' + uses = 'StartAutomating/PSSVG@main' + id = 'PSSVG' + }, + 'RunPipeScript', + 'RunEZOut', + 'RunHelpOut' + ) +} \ No newline at end of file diff --git a/GitHub/Jobs/BuildPipeScript.psd1 b/GitHub/Jobs/BuildPipeScript.psd1 new file mode 100644 index 00000000..86b64e57 --- /dev/null +++ b/GitHub/Jobs/BuildPipeScript.psd1 @@ -0,0 +1,14 @@ +@{ + "runs-on" = "ubuntu-latest" + if = '${{ success() }}' + steps = @( + @{ + name = 'Check out repository' + uses = 'actions/checkout@v2' + }, + 'RunPipeScript' + ) +} + + + diff --git a/GitHub/Jobs/HelpOut.psd1 b/GitHub/Jobs/RunHelpOut.psd1 similarity index 100% rename from GitHub/Jobs/HelpOut.psd1 rename to GitHub/Jobs/RunHelpOut.psd1 diff --git a/GitHub/Jobs/UsePiecemeal.psd1 b/GitHub/Jobs/UsePiecemeal.psd1 new file mode 100644 index 00000000..6d110b22 --- /dev/null +++ b/GitHub/Jobs/UsePiecemeal.psd1 @@ -0,0 +1,14 @@ +@{ + "runs-on" = "ubuntu-latest" + if = '${{ success() }}' + steps = @( + @{ + name = 'Check out repository' + uses = 'actions/checkout@v2' + }, + 'RunPiecemeal' + ) +} + + + diff --git a/GitHub/On/Issue.psd1 b/GitHub/On/Issue.psd1 new file mode 100644 index 00000000..8d09af83 --- /dev/null +++ b/GitHub/On/Issue.psd1 @@ -0,0 +1,7 @@ +@{ + issues = @{ +# types =@('opened','edited','deleted','transferred','pinned','unpinned','closed','reopened','assigned','unassigned','labeled','unlabeled','locked','unlocked','milestoned','demilestoned') + } +} + + diff --git a/GitHub/Steps/PublishPowerShellGallery.ps1 b/GitHub/Steps/PublishPowerShellGallery.ps1 index 44c587da..04a78ed8 100644 --- a/GitHub/Steps/PublishPowerShellGallery.ps1 +++ b/GitHub/Steps/PublishPowerShellGallery.ps1 @@ -1,11 +1,19 @@ param( [string] -$ModulePath +$ModulePath, + +[string[]] +$Exclude = @('*.png', '*.mp4', '*.jpg','*.jpeg', '*.gif', 'docs[/\]*') ) + $gitHubEvent = if ($env:GITHUB_EVENT_PATH) { [IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json } else { $null } +if (-not $Exclude) { + $Exclude = @('*.png', '*.mp4', '*.jpg','*.jpeg', '*.gif','docs[/\]*') +} + @" ::group::GitHubEvent @@ -13,6 +21,12 @@ $($gitHubEvent | ConvertTo-Json -Depth 100) ::endgroup:: "@ | Out-Host +@" +::group::PSBoundParameters +$($PSBoundParameters | ConvertTo-Json -Depth 100) +::endgroup:: +"@ | Out-Host + if (-not ($gitHubEvent.head_commit.message -match "Merge Pull Request #(?\d+)") -and (-not $gitHubEvent.psobject.properties['inputs'])) { "::warning::Pull Request has not merged, skipping Gallery Publish" | Out-Host @@ -30,9 +44,9 @@ if (-not $ModulePath) { if (-not $imported) { return } -$foundModule = try { Find-Module -Name $imported.Name -ErrorAction SilentlyContinue } catch {} +$foundModule = try { Find-Module -Name $imported.Name -ErrorAction SilentlyContinue} catch {} -if ($foundModule -and $foundModule.Version -ge $imported.Version) { +if ($foundModule -and (([Version]$foundModule.Version) -ge ([Version]$imported.Version))) { "::warning::Gallery Version of $moduleName is more recent ($($foundModule.Version) >= $($imported.Version))" | Out-Host } else { @@ -55,9 +69,24 @@ if ($foundModule -and $foundModule.Version -ge $imported.Version) { if (Test-Path $moduleGitPath) { Remove-Item -Recurse -Force $moduleGitPath } + + if ($Exclude) { + "::notice::Attempting to Exlcude $exclude" | Out-Host + Get-ChildItem $moduleTempPath -Recurse | + Where-Object { + foreach ($ex in $exclude) { + if ($_.FullName -like $ex) { + "::notice::Excluding $($_.FullName)" | Out-Host + return $true + } + } + } | + Remove-Item + } + Write-Host "Module Files:" Get-ChildItem $moduleTempPath -Recurse - Write-Host "Publishing $moduleName [$($imported.Version)] to Gallery" + Write-Host "Publishing $moduleName [$($imported.Version)] to Gallery" Publish-Module -Path $moduleTempPath -NuGetApiKey $gk if ($?) { Write-Host "Published to Gallery" diff --git a/GitHub/Steps/ReleaseModule.ps1 b/GitHub/Steps/ReleaseModule.ps1 index a264e68f..659454e1 100644 --- a/GitHub/Steps/ReleaseModule.ps1 +++ b/GitHub/Steps/ReleaseModule.ps1 @@ -17,7 +17,11 @@ $TagVersionFormat = 'v$($imported.Version)', # The release name format (default value: '$($imported.Name) $($imported.Version)') [string] -$ReleaseNameFormat = '$($imported.Name) $($imported.Version)' +$ReleaseNameFormat = '$($imported.Name) $($imported.Version)', + +# Any assets to attach to the release. Can be a wildcard or file name. +[string[]] +$ReleaseAsset ) @@ -63,29 +67,77 @@ $releaseExists = $listOfReleases | Where-Object tag_name -eq $targetVersion if ($releaseExists) { "::warning::Release '$($releaseExists.Name )' Already Exists" | Out-Host - return + $releasedIt = $releaseExists +} else { + $releasedIt = Invoke-RestMethod -Uri $releasesURL -Method Post -Body ( + [Ordered]@{ + owner = '${{github.owner}}' + repo = '${{github.repository}}' + tag_name = $targetVersion + name = $ExecutionContext.InvokeCommand.ExpandString($ReleaseNameFormat) + body = + if ($env:RELEASENOTES) { + $env:RELEASENOTES + } elseif ($imported.PrivateData.PSData.ReleaseNotes) { + $imported.PrivateData.PSData.ReleaseNotes + } else { + "$($imported.Name) $targetVersion" + } + draft = if ($env:RELEASEISDRAFT) { [bool]::Parse($env:RELEASEISDRAFT) } else { $false } + prerelease = if ($env:PRERELEASE) { [bool]::Parse($env:PRERELEASE) } else { $false } + } | ConvertTo-Json + ) -Headers @{ + "Accept" = "application/vnd.github.v3+json" + "Content-type" = "application/json" + "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + } } -Invoke-RestMethod -Uri $releasesURL -Method Post -Body ( - [Ordered]@{ - owner = '${{github.owner}}' - repo = '${{github.repository}}' - tag_name = $targetVersion - name = $ExecutionContext.InvokeCommand.ExpandString($ReleaseNameFormat) - body = - if ($env:RELEASENOTES) { - $env:RELEASENOTES - } elseif ($imported.PrivateData.PSData.ReleaseNotes) { - $imported.PrivateData.PSData.ReleaseNotes - } else { - "$($imported.Name) $targetVersion" + + + +if (-not $releasedIt) { + throw "Release failed" +} else { + $releasedIt | Out-Host +} + +$releaseUploadUrl = $releasedIt.upload_url -replace '\{.+$' + +if ($ReleaseAsset) { + $fileList = Get-ChildItem -Recurse + $filesToRelease = + @(:nextFile foreach ($file in $fileList) { + foreach ($relAsset in $ReleaseAsset) { + if ($relAsset -match '[\*\?]') { + if ($file.Name -like $relAsset) { + $file; continue nextFile + } + } elseif ($file.Name -eq $relAsset -or $file.FullName -eq $relAsset) { + $file; continue nextFile + } } - draft = if ($env:RELEASEISDRAFT) { [bool]::Parse($env:RELEASEISDRAFT) } else { $false } - prerelease = if ($env:PRERELEASE) { [bool]::Parse($env:PRERELEASE) } else { $false } - } | ConvertTo-Json -) -Headers @{ - "Accept" = "application/vnd.github.v3+json" - "Content-type" = "application/json" - "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + }) + + $releasedFiles = @{} + foreach ($file in $filesToRelease) { + if ($releasedFiles[$file.Name]) { + Write-Warning "Already attached file $($file.Name)" + continue + } else { + $fileBytes = [IO.File]::ReadAllBytes($file.FullName) + $releasedFiles[$file.Name] = + Invoke-RestMethod -Uri "${releaseUploadUrl}?name=$($file.Name)" -Headers @{ + "Accept" = "application/vnd.github+json" + "Authorization" = 'Bearer ${{ secrets.GITHUB_TOKEN }}' + } -Body $fileBytes -ContentType Application/octet-stream + $releasedFiles[$file.Name] + } + } + + "Attached $($releasedFiles.Count) file(s) to release" | Out-Host } + + + diff --git a/GitHub/Steps/RunPiecemeal.psd1 b/GitHub/Steps/RunPiecemeal.psd1 new file mode 100644 index 00000000..b1793899 --- /dev/null +++ b/GitHub/Steps/RunPiecemeal.psd1 @@ -0,0 +1,4 @@ +@{ + name = "UsePiecemeal" + uses = "StartAutomating/Piecemeal@main" +} diff --git a/GitHub/Steps/RunPipeScript.psd1 b/GitHub/Steps/RunPipeScript.psd1 new file mode 100644 index 00000000..61b2d122 --- /dev/null +++ b/GitHub/Steps/RunPipeScript.psd1 @@ -0,0 +1,4 @@ +@{ + name = "BuildPipeScript" + uses = "StartAutomating/PipeScript@main" +} diff --git a/PSDevOps.GitHubAction.PSDevOps.ps1 b/PSDevOps.GitHubAction.PSDevOps.ps1 new file mode 100644 index 00000000..59cfa812 --- /dev/null +++ b/PSDevOps.GitHubAction.PSDevOps.ps1 @@ -0,0 +1,5 @@ +#requires -Module PSDevOps +New-GitHubAction -Name "UsePSDevOps" -Description 'PowerShell Tools for DevOps (including a PowerShell wrapper for the GitHub REST API)' -Action PSDevOpsAction -Icon activity | + Set-Content .\action.yml -Encoding UTF8 -PassThru + + diff --git a/PSDevOps.GitHubWorkflow.psdevops.ps1 b/PSDevOps.GitHubWorkflow.psdevops.ps1 index 8faea620..ef4209d7 100644 --- a/PSDevOps.GitHubWorkflow.psdevops.ps1 +++ b/PSDevOps.GitHubWorkflow.psdevops.ps1 @@ -1,20 +1,10 @@ #requires -Module PSDevOps Push-Location $PSScriptRoot -New-GitHubWorkflow -Name "Analyze, Test, Tag, and Publish" -On Push, PullRequest, Demand -Job PowerShellStaticAnalysis, TestPowerShellOnLinux, TagReleaseAndPublish, HelpOut, RunEZOut -Environment @{ +New-GitHubWorkflow -Name "Analyze, Test, Tag, and Publish" -On Push, PullRequest, Demand -Job PowerShellStaticAnalysis, TestPowerShellOnLinux, TagReleaseAndPublish, BuildPSDevOps -Environment @{ SYSTEM_ACCESSTOKEN = '${{ secrets.AZUREDEVOPSPAT }}' NoCoverage = $true }| Set-Content .\.github\workflows\TestAndPublish.yml -Encoding UTF8 -PassThru - -New-GitHubWorkflow -Name "Trace On Issue Opened Or Edited" -On IssueOpenedOrEdited -Job TraceGitHubEvent | - Set-Content .\.github\workflows\TraceIssueOpenedOrEdited.yml -Encoding UTF8 -PassThru - -New-GitHubWorkflow -Name "Trace On Issue Closed" -On IssueClosed -Job TraceGitHubEvent | - Set-Content .\.github\workflows\TraceIssueClosed.yml -Encoding UTF8 -PassThru - -New-GitHubWorkflow -Name "Trace On Issue Comment" -On IssueComment -Job TraceGitHubEvent | - Set-Content .\.github\workflows\TraceIssueComment.yml -Encoding UTF8 -PassThru - Pop-Location \ No newline at end of file diff --git a/PSDevOps.HelpOut.ps1 b/PSDevOps.HelpOut.ps1 index 77df575f..4478758a 100644 --- a/PSDevOps.HelpOut.ps1 +++ b/PSDevOps.HelpOut.ps1 @@ -8,6 +8,5 @@ if ($PSDevOpsLoaded) { "::error:: PSDevOps not loaded" |Out-Host } if ($PSDevOpsLoaded) { - Save-MarkdownHelp -Module $PSDevOpsLoaded.Name -PassThru | - Add-Member ScriptProperty CommitMessage {"Updating $($this.Name)" } -Force -PassThru + Save-MarkdownHelp -Module $PSDevOpsLoaded.Name -PassThru } diff --git a/PSDevOps.PSSVG.ps1 b/PSDevOps.PSSVG.ps1 new file mode 100644 index 00000000..d945cbf4 --- /dev/null +++ b/PSDevOps.PSSVG.ps1 @@ -0,0 +1,35 @@ +#requires -Module PSSVG + +$assetsPath = Join-Path $PSScriptRoot Assets + +if (-not (Test-path $assetsPath)) { + $null = New-Item -ItemType Directory -Path $assetsPath -Force +} += -ViewBox 200, 100 -OutputPath (Join-Path $assetsPath "PSDevOps.svg") -Content @( + $commonParameters = @{ + Fill = '#4488FF' + Stroke = 'black' + StrokeWidth = '0.05' + } + + = -Id psChevron -Content @( + = -Points (@( + "40,20" + "45,20" + "60,50" + "35,80" + "32.5,80" + "55,50" + ) -join ' ') + ) -ViewBox 100, 100 + + = -Href '#psChevron' -X -32.5% -Y 30% @commonParameters -Height 40% -Opacity .9 -Content @( + = -RepeatDur 'indefinite' -Values '.9;.8;.9' -AttributeName opacity -Dur 2s + ) + + = -X 50% -Y 50% -Fontsize 24 "PSDevOps" -DominantBaseline middle -TextAnchor 'middle' -Fill '#4488ff' -FontFamily sans-serif + = -X 62.5% -Y 48% -DominantBaseline middle -TextAnchor 'middle' -Fill '#4488ff' -FontFamily sans-serif -Opacity .5 -FontWeight 'lighter' @( + = -Content "∞" -Fontsize 12 + = -RepeatDur 'indefinite' -Values '.5;.4;.5' -AttributeName opacity -Dur 2s + ) +) diff --git a/PSDevOps.ezformat.ps1 b/PSDevOps.ezformat.ps1 index 8da5b405..2b039339 100644 --- a/PSDevOps.ezformat.ps1 +++ b/PSDevOps.ezformat.ps1 @@ -1,52 +1,39 @@ -#requires -Module EZOut -# Install-Module EZOut or https://github.com/StartAutomating/EZOut -[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", "", Justification="This generates format files (where its ok to Write-Host)")] -param() +#requires -Module EZOut +# Install-Module EZOut or https://github.com/StartAutomating/EZOut $myFile = $MyInvocation.MyCommand.ScriptBlock.File -$myModuleName = $($myFile | Split-Path -Leaf) -replace '\.ezformat\.ps1', '' +$myModuleName = 'PSDevOps' $myRoot = $myFile | Split-Path - - +Push-Location $myRoot $formatting = @( - Import-FormatView -FilePath (Join-Path $myRoot Formatting) + # Add your own Write-FormatView here, + # or put them in a Formatting or Views directory + foreach ($potentialDirectory in 'Formatting','Views') { + Join-Path $myRoot $potentialDirectory | + Get-ChildItem -ea ignore | + Import-FormatView -FilePath {$_.Fullname} + } ) -$myFormatFile = Join-Path $myRoot "$myModuleName.format.ps1xml" -$formatting | Out-FormatData -ModuleName PSDevOps | Set-Content $myFormatFile -Encoding UTF8 +$destinationRoot = $myRoot + +if ($formatting) { + $myFormatFile = Join-Path $destinationRoot "$myModuleName.format.ps1xml" + $formatting | Out-FormatData -Module $MyModuleName | Set-Content $myFormatFile -Encoding UTF8 + Get-Item $myFormatFile +} $types = @( - <# - Write-TypeView -TypeName PSDevOps.ArtifactFeed.View -AliasProperty @{ - ViewID = 'id' - } - Write-TypeView -TypeName PSDevOps.ArtifactFeed -AliasProperty @{ - FeedID = 'fullyQualifiedId' - } -HideProperty ViewID - Write-TypeView -TypeName PSDevOps.Build.Definition -AliasProperty @{ - DefinitionID = 'ID' - } - Write-TypeView -TypeName PSDevOps.Repository -AliasProperty @{ - RepositoryID = 'ID' - } - Write-TypeView -TypeName PSDevOps.ServiceEndpoint -AliasProperty @{ - EndpointID = 'ID' - EndpointType = 'Type' - } - Write-TypeView -TypeName PSDevOps.Repository.SourceProvider -AliasProperty @{ - ProviderName = 'Name' - } - Write-TypeView -TypeName PSDevOps.Project -AliasProperty @{ - Project = 'Name' - ProjectID = 'ID' - } -ScriptProperty @{ - LastUpdated = {[DateTime]$this.LastUpdateTime} - } -DefaultDisplay Organization, Project, LastUpdateTime, Description - #> + # Add your own Write-TypeView statements here + # or declare them in the 'Types' directory Join-Path $myRoot Types | Get-Item -ea ignore | Import-TypeView -Deserialized ) -$myTypesFile = Join-Path $myRoot "$myModuleName.types.ps1xml" -$types | Out-TypeData | Set-Content $myTypesFile -Encoding UTF8 \ No newline at end of file +if ($types) { + $myTypesFile = Join-Path $destinationRoot "$myModuleName.types.ps1xml" + $types | Out-TypeData | Set-Content $myTypesFile -Encoding UTF8 + Get-Item $myTypesFile +} +Pop-Location diff --git a/PSDevOps.format.ps1xml b/PSDevOps.format.ps1xml index f9d5d4b6..c9d49e4b 100644 --- a/PSDevOps.format.ps1xml +++ b/PSDevOps.format.ps1xml @@ -1,114 +1,13 @@ - + - - - PSDevOps.AreaPath - - PSDevOps.AreaPath - - - - - - - - - - - - - Organization - - - AreaPath - - - - - - - - PSDevOps.Build.Change - - PSDevOps.Build.Change - - - - - - - - - - - - - - - - - - $_.Author.DisplayName - - - - ([DateTime]$_.TimeStamp).ToLocalTime().ToString() - - - - Message - - - - - - - - PSDevOps.Build.Change - - PSDevOps.Build.Change - - - - - - - - $_.Author.DisplayName - - - - - ([DateTime]$_.TimeStamp).ToLocalTime().ToString() - - - - Message - - - Type - - - DisplayUri - - - - - - - - PSDevOps.Build - - PSDevOps.Build - + + + ADO.Service.Health.ServiceGeographies - - $_.Definition.Name + ' ' + $_.BuildNumber + ' [' - $moduleName = 'PSDevOps' @@ -137,1319 +36,841 @@ } while ($false) -@(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Succeeded' -NoClear) -join '' +@(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' -NoClear) -join '' - - $_.Result -eq 'Succeeded' - + -not @($_.geographies.Health -ne 'Healthy') - $_.Result + "* $($_.id)" - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Succeeded' ) -join '' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' -NoClear) -join '' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' - - $_.Result -eq 'Failed' - + @($_.geographies.Health -ne 'Healthy') - $_.Result + "* $($_.id)" - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' ) -join '' - - - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' -NoClear) -join '' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' + - - $_.Status -eq 'notStarted' - + @($_.geographies.Health -ne 'Healthy') - - $_.Status - - - - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' ) -join '' + geographies + + ADO.Service.Health.Geography + + + + + + + ADO.Service.Health.Geography + + + + - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' -NoClear) -join '' + $moduleName = 'PSDevOps' + + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + } + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") + + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove + } else { + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) + } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + + +@(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' -NoClear) -join '' - - $_.Status -eq 'inProgress' - + $_.Health -eq 'Healthy' - if ($_.QueueTime -and -not $_.StartTime) { - 'Queued' - } elseif ($_.StartTime -and -not $_.FinishTime) { - 'Running' - } - - - - @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' ) -join '' - - - - if ($_.Status -eq 'inProgress') { - if ($_.QueueTime -and -not $_.StartTime) { - ' for ' + ([DateTime]::Now - $([Datetime]$_.QueueTime).ToLocalTime()).ToString().Substring(0,8) - } else { - ' for ' + ([DateTime]::Now - $([DateTime]$_.StartTime).ToLocalTime()).ToString().Substring(0,8) - } - } else { - " in " + ([DateTime]($_.FinishTime) - [DateTime]($_.StartTime)).ToString().Substring(0,8) - } - - - ] - - - - '=' * ($_.Definition.Name.Length + - $_.BuildNumber.Length + - $_.Result.Length + 4 + $( - if ($_.FinishTime) { 4 + 8 } - else { - 5 + 8 + $(if (-not $_.StartTime) { 'Queued'.Length} else { 'Running'.Length }) - }) - ) + " * $($_.Name) (Healthy)" - - - $_.Reason + ' of ' + $_.sourceBranch + ' for ' + $_.RequestedFor.DisplayName - + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' - - - '-' * ($_.Reason.Length + 4 + $_.sourceBranch.Length + 5 + $_.RequestedFor.DisplayName.Length) - + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' - - $_.ChangeSet + $_.Health -ne 'Healthy' - "### Changes:" + [Environment]::NewLine + " * $($_.Name) ($($_.Health))" - - $_.ChangeSet - - - ' * ' + (@($_.ChangeSet | Select-Object -ExpandProperty Message) -join "$([Environment]::NewLine) * ") - + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' + - - - PSDevOps.BuildStep - - PSDevOps.BuildStep - - - BuildSystem - - - - - - - - - - - - - - - Name - - - Type - - - Extension - - - - - - - - PSDevOps.ExtensionContribution - - PSDevOps.ExtensionContribution - + + + ${PSDevOps_Format-RichText} - ContributionID: - - $_.ContributionID +[Environment]::NewLine - - - $_.Name - - ' ' + $_.Name - - - - $_.Description - - [Environment]::NewLine + ' ' + $_.Description - - - - - - - - PSDevOps.Field - - PSDevOps.Field - - - - - - - - - - - - - - - - - - Name - - - Type - - - FieldName - - - Description - - - - - - - - PSDevOps - - PSDevOps - - - - - - - - - - - - - - - - - - - - - $moduleName = 'PSDevOps' + + <# + .Synopsis + Formats the text color of output + .Description + Formats the text color of output - do { - $lm = Get-Module -Name $moduleName -ErrorAction Ignore - if (-not $lm) { continue } - if ($lm.FormatPartsLoaded) { break } - $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { - foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { - $ParentNode = $partNodeName.Node.ParentNode - "$($ParentNode.Name)={ - $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + * ForegroundColor + * BackgroundColor + * Bold + * Underline + .Notes + Stylized Output works in two contexts at present: + * Rich consoles (Windows Terminal, PowerShell.exe, Pwsh.exe) (when $host.UI.SupportsVirtualTerminal) + * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) + #> + [Management.Automation.Cmdlet("Format","Object")] + [ValidateScript({ + $canUseANSI = $host.UI.SupportsVirtualTerminal + $canUseHTML = $Request -or $host.UI.SupportsHTML -or $OutputMode -eq 'HTML' + if (-not ($canUseANSI -or $canUseHTML)) { return $false} + return $true + })] + param( + # The input object + [Parameter(ValueFromPipeline)] + [PSObject] + $InputObject, + + # The foreground color + [string]$ForegroundColor, + + # The background color + [string]$BackgroundColor, + + # If set, will render as bold + [switch]$Bold, + + # If set, will render as italic. + [Alias('Italics')] + [switch]$Italic, + + # If set, will render as faint + [switch]$Faint, + + # If set, will render as hidden text. + [switch]$Hide, + + # If set, will render as blinking (not supported in all terminals or HTML) + [switch]$Blink, + + # If set, will render as strikethru + [Alias('Strikethrough', 'Crossout')] + [switch]$Strikethru, + + # If set, will underline text + [switch]$Underline, + + # If set, will double underline text. + [switch]$DoubleUnderline, + + # If set, will invert text + [switch]$Invert, + # If set, will not clear formatting + [switch]$NoClear + ) + + begin { + $canUseANSI = $host.UI.SupportsVirtualTerminal + $canUseHTML = $Request -or $host.UI.SupportsHTML -or $OutputMode -eq 'HTML' + $knownStreams = @{ + Output='';Error='BrightRed';Warning='BrightYellow'; + Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; + Success='BrightGreen';Failure='Red';Default=''} + $esc = [char]0x1b + $standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' + $brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' + + $n =0 + $cssClasses = @() + $colorAttributes = + @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { + $n++ + if (-not $hc) { continue } + if ($hc[0] -eq $esc) { + if ($canUseANSI) { + $hc; continue } - }) -join [Environment]::NewLine - New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | - Import-Module -Global - $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") - - if (-not $lm.OnRemove) { - $lm.OnRemove = $onRemove - } else { - $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) } - $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force - - } while ($false) - - - $__ = $_ - $ci = . {"Success"} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + $ansiStartPoint = if ($n -eq 1) { 30 } else { 40 } + if ($knownStreams.ContainsKey($hc)) { + $i = $brightColors.IndexOf($knownStreams[$hc]) + if ($canUseHTML) { + $cssClasses += $hc + } else { + if ($i -ge 0 -and $canUseANSI) { + '' + $esc + "[1;$($ansiStartPoint + $i)m" + } else { + $i = $standardColors.IndexOf($knownStreams[$hc]) + if ($i -ge 0 -and $canUseANSI) { + '' + $esc + "[1;$($ansiStartPoint + $i)m" + } elseif ($i -le 0 -and $canUseANSI) { + '' + $esc + "[$($ansistartpoint + 8):5m" + } + } + } + continue nextColor + } + elseif ($standardColors -contains $hc) { + for ($i = 0; $i -lt $standardColors.Count;$i++) { + if ($standardColors[$i] -eq $hc) { + if ($canUseANSI -and -not $canUseHTML) { + '' + $esc + "[$($ansiStartPoint + $i)m" + } else { + $cssClasses += $standardColors[$i] + } + continue nextColor + } + } + } elseif ($brightColors -contains $hc) { + for ($i = 0; $i -lt $brightColors.Count;$i++) { + if ($brightColors[$i] -eq $hc) { + if ($canUseANSI -and -not $canUseHTML) { + '' + $esc + "[1;$($ansiStartPoint + $i)m" + } else { + $cssClasses += $standardColors[$i] + } + continue nextColor + } + } + } + elseif ($psStyle -and $psStyle.Formatting.$hc -and + $psStyle.Formatting.$hc -match '^\e') { + if ($canUseANSI -and -not $canUseHTML) { + $psStyle.Formatting.$hc + } else { + $cssClasses += "formatting-$hc" + } + } + elseif (-not $n -and $psStyle -and $psStyle.Foreground.$hc -and + $psStyle.Foreground.$hc -match '^\e' ) { + if ($canUseANSI -and -not $canUseHTML) { + $psStyle.Foreground.$hc + } else { + $cssClasses += "foreground-$hc" + } + } + elseif ($n -and $psStyle -and $psStyle.Background.$hc -and + $psStyle.Background.$hc -match '^\e') { + if ($canUseANSI -and -not $canUseHTML) { + $psStyle.Background.$hc + } else { + $cssClasses += "background-$hc" + } } - $output = . {$_.'Name'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - ScriptType - - - Synopsis - - - - @(foreach ($kv in ([Management.Automation.CommandMetaData]$_).Parameters.GetEnumerator()) { - @( - . ${PSDevOps_setOutputStyle} -ForegroundColor Verbose - "[$($kv.Value.ParameterType)]" - . ${PSDevOps_clearOutputStyle} - . ${PSDevOps_setOutputStyle} -ForegroundColor Warning - "`$$($kv.Key)" - . ${PSDevOps_clearOutputStyle} - ) -join '' - }) -join [Environment]::NewLine - - - - - - - - - Description - - PSDevOps - - - - - left - 30 - - - left - - - - - - - - Name - - - Description - - - - - - - - PSDevOps.GitIssue - - PSDevOps.GitIssue - - - - - - - - - - - - - - - - - - - - $moduleName = 'PSDevOps' - do { - $lm = Get-Module -Name $moduleName -ErrorAction Ignore - if (-not $lm) { continue } - if ($lm.FormatPartsLoaded) { break } - $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { - foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { - $ParentNode = $partNodeName.Node.ParentNode - "$($ParentNode.Name)={ - $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + + + if ($hc -and $hc -notmatch '^[\#\e]') { + $placesToLook= + @(if ($hc.Contains('.')) { + $module, $setting = $hc -split '\.', 2 + $theModule = Get-Module $module + $theModule.PrivateData.Color, + $theModule.PrivateData.Colors, + $theModule.PrivateData.Colour, + $theModule.PrivateData.Colours, + $theModule.PrivateData.EZOut, + $global:PSColors, + $global:PSColours + } else { + $setting = $hc + $moduleColorSetting = $theModule.PrivateData.PSColors.$setting + }) + + foreach ($place in $placesToLook) { + if (-not $place) { continue } + foreach ($propName in $setting -split '\.') { + $place = $place.$propName + if (-not $place) { break } + } + if ($place -and "$place".StartsWith('#') -and 4,7 -contains "$place".Length) { + $hc = $place + continue + } + } + if (-not $hc.StartsWith -or -not $hc.StartsWith('#')) { + continue } - }) -join [Environment]::NewLine - New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | - Import-Module -Global - $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") - - if (-not $lm.OnRemove) { - $lm.OnRemove = $onRemove - } else { - $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) } - $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + $r,$g,$b = if ($hc.Length -eq 7) { + [int]::Parse($hc[1..2]-join'', 'HexNumber') + [int]::Parse($hc[3..4]-join '', 'HexNumber') + [int]::Parse($hc[5..6] -join'', 'HexNumber') + }elseif ($hc.Length -eq 4) { + [int]::Parse($hc[1], 'HexNumber') * 16 + [int]::Parse($hc[2], 'HexNumber') * 16 + [int]::Parse($hc[3], 'HexNumber') * 16 + } + + if ($canUseHTML) { + if ($n -eq 1) { "color:$hc" } + elseif ($n -eq 2) { "background-color:$hc"} + } + elseif ($canUseANSI) { + if ($n -eq 1) { $esc+"[38;2;$r;$g;${b}m" } + elseif ($n -eq 2) { $esc+"[48;2;$r;$g;${b}m" } + } + + }) + + $styleAttributes = @() + $colorAttributes + + $styleAttributes += @( + if ($Bold) { + if ($canUseHTML) {"font-weight:bold"} + elseif ($canUseANSI) { '' + $esc + "[1m" } + } + if ($Faint) { + if ($canUseHTML) { "opacity:.5" } + elseif ($canUseANSI) { '' + $esc + "[2m" } + } + if ($Italic) { + if ($canUseHTML) { "font-weight:bold" } + elseif ($canUseANSI) {'' + $esc + "[3m" } + } - } while ($false) + if ($Underline -and -not $doubleUnderline) { + if ($canUseHTML) { "text-decoration:underline"} + elseif ($canUseANSI) {'' +$esc + "[4m" } + } + + if ($Blink) { + if ($canUseANSI) { '' +$esc + "[5m" } + } + + if ($invert) { + if ($canUseHTML) {"filter:invert(100%)"} + elseif ($canUseANSI) { '' + $esc + "[7m"} + } + + if ($hide) { + if ($canUseHTML) {"opacity:0"} + elseif ($canUseANSI) { '' + $esc + "[8m"} + } + + if ($Strikethru) { + if ($canUseHTML) {"text-decoration: line-through"} + elseif ($canUseANSI) { '' +$esc + "[9m" } + } + + if ($DoubleUnderline) { + if ($canUseHTML) { "border-bottom: 3px double;"} + elseif ($canUseANSI) {'' +$esc + "[21m" } + } + ) + $header = + if ($canUseHTML) { + "<span$( + if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} + )$( + if ($cssClasses) { " class='$($cssClasses -join ' ')'"} + )>" + } elseif ($canUseANSI) { + $styleAttributes -join '' + } + } - $__ = $_ - $ci = . { - if ($_.labels.count -eq 1) { # If there's only one label - '#' + $_.labels[0].color # use that color code. + process { + if ($header) { + "$header" + "$(if ($inputObject) { $inputObject | Out-String})".Trim() + } + elseif ($inputObject) { + ($inputObject | Out-String).Trim() + } } -} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + + end { + + if (-not $NoClear) { + if ($canUseHTML) { + "</span>" + } + elseif ($canUseANSI) { + if ($Bold -or $Faint -or $colorAttributes -match '\[1;') { + "$esc[22m" } - $output = . {$_.'Number'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { - if ($_.labels.count -eq 1) { # If there's only one label - '#' + $_.labels[0].color # use that color code. - } -} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + if ($Italic) { + "$esc[23m" } - $output = . {$_.'State'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { - if ($_.labels.count -eq 1) { # If there's only one label - '#' + $_.labels[0].color # use that color code. - } -} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + if ($Underline -or $doubleUnderline) { + "$esc[24m" } - $output = . {$_.'Title'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - - - - - PSDevOps.GitRepo - - PSDevOps.GitRepo - - - OwnerName - - - - - left - 30 - - - - Center - 5 - - - - Center - 5 - - - - Center - 5 - - - Left - - - - - - - - Name - - - $_.'stargazers_count' - - - $_.'open_issues_count' - - - $_.'forks_count' - - - Description - - - - - - - - PSDevOps.InstalledExtension - - PSDevOps.InstalledExtension - - - - - - left - 20 - - - - left - 20 - - - left - 20 - - - - left - - - - - - - - - $_.PublisherName + [Environment]::NewLine + '(' + $_.PublisherID + ')' - - - - - $_.ExtensionName + [Environment]::NewLine + '(' + $_.ExtensionID + ')' - - - - Version - - - - ($_.Contributions | - Out-String -Width ($host.UI.RawUI.BufferSize.Width - 45)).Trim() - - - - - - - - - PSDevOps.IterationPath - - PSDevOps.IterationPath - - - - - - - - - - - - - - - - IterationPath - - - StartDate - - - EndDate - - - - - - - - PSDevOps.Picklist - - PSDevOps.Picklist - - - - - - - - - - - - - - - - - Name - - - Type - - - IsSuggested - - - PicklistID - - - - - - - - PSDevOps.Picklist.Detail - - PSDevOps.Picklist.Detail - - - - - - - - - - - - - - - - - - - - - Name - - - Type - - - PicklistID - - - IsSuggested - - - $_.Items -join [Environment]::NewLine - - - - - - - - ID - - PSDevOps.Picklist - PSDevOps.Picklist.Detail - - - - - - - - - - - - - Name - - - PicklistID - - - - - - - - PSDevOps.Pool - - PSDevOps.Pool - - - OwnerName - - - - - - - - - - - - - - - - - PoolID - - - Name - - - OwnerName - - - DateCreated - - - - - - - - PSDevOps.Project - - PSDevOps.Project - - - Organization - - - - - - - - - - - - - Project - - - Description - - - - - - - - PSDevOps.Repository - - PSDevOps.Repository - - - - - - - - - - - - - - - - Name - - - ID - - - Size - - - - - - - - PSDevOps.SecurityNamespace - - PSDevOps.SecurityNamespace - - - - - - - - - - - - - - - - - Name - - - NamespaceID - - - $_.Permissions -join [Environment]::NewLine - - - - - - - - PSDevOps.SharedQuery - - PSDevOps.SharedQuery - - - Project - - - - - - - - - - - - - - - - IsPublic - - - Path - - - Wiql - - - - - - - - PSDevOps.Team - - PSDevOps.Team - - - - - - - - - - - - - - - ProjectName - - - Team - - - Description - - - - - - - - ID - - PSDevOps.Team - - - - - - - - - - - - - - - - - ProjectName - - - ProjectID - - - Team - - - TeamID - - - - - - - - URL - - PSDevOps.Team - - - - - - - - - - - - - - - - ProjectName - - - Team - - - Url - - - - - - - - PSDevOps.TeamDescriptor - - PSDevOps.TeamDescriptor - - - Organization - - - - - - - - - - - - - - TeamName - - - TeamDescriptor - - - - - - - - PSDevOps.TeamFieldValue - - PSDevOps.TeamFieldValue - - - - - - - - - - - - - - - - - - $_.field.ReferenceName - - - - DefaultValue - - - - foreach ($v in $_.values) { - if ($v.IncludeChildren) { - "$($v.value)/*" - } else { - "$($v.value)" + if ($Blink) { + "$esc[25m" + } + if ($Invert) { + "$esc[27m" + } + if ($hide) { + "$esc[28m" + } + if ($Strikethru) { + "$esc[29m" + } + if ($ForegroundColor) { + "$esc[39m" + } + if ($BackgroundColor) { + "$esc[49m" + } + + if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { + '' + $esc + '[0m' } } - - - - - - - - - PSDevOps.TestPlan - - PSDevOps.TestPlan - - - - $_.Project.Name - - - - - - - - - - - - - - - - - - - - - - Name - - - TestPlanID - - - Owner - - - State - - - AreaPath - - - - - - - - PSDevOps.TestRun - - PSDevOps.TestRun - - - - - - - - - - - - - - - - - - - - - - $moduleName = 'PSDevOps' + + + + + + + + + ${PSDevOps_setOutputStyle} + + + + + + <# +.Synopsis + Adds style to a format output +.Description + Adds style information to a format output, including: - do { - $lm = Get-Module -Name $moduleName -ErrorAction Ignore - if (-not $lm) { continue } - if ($lm.FormatPartsLoaded) { break } - $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { - foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { - $ParentNode = $partNodeName.Node.ParentNode - "$($ParentNode.Name)={ - $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + * ForegroundColor + * BackgroundColor + * Bold + * Underline +.Notes + Stylized Output works in two contexts at present: + * Rich consoles (Windows Terminal, PowerShell.exe, Pwsh.exe) (when $host.UI.SupportsVirtualTerminal) + * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) + + IsFormatPart: true +#> +param( +[string]$ForegroundColor, +[string]$BackgroundColor, +[switch]$Bold, +[switch]$Underline, +[switch]$Invert +) + +$canUseANSI = $host.UI.SupportsVirtualTerminal +$canUseHTML = $Request -or $host.UI.SupportsHTML +if (-not ($canUseANSI -or $canUseHTML)) { return } + +$knownStreams = @{ + Output='';Error='BrightRed';Warning='BrightYellow'; + Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; + Success='BrightGreen';Failure='Red';Default=''} +$standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' +$brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' +$n =0 +$cssClasses = @() +$styleAttributes = + @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { + $n++ + if (-not $hc) { continue } + if ($hc[0] -eq [char]0x1b) { + if ($canUseANSI) { + $hc; continue + } + } + + $ansiStartPoint = if ($n -eq 1) { 30 } else { 40 } + if ($knownStreams.ContainsKey($hc)) { + $i = $brightColors.IndexOf($knownStreams[$hc]) + if ($canUseHTML) { + $cssClasses += $hc + } else { + if ($i -ge 0 -and $canUseANSI) { + '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" + } else { + $i = $standardColors.IndexOf($knownStreams[$hc]) + if ($i -ge 0 -and $canUseANSI) { + '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" + } elseif ($i -le 0 -and $canUseANSI) { + '' + [char]0x1b + "[$($ansistartpoint + 8):5m" } - }) -join [Environment]::NewLine - New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | - Import-Module -Global - $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") - - if (-not $lm.OnRemove) { - $lm.OnRemove = $onRemove + } + } + continue nextColor + } + elseif ($standardColors -contains $hc) { + for ($i = 0; $i -lt $standardColors.Count;$i++) { + if ($standardColors[$i] -eq $hc) { + if ($canUseANSI -and -not $canUseHTML) { + '' + [char]0x1b + "[$($ansiStartPoint + $i)m" + } else { + $cssClasses += $standardColors[$i] + } + continue nextColor + } + } + } elseif ($brightColors -contains $hc) { + for ($i = 0; $i -lt $brightColors.Count;$i++) { + if ($brightColors[$i] -eq $hc) { + if ($canUseANSI -and -not $canUseHTML) { + '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" + } else { + $cssClasses += $standardColors[$i] + } + continue nextColor + } + } + } + + + if ($hc -and -not $hc.StartsWith('#')) { + $placesToLook= + @(if ($hc.Contains('.')) { + $module, $setting = $hc -split '\.', 2 + $theModule = Get-Module $module + $theModule.PrivateData.Color, + $theModule.PrivateData.Colors, + $theModule.PrivateData.Colour, + $theModule.PrivateData.Colours, + $theModule.PrivateData.EZOut, + $global:PSColors, + $global:PSColours } else { - $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) + $setting = $hc + $moduleColorSetting = $theModule.PrivateData.PSColors.$setting + }) + + foreach ($place in $placesToLook) { + if (-not $place) { continue } + foreach ($propName in $setting -split '\.') { + $place = $place.$propName + if (-not $place) { break } } - $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force - - } while ($false) - + if ($place -and "$place".StartsWith('#') -and 4,7 -contains "$place".Length) { + $hc = $place + continue + } + } + if (-not $hc.StartsWith -or -not $hc.StartsWith('#')) { + continue + } + } + $r,$g,$b = if ($hc.Length -eq 7) { + [int]::Parse($hc[1..2]-join'', 'HexNumber') + [int]::Parse($hc[3..4]-join '', 'HexNumber') + [int]::Parse($hc[5..6] -join'', 'HexNumber') + }elseif ($hc.Length -eq 4) { + [int]::Parse($hc[1], 'HexNumber') * 16 + [int]::Parse($hc[2], 'HexNumber') * 16 + [int]::Parse($hc[3], 'HexNumber') * 16 + } + + if ($canUseHTML) { + if ($n -eq 1) { "color:$hc" } + elseif ($n -eq 2) { "background-color:$hc"} + } + elseif ($canUseANSI) { + if ($n -eq 1) { [char]0x1b+"[38;2;$r;$g;${b}m" } + elseif ($n -eq 2) { [char]0x1b+"[48;2;$r;$g;${b}m" } + } + }) - $__ = $_ - $ci = . { - if ($_.PassedTests -lt $_.TotalTests) { - if ($_.PassedTests -lt ($_.TotalTests / 2)) { - 'Red' - } else { - 'Yellow' + +if ($Bold) { + $styleAttributes += + if ($canUseHTML) { + "font-weight:bold" } - } else { - 'Green' - } -} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci - } - $output = . {$_.'Name'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { - if ($_.PassedTests -lt $_.TotalTests) { - if ($_.PassedTests -lt ($_.TotalTests / 2)) { - 'Red' - } else { - 'Yellow' + elseif ($canUseANSI) + { + [char]0x1b + "[1m" } - } else { - 'Green' - } } - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci - } - $output = . {$_.'IsAutomated'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { - if ($_.PassedTests -lt $_.TotalTests) { - if ($_.PassedTests -lt ($_.TotalTests / 2)) { - 'Red' - } else { - 'Yellow' + +if ($Underline) { + $styleAttributes += + if ($canUseHTML) { + "text-decoration:underline" + } elseif ($canUseANSI) { + [char]0x1b + "[4m" } - } else { - 'Green' - } } - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci - } - $output = . {$_.'TotalTests'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { - if ($_.PassedTests -lt $_.TotalTests) { - if ($_.PassedTests -lt ($_.TotalTests / 2)) { - 'Red' - } else { - 'Yellow' + +if ($Invert) { + $styleAttributes += + if ($canUseHTML) { + "filter:invert(100%)" + } elseif ($canUseANSI) { + [char]0x1b + "[7m" } +} + +if ($canUseHTML) { + + "<span$( + if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} + )$( + if ($cssClasses) { " class='$($cssClasses -join ' ')'"} + )>" +} elseif ($canUseANSI) { + $styleAttributes -join '' +} + + + + + + + + ${PSDevOps_clearOutputStyle} + + + + + + <# +.Synopsis + Clears the output style +.Description + Clears ANSI output style or closes the most recent span element. + + ANSI stylization can be toggled off individually (for instance, to stop applying an -Underline but leave the color unchanged) +.Notes + IsFormatPart: true +#> +param( +# If set, will explicitly clear ANSI Bold +[switch] +$Bold, +# If set, will explicitly clear ANSI Underline +[switch] +$Underline, +# If set, will explicitly clear ANSI Invert +[switch] +$Invert, +# If set, will explicitly clear ANSI Foreground Color +[switch] +$ForegroundColor, +# If set, will explicitly clear ANSI Background Color +[switch] +$BackgroundColor +) +@(if ($request -or $host.UI.SupportsHTML) { + "</span>" +} elseif ($Host.UI.SupportsVirtualTerminal) { + if ($Underline) { + [char]0x1b + "[24m" + } + if ($Bold) { + [char]0x1b + "[21m" + } + if ($Invert) { + [char]0x1b + '[27m' + } + if ($ForegroundColor) { + [char]0x1b + '[39m' + } + if ($BackgroundColor) { + [char]0x1b + '[49m' + } + + if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { + [char]0x1b + '[0m' + } + +}) -join '' + + + + + + + + ${PSDevOps_HorizontalRule} + + + + + + <# +.Synopsis + Renders a HorizontalRule +.Description + Renders a HorizontalRule. + + If $request or $host.UI.SupportsHTML, this will render a <hr/> tag. + + Otherwise, this will render a line filled with a given -Character (by default, a '-') +.Notes + IsFormatPart: true +#> +param( +# The Character used for a Horizontal Rule +[char] +$Character = '-', + +# The CSS Class used for the Horizontal Rule (If ($request -or $host.SupportsHTML)) +[string] +$Class +) +$canUseHTML = $Request -or $host.UI.SupportsHTML + +if ($canUseHTML) { + if (-not $Class) { + '<hr/>' } else { - 'Green' + "<hr class='$class' />" } + return } - $_ = $__ - if ($ci -is [string]) { - $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${PSDevOps_Format-RichText} -NoClear @ci - } - $output = . {$_.'PassedTests'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - - - + +return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + + + + + + + + - PSDevOps.TestSuite + ADO.Service.Health - PSDevOps.TestSuite + ADO.Service.Health - - TestPlanName - - - - - left - 20 - - - left - 12 - - - - left - 20 - - - left - - - - - - - - Name - - - TestSuiteID - - + + + + + + $moduleName = 'PSDevOps' + + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + } + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") + + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove + } else { + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) + } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + + +@(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' -NoClear) -join '' + + + + $_.Status.Health -eq 'Healthy' + - $_.LastUpdated.ToString('s') + "Healthy @ $(($_.LastUpdated.ToLocalTime() | Out-String).Trim())" - - - QueryString - - - - - + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' + + + + $_.Status.Health -ne 'Healthy' + + + "$($_.Status.Health) @ $(($_.LastUpdated.ToLocalTime() | Out-String).Trim())" + + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' + + + + + $_.Status.Health -ne 'Healthy' + + Services + + ADO.Service.Health.ServiceGeographies + + + + + - PSDevOps.Wiki + PSDevOps.AreaPath - PSDevOps.Wiki + PSDevOps.AreaPath @@ -1457,31 +878,15 @@ - - - - - - - - Project - - - Name - - - WikiID - - - Type + Organization - MappedPath + AreaPath @@ -1489,19 +894,17 @@ - PSDevOps.WorkItem.Comment + PSDevOps.Build.Change - PSDevOps.WorkItem.Comment + PSDevOps.Build.Change - - WorkItemID - - + + @@ -1511,42 +914,15 @@ - $_.CreatedBy.displayName - - - CreatedAt - - - Comment + $_.Author.DisplayName - - - - - - - PSDevOps.WorkItem.CommentReaction - - PSDevOps.WorkItem.CommentReaction - - - Comment - - - - - - - - - - - - Type + + ([DateTime]$_.TimeStamp).ToLocalTime().ToString() + - Count + Message @@ -1554,52 +930,50 @@ - PSDevOps.WorkItem + PSDevOps.Build.Change - PSDevOps.WorkItem + PSDevOps.Build.Change - - - - left - 8 - - - - left - 20 - - - left - - - - - - - - ID - - - if ($_.AssignedTo.DisplayName) { $_.AssignedTo.DisplayName } else { $_.AssignedTo } - - - Title - - - - - + + + + + + + $_.Author.DisplayName + + + + + ([DateTime]$_.TimeStamp).ToLocalTime().ToString() + + + + Message + + + Type + + + DisplayUri + + + + + - PSDevOps.WorkItem + PSDevOps.Build - PSDevOps.WorkItem + PSDevOps.Build + + $_.Definition.Name + ' ' + $_.BuildNumber + ' [' + $moduleName = 'PSDevOps' @@ -1628,129 +1002,142 @@ } while ($false) - -$wi = $_ -$uiBuffer = $Host.UI.RawUI.BufferSize.Width - 1 -$bufferWidth = $uiBuffer -$justify = {param($l, $r) - - $d = $host.UI.RawUI.BufferSize.Width - 1 - $l.Length - $r.Length - if ($d -lt 0) { $d = 0 } - $l + (' ' * $d) + $r - -} - -@( -. ${PSDevOps_HorizontalRule} -#('-' * $uiBuffer) -& justify "[$($wi.ID)] $($wi.'System.Title')" "$($wi.'System.State')" -. ${PSDevOps_HorizontalRule} -#('-' * $uiBuffer) -if ($wi.'System.IterationPath') { - & justify "Iteration Path:" $wi.'System.IterationPath' -} -if ($wi.'System.AssignedTo') { - & justify "Assigned To:" $(if ($wi.'System.AssignedTo'.displayName) { - $wi.'System.AssignedTo'.displayName - } else { - $wi.'System.AssignedTo' - }) -} -$changedBy = - if ($wi.'System.ChangedBy'.displayName) { - $wi.'System.ChangedBy'.displayName - } elseif ($wi.'System.ChangedBy') { - $wi.'System.ChangedBy' - } -if ($changedBy) { - & justify "Last Updated:" "$changedBy @ $($wi.'System.ChangedDate' -as [DateTime])" -} -$createdBy = - if ($wi.'System.CreatedBy'.displayName) { - $wi.'System.CreatedBy'.displayName - } elseif ($wi.'System.CreatedBy') { - $wi.'System.CreatedBy' - } -if ($createdby) { - & justify "Created:" "$createdBy @ $($wi.'System.CreatedDate' -as [DateTime])" -} -if ($wi.'System.Description') { - "Description:" - . ${PSDevOps_HorizontalRule} -Character '_' - $wi.HTMLToText("$($wi.'System.Description')") - . ${PSDevOps_HorizontalRule} -Character '_' -} - -if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { - "Repro Steps:" - . ${PSDevOps_HorizontalRule} -Character '_' - [Environment]::NewLine - $wi.HTMLToText("$($wi.'Microsoft.VSTS.TCM.ReproSteps')") - . ${PSDevOps_HorizontalRule} -Character '_' - [Environment]::NewLine -} - - - - - -) -join [Environment]::NewLine - +@(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Succeeded' -NoClear) -join '' - - - - - - - PSDevOps.WorkItemType - - PSDevOps.WorkItemType - - - - - - - - - - - - - - - - - - - Name - - + + + + $_.Result -eq 'Succeeded' + + - if ($_.Icon.id) { - $_.Icon.id + $_.Result + + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Succeeded' ) -join '' + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' -NoClear) -join '' + + + + + $_.Result -eq 'Failed' + + + + $_.Result + + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' ) -join '' + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' -NoClear) -join '' + + + + + $_.Status -eq 'notStarted' + + + + $_.Status + + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' ) -join '' + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' -NoClear) -join '' + + + + + $_.Status -eq 'inProgress' + + + + if ($_.QueueTime -and -not $_.StartTime) { + 'Queued' + } elseif ($_.StartTime -and -not $_.FinishTime) { + 'Running' + } + + + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' ) -join '' + + + + if ($_.Status -eq 'inProgress') { + if ($_.QueueTime -and -not $_.StartTime) { + ' for ' + ([DateTime]::Now - $([Datetime]$_.QueueTime).ToLocalTime()).ToString().Substring(0,8) + } else { + ' for ' + ([DateTime]::Now - $([DateTime]$_.StartTime).ToLocalTime()).ToString().Substring(0,8) + } } else { - $_.Icon - } + " in " + ([DateTime]($_.FinishTime) - [DateTime]($_.StartTime)).ToString().Substring(0,8) + } - - - Color - - - Description - - - - - + + ] + + + + '=' * ($_.Definition.Name.Length + + $_.BuildNumber.Length + + $_.Result.Length + 4 + $( + if ($_.FinishTime) { 4 + 8 } + else { + 5 + 8 + $(if (-not $_.StartTime) { 'Queued'.Length} else { 'Running'.Length }) + }) + ) + + + + + + $_.Reason + ' of ' + $_.sourceBranch + ' for ' + $_.RequestedFor.DisplayName + + + + + + '-' * ($_.Reason.Length + 4 + $_.sourceBranch.Length + 5 + $_.RequestedFor.DisplayName.Length) + + + + + + $_.ChangeSet + + + "### Changes:" + [Environment]::NewLine + + + + + $_.ChangeSet + + + ' * ' + (@($_.ChangeSet | Select-Object -ExpandProperty Message) -join "$([Environment]::NewLine) * ") + + + + + + - PSDevOps.WorkProcess.Field + PSDevOps.BuildStep - PSDevOps.WorkProcess.Field + PSDevOps.BuildStep + + BuildSystem + @@ -1759,10 +1146,6 @@ if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { - - - - @@ -1774,13 +1157,7 @@ if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { Type - Required - - - Customization - - - Description + Extension @@ -1788,9 +1165,39 @@ if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { - PSDevOps.WorkProcess + PSDevOps.ExtensionContribution - PSDevOps.WorkProcess + PSDevOps.ExtensionContribution + + + + + + ContributionID: + + $_.ContributionID +[Environment]::NewLine + + + + $_.Name + + ' ' + $_.Name + + + + $_.Description + + [Environment]::NewLine + ' ' + $_.Description + + + + + + + + PSDevOps.Field + + PSDevOps.Field @@ -1811,10 +1218,10 @@ if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { Name - IsEnabled + Type - IsDefault + FieldName Description @@ -1825,659 +1232,1493 @@ if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { - Picklist + PSDevOps - PSDevOps.WorkProcess + PSDevOps - - - - - - - - - - - - - - Name - - - IsPicklist - - - PicklistID - - - - - - - - - - ${PSDevOps_Format-RichText} - - - - - - - <# - .Synopsis - Formats the text color of output - .Description - Formats the text color of output - - * ForegroundColor - * BackgroundColor - * Bold - * Underline - .Notes - Stylized Output works in two contexts at present: - * Rich consoles (Windows Terminal, PowerShell.exe, Pwsh.exe) (when $host.UI.SupportsVirtualTerminal) - * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) - #> - [Management.Automation.Cmdlet("Format","Object")] - [ValidateScript({ - $canUseANSI = $host.UI.SupportsVirtualTerminal - $canUseHTML = $Request -or $host.UI.SupportsHTML -or $OutputMode -eq 'HTML' - if (-not ($canUseANSI -or $canUseHTML)) { return $false} - return $true - })] - param( - # The input object - [Parameter(ValueFromPipeline)] - [PSObject] - $InputObject, - # The foreground color - [string]$ForegroundColor, - # The background color - [string]$BackgroundColor, - # If set, will render as bold - [switch]$Bold, - # If set, will render as blinking (not supported in all terminals or HTML) - [switch]$Blink, - # If set, will render as strikethru - [switch]$Strikethru, - # If set, will underline text - [switch]$Underline, - # If set, will invert text - [switch]$Invert, - # If set, will not clear formatting - [switch]$NoClear - ) - - begin { - $canUseANSI = $host.UI.SupportsVirtualTerminal - $canUseHTML = $Request -or $host.UI.SupportsHTML -or $OutputMode -eq 'HTML' - $knownStreams = @{ - Output='';Error='BrightRed';Warning='BrightYellow'; - Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; - Success='BrightGreen';Failure='Red';Default=''} - $standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' - $brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' - - $n =0 - $cssClasses = @() - $styleAttributes = - @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { - $n++ - if (-not $hc) { continue } - if ($hc[0] -eq [char]0x1b) { - if ($canUseANSI) { - $hc; continue - } - } - - $ansiStartPoint = if ($n -eq 1) { 30 } else { 40 } - if ($knownStreams.ContainsKey($hc)) { - $i = $brightColors.IndexOf($knownStreams[$hc]) - if ($canUseHTML) { - $cssClasses += $hc - } else { - if ($i -ge 0 -and $canUseANSI) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" - } else { - $i = $standardColors.IndexOf($knownStreams[$hc]) - if ($i -ge 0 -and $canUseANSI) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" - } elseif ($i -le 0 -and $canUseANSI) { - '' + [char]0x1b + "[$($ansistartpoint + 8):5m" - } - } - } - continue nextColor - } - elseif ($standardColors -contains $hc) { - for ($i = 0; $i -lt $standardColors.Count;$i++) { - if ($standardColors[$i] -eq $hc) { - if ($canUseANSI -and -not $canUseHTML) { - '' + [char]0x1b + "[$($ansiStartPoint + $i)m" - } else { - $cssClasses += $standardColors[$i] - } - continue nextColor - } - } - } elseif ($brightColors -contains $hc) { - for ($i = 0; $i -lt $brightColors.Count;$i++) { - if ($brightColors[$i] -eq $hc) { - if ($canUseANSI -and -not $canUseHTML) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" - } else { - $cssClasses += $standardColors[$i] - } - continue nextColor - } - } - } - elseif ($psStyle -and $psStyle.Formatting.$hc -and - $psStyle.Formatting.$hc -match '^\e') { - if ($canUseANSI -and -not $canUseHTML) { - $psStyle.Formatting.$hc - } else { - $cssClasses += "formatting-$hc" - } - } - elseif (-not $n -and $psStyle -and $psStyle.Foreground.$hc -and - $psStyle.Foreground.$hc -match '^\e' ) { - if ($canUseANSI -and -not $canUseHTML) { - $psStyle.Foreground.$hc - } else { - $cssClasses += "foreground-$hc" - } - } - elseif ($n -and $psStyle -and $psStyle.Background.$hc -and - $psStyle.Background.$hc -match '^\e') { - if ($canUseANSI -and -not $canUseHTML) { - $psStyle.Background.$hc - } else { - $cssClasses += "background-$hc" - } - } - - - - if ($hc -and $hc -notmatch '^[\#\e]') { - $placesToLook= - @(if ($hc.Contains('.')) { - $module, $setting = $hc -split '\.', 2 - $theModule = Get-Module $module - $theModule.PrivateData.Color, - $theModule.PrivateData.Colors, - $theModule.PrivateData.Colour, - $theModule.PrivateData.Colours, - $theModule.PrivateData.EZOut, - $global:PSColors, - $global:PSColours - } else { - $setting = $hc - $moduleColorSetting = $theModule.PrivateData.PSColors.$setting - }) - - foreach ($place in $placesToLook) { - if (-not $place) { continue } - foreach ($propName in $setting -split '\.') { - $place = $place.$propName - if (-not $place) { break } - } - if ($place -and "$place".StartsWith('#') -and 4,7 -contains "$place".Length) { - $hc = $place - continue - } - } - if (-not $hc.StartsWith -or -not $hc.StartsWith('#')) { - continue + + + + + + + + + + + + + + + + + + + + $moduleName = 'PSDevOps' + + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" } - } - $r,$g,$b = if ($hc.Length -eq 7) { - [int]::Parse($hc[1..2]-join'', 'HexNumber') - [int]::Parse($hc[3..4]-join '', 'HexNumber') - [int]::Parse($hc[5..6] -join'', 'HexNumber') - }elseif ($hc.Length -eq 4) { - [int]::Parse($hc[1], 'HexNumber') * 16 - [int]::Parse($hc[2], 'HexNumber') * 16 - [int]::Parse($hc[3], 'HexNumber') * 16 - } - - if ($canUseHTML) { - if ($n -eq 1) { "color:$hc" } - elseif ($n -eq 2) { "background-color:$hc"} - } - elseif ($canUseANSI) { - if ($n -eq 1) { [char]0x1b+"[38;2;$r;$g;${b}m" } - elseif ($n -eq 2) { [char]0x1b+"[48;2;$r;$g;${b}m" } - } + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") - }) - - - if ($Bold) { - $styleAttributes += - if ($canUseHTML) { - "font-weight:bold" - } - elseif ($canUseANSI) - { - '' + [char]0x1b + "[1m" + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove + } else { + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) } - } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + - if ($Underline) { - $styleAttributes += - if ($canUseHTML) { - "text-decoration:underline" - } elseif ($canUseANSI) { - '' +[char]0x1b + "[4m" - } - } - if ($Strikethru) { - $styleAttributes += - if ($canUseHTML) { - "text-decoration: line-through" - } elseif ($canUseANSI) { - '' +[char]0x1b + "[4m" + $__ = $_ + $ci = . {"Success"} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci } - } + $output = . {$_.'Name'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + ScriptType + + + Synopsis + + + + @(foreach ($kv in ([Management.Automation.CommandMetaData]$_).Parameters.GetEnumerator()) { + @( + . ${PSDevOps_setOutputStyle} -ForegroundColor Verbose + "[$($kv.Value.ParameterType)]" + . ${PSDevOps_clearOutputStyle} + . ${PSDevOps_setOutputStyle} -ForegroundColor Warning + "`$$($kv.Key)" + . ${PSDevOps_clearOutputStyle} + ) -join '' + }) -join [Environment]::NewLine + + + + + + + + + Description + + PSDevOps + + + + + left + 30 + + + left + + + + + + + + Name + + + Description + + + + + + + + PSDevOps.GitIssue + + PSDevOps.GitIssue + + + + + + + + + + + + + + + + + + + + $moduleName = 'PSDevOps' - if ($Blink) { - $styleAttributes += - if ($canUseHTML) { - - } elseif ($canUseANSI) { - '' +[char]0x1b + "[5m" - } - } - - if ($Strikethru) { - $styleAttributes += - if ($canUseHTML) { - "text-decoration: line-through" - } elseif ($canUseANSI) { - [char]0x1b + "[9m" + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" } - } - - if ($Invert) { - $styleAttributes += - if ($canUseHTML) { - "filter:invert(100%)" - } elseif ($canUseANSI) { - [char]0x1b + "[7m" + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") + + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove + } else { + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) } - } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + - $header = - if ($canUseHTML) { - "<span$( - if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} - )$( - if ($cssClasses) { " class='$($cssClasses -join ' ')'"} - )>" - } elseif ($canUseANSI) { - $styleAttributes -join '' - } - } - process { - if ($header) { - "$header" + "$(if ($inputObject) { $inputObject | Out-String})".Trim() - } - elseif ($inputObject) { - ($inputObject | Out-String).Trim() - } + $__ = $_ + $ci = . { + if ($_.labels.count -eq 1) { # If there's only one label + '#' + $_.labels[0].color # use that color code. } - - end { - - if (-not $NoClear) { - if ($canUseHTML) { - "</span>" - } - elseif ($canUseANSI) { - if ($Underline) { - '' + [char]0x1b + "[24m" - } - if ($Strikethru) { - '' + [char]0x1b + "[29m" - } - if ($Bold) { - '' + [char]0x1b + "[21m" + '' + [char]0x1b + "[22m" - } - if ($Invert) { - '' + [char]0x1b + '[27m' - } - if ($ForegroundColor) { - '' + [char]0x1b + '[39m' - } - if ($BackgroundColor) { - '' + [char]0x1b + '[49m' +} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci } - - if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { - '' + [char]0x1b + '[0m' + $output = . {$_.'Number'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + $__ = $_ + $ci = . { + if ($_.labels.count -eq 1) { # If there's only one label + '#' + $_.labels[0].color # use that color code. + } +} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci } - } - } + $output = . {$_.'State'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + $__ = $_ + $ci = . { + if ($_.labels.count -eq 1) { # If there's only one label + '#' + $_.labels[0].color # use that color code. } - - - - - - - - - ${PSDevOps_setOutputStyle} - - - - - - <# -.Synopsis - Adds style to a format output -.Description - Adds style information to a format output, including: - - * ForegroundColor - * BackgroundColor - * Bold - * Underline -.Notes - Stylized Output works in two contexts at present: - * Rich consoles (Windows Terminal, PowerShell.exe, Pwsh.exe) (when $host.UI.SupportsVirtualTerminal) - * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) - - IsFormatPart: true -#> -param( -[string]$ForegroundColor, -[string]$BackgroundColor, -[switch]$Bold, -[switch]$Underline, -[switch]$Invert -) - -$canUseANSI = $host.UI.SupportsVirtualTerminal -$canUseHTML = $Request -or $host.UI.SupportsHTML -if (-not ($canUseANSI -or $canUseHTML)) { return } - -$knownStreams = @{ - Output='';Error='BrightRed';Warning='BrightYellow'; - Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; - Success='BrightGreen';Failure='Red';Default=''} -$standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' -$brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' -$n =0 -$cssClasses = @() -$styleAttributes = - @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { - $n++ - if (-not $hc) { continue } - if ($hc[0] -eq [char]0x1b) { - if ($canUseANSI) { - $hc; continue - } - } - - $ansiStartPoint = if ($n -eq 1) { 30 } else { 40 } - if ($knownStreams.ContainsKey($hc)) { - $i = $brightColors.IndexOf($knownStreams[$hc]) - if ($canUseHTML) { - $cssClasses += $hc - } else { - if ($i -ge 0 -and $canUseANSI) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" +} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + } + $output = . {$_.'Title'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + + + + + PSDevOps.GitRepo + + PSDevOps.GitRepo + + + OwnerName + + + + + left + 30 + + + + Center + 5 + + + + Center + 5 + + + + Center + 5 + + + Left + + + + + + + + Name + + + $_.'stargazers_count' + + + $_.'open_issues_count' + + + $_.'forks_count' + + + Description + + + + + + + + PSDevOps.InstalledExtension + + PSDevOps.InstalledExtension + + + + + + left + 20 + + + + left + 20 + + + left + 20 + + + + left + + + + + + + + + $_.PublisherName + [Environment]::NewLine + '(' + $_.PublisherID + ')' + + + + + $_.ExtensionName + [Environment]::NewLine + '(' + $_.ExtensionID + ')' + + + + Version + + + + ($_.Contributions | + Out-String -Width ($host.UI.RawUI.BufferSize.Width - 45)).Trim() + + + + + + + + + PSDevOps.IterationPath + + PSDevOps.IterationPath + + + + + + + + + + + + + + + + IterationPath + + + StartDate + + + EndDate + + + + + + + + PSDevOps.Picklist + + PSDevOps.Picklist + + + + + + + + + + + + + + + + + Name + + + Type + + + IsSuggested + + + PicklistID + + + + + + + + PSDevOps.Picklist.Detail + + PSDevOps.Picklist.Detail + + + + + + + + + + + + + + + + + + + + + Name + + + Type + + + PicklistID + + + IsSuggested + + + $_.Items -join [Environment]::NewLine + + + + + + + + ID + + PSDevOps.Picklist + PSDevOps.Picklist.Detail + + + + + + + + + + + + + Name + + + PicklistID + + + + + + + + PSDevOps.Pool + + PSDevOps.Pool + + + OwnerName + + + + + + + + + + + + + + + + + PoolID + + + Name + + + OwnerName + + + DateCreated + + + + + + + + PSDevOps.Project + + PSDevOps.Project + + + Organization + + + + + + + + + + + + + Project + + + Description + + + + + + + + PSDevOps.Repository + + PSDevOps.Repository + + + + + + + + + + + + + + + + Name + + + ID + + + Size + + + + + + + + PSDevOps.SecurityNamespace + + PSDevOps.SecurityNamespace + + + + + + + + + + + + + + + + + Name + + + NamespaceID + + + $_.Permissions -join [Environment]::NewLine + + + + + + + + PSDevOps.SharedQuery + + PSDevOps.SharedQuery + + + Project + + + + + + + + + + + + + + + + IsPublic + + + Path + + + Wiql + + + + + + + + PSDevOps.Team + + PSDevOps.Team + + + + + + + + + + + + + + + ProjectName + + + Team + + + Description + + + + + + + + ID + + PSDevOps.Team + + + + + + + + + + + + + + + + + ProjectName + + + ProjectID + + + Team + + + TeamID + + + + + + + + URL + + PSDevOps.Team + + + + + + + + + + + + + + + + ProjectName + + + Team + + + Url + + + + + + + + PSDevOps.TeamDescriptor + + PSDevOps.TeamDescriptor + + + Organization + + + + + + + + + + + + + + TeamName + + + TeamDescriptor + + + + + + + + PSDevOps.TeamFieldValue + + PSDevOps.TeamFieldValue + + + + + + + + + + + + + + + + + + $_.field.ReferenceName + + + + DefaultValue + + + + foreach ($v in $_.values) { + if ($v.IncludeChildren) { + "$($v.value)/*" } else { - $i = $standardColors.IndexOf($knownStreams[$hc]) - if ($i -ge 0 -and $canUseANSI) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" - } elseif ($i -le 0 -and $canUseANSI) { - '' + [char]0x1b + "[$($ansistartpoint + 8):5m" - } - } - } - continue nextColor - } - elseif ($standardColors -contains $hc) { - for ($i = 0; $i -lt $standardColors.Count;$i++) { - if ($standardColors[$i] -eq $hc) { - if ($canUseANSI -and -not $canUseHTML) { - '' + [char]0x1b + "[$($ansiStartPoint + $i)m" - } else { - $cssClasses += $standardColors[$i] - } - continue nextColor - } - } - } elseif ($brightColors -contains $hc) { - for ($i = 0; $i -lt $brightColors.Count;$i++) { - if ($brightColors[$i] -eq $hc) { - if ($canUseANSI -and -not $canUseHTML) { - '' + [char]0x1b + "[1;$($ansiStartPoint + $i)m" - } else { - $cssClasses += $standardColors[$i] - } - continue nextColor + "$($v.value)" } } + + + + + + + + + PSDevOps.TestPlan + + PSDevOps.TestPlan + + + + $_.Project.Name + + + + + + + + + + + + + + + + + + + + + + Name + + + TestPlanID + + + Owner + + + State + + + AreaPath + + + + + + + + PSDevOps.TestRun + + PSDevOps.TestRun + + + + + + + + + + + + + + + + + + + + + + $moduleName = 'PSDevOps' - - if ($hc -and -not $hc.StartsWith('#')) { - $placesToLook= - @(if ($hc.Contains('.')) { - $module, $setting = $hc -split '\.', 2 - $theModule = Get-Module $module - $theModule.PrivateData.Color, - $theModule.PrivateData.Colors, - $theModule.PrivateData.Colour, - $theModule.PrivateData.Colours, - $theModule.PrivateData.EZOut, - $global:PSColors, - $global:PSColours + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + } + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") + + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove } else { - $setting = $hc - $moduleColorSetting = $theModule.PrivateData.PSColors.$setting - }) - - foreach ($place in $placesToLook) { - if (-not $place) { continue } - foreach ($propName in $setting -split '\.') { - $place = $place.$propName - if (-not $place) { break } - } - if ($place -and "$place".StartsWith('#') -and 4,7 -contains "$place".Length) { - $hc = $place - continue + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) } - } - if (-not $hc.StartsWith -or -not $hc.StartsWith('#')) { - continue - } - } - $r,$g,$b = if ($hc.Length -eq 7) { - [int]::Parse($hc[1..2]-join'', 'HexNumber') - [int]::Parse($hc[3..4]-join '', 'HexNumber') - [int]::Parse($hc[5..6] -join'', 'HexNumber') - }elseif ($hc.Length -eq 4) { - [int]::Parse($hc[1], 'HexNumber') * 16 - [int]::Parse($hc[2], 'HexNumber') * 16 - [int]::Parse($hc[3], 'HexNumber') * 16 - } - - if ($canUseHTML) { - if ($n -eq 1) { "color:$hc" } - elseif ($n -eq 2) { "background-color:$hc"} - } - elseif ($canUseANSI) { - if ($n -eq 1) { [char]0x1b+"[38;2;$r;$g;${b}m" } - elseif ($n -eq 2) { [char]0x1b+"[48;2;$r;$g;${b}m" } - } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + - }) - -if ($Bold) { - $styleAttributes += - if ($canUseHTML) { - "font-weight:bold" + $__ = $_ + $ci = . { + if ($_.PassedTests -lt $_.TotalTests) { + if ($_.PassedTests -lt ($_.TotalTests / 2)) { + 'Red' + } else { + 'Yellow' } - elseif ($canUseANSI) - { - [char]0x1b + "[1m" + } else { + 'Green' + } +} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + } + $output = . {$_.'Name'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + $__ = $_ + $ci = . { + if ($_.PassedTests -lt $_.TotalTests) { + if ($_.PassedTests -lt ($_.TotalTests / 2)) { + 'Red' + } else { + 'Yellow' } + } else { + 'Green' + } } - -if ($Underline) { - $styleAttributes += - if ($canUseHTML) { - "text-decoration:underline" - } elseif ($canUseANSI) { - [char]0x1b + "[4m" + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + } + $output = . {$_.'IsAutomated'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + $__ = $_ + $ci = . { + if ($_.PassedTests -lt $_.TotalTests) { + if ($_.PassedTests -lt ($_.TotalTests / 2)) { + 'Red' + } else { + 'Yellow' } + } else { + 'Green' + } } - -if ($Invert) { - $styleAttributes += - if ($canUseHTML) { - "filter:invert(100%)" - } elseif ($canUseANSI) { - [char]0x1b + "[7m" + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + } + $output = . {$_.'TotalTests'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + $__ = $_ + $ci = . { + if ($_.PassedTests -lt $_.TotalTests) { + if ($_.PassedTests -lt ($_.TotalTests / 2)) { + 'Red' + } else { + 'Yellow' } + } else { + 'Green' + } } - -if ($canUseHTML) { - - "<span$( - if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} - )$( - if ($cssClasses) { " class='$($cssClasses -join ' ')'"} - )>" -} elseif ($canUseANSI) { - $styleAttributes -join '' -} - - - - - - - - ${PSDevOps_clearOutputStyle} + $_ = $__ + if ($ci -is [string]) { + $ci = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $ci + } else { + $ci = & ${PSDevOps_Format-RichText} -NoClear @ci + } + $output = . {$_.'PassedTests'} + @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" + + + + + + + + + PSDevOps.TestSuite + + PSDevOps.TestSuite + + + TestPlanName + + + + + left + 20 + + + left + 12 + + + + left + 20 + + + left + + + + + + + + Name + + + TestSuiteID + + + + $_.LastUpdated.ToString('s') + + + + QueryString + + + + + + + + PSDevOps.Wiki + + PSDevOps.Wiki + + + + + + + + + + + + + + + + + + + + Project + + + Name + + + WikiID + + + Type + + + MappedPath + + + + + + + + PSDevOps.WorkItem.Comment + + PSDevOps.WorkItem.Comment + + + WorkItemID + + + + + + + + + + + + + + + + + $_.CreatedBy.displayName + + + CreatedAt + + + Comment + + + + + + + + PSDevOps.WorkItem.CommentReaction + + PSDevOps.WorkItem.CommentReaction + + + Comment + + + + + + + + + + + + + Type + + + Count + + + + + + + + PSDevOps.WorkItem + + PSDevOps.WorkItem + + + + + left + 8 + + + + left + 20 + + + left + + + + + + + + ID + + + if ($_.AssignedTo.DisplayName) { $_.AssignedTo.DisplayName } else { $_.AssignedTo } + + + Title + + + + + + + + PSDevOps.WorkItem + + PSDevOps.WorkItem + - <# -.Synopsis - Clears the output style -.Description - Clears ANSI output style or closes the most recent span element. + $moduleName = 'PSDevOps' - ANSI stylization can be toggled off individually (for instance, to stop applying an -Underline but leave the color unchanged) -.Notes - IsFormatPart: true -#> -param( -# If set, will explicitly clear ANSI Bold -[switch] -$Bold, -# If set, will explicitly clear ANSI Underline -[switch] -$Underline, -# If set, will explicitly clear ANSI Invert -[switch] -$Invert, -# If set, will explicitly clear ANSI Foreground Color -[switch] -$ForegroundColor, -# If set, will explicitly clear ANSI Background Color -[switch] -$BackgroundColor -) -@(if ($request -or $host.UI.SupportsHTML) { - "</span>" -} elseif ($Host.UI.SupportsVirtualTerminal) { - if ($Underline) { - [char]0x1b + "[24m" - } - if ($Bold) { - [char]0x1b + "[21m" - } - if ($Invert) { - [char]0x1b + '[27m' - } - if ($ForegroundColor) { - [char]0x1b + '[39m' - } - if ($BackgroundColor) { - [char]0x1b + '[49m' - } + do { + $lm = Get-Module -Name $moduleName -ErrorAction Ignore + if (-not $lm) { continue } + if ($lm.FormatPartsLoaded) { break } + $wholeScript = @(foreach ($formatFilePath in $lm.exportedFormatFiles) { + foreach ($partNodeName in Select-Xml -LiteralPath $formatFilePath -XPath "/Configuration/Controls/Control/Name[starts-with(., '$')]") { + $ParentNode = $partNodeName.Node.ParentNode + "$($ParentNode.Name)={ + $($ParentNode.CustomControl.CustomEntries.CustomEntry.CustomItem.ExpressionBinding.ScriptBlock)}" + } + }) -join [Environment]::NewLine + New-Module -Name "${ModuleName}.format.ps1xml" -ScriptBlock ([ScriptBlock]::Create(($wholeScript + ';Export-ModuleMember -Variable *'))) | + Import-Module -Global + $onRemove = [ScriptBlock]::Create("Remove-Module '${ModuleName}.format.ps1xml'") + + if (-not $lm.OnRemove) { + $lm.OnRemove = $onRemove + } else { + $lm.OnRemove = [ScriptBlock]::Create($onRemove.ToString() + '' + [Environment]::NewLine + $lm.OnRemove) + } + $lm | Add-Member NoteProperty FormatPartsLoaded $true -Force + + } while ($false) + + + +$wi = $_ +$uiBuffer = $Host.UI.RawUI.BufferSize.Width - 1 +$bufferWidth = $uiBuffer +$justify = {param($l, $r) + + $d = $host.UI.RawUI.BufferSize.Width - 1 - $l.Length - $r.Length + if ($d -lt 0) { $d = 0 } + $l + (' ' * $d) + $r + +} - if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { - [char]0x1b + '[0m' +@( +. ${PSDevOps_HorizontalRule} +#('-' * $uiBuffer) +& justify "[$($wi.ID)] $($wi.'System.Title')" "$($wi.'System.State')" +. ${PSDevOps_HorizontalRule} +#('-' * $uiBuffer) +if ($wi.'System.IterationPath') { + & justify "Iteration Path:" $wi.'System.IterationPath' +} +if ($wi.'System.AssignedTo') { + & justify "Assigned To:" $(if ($wi.'System.AssignedTo'.displayName) { + $wi.'System.AssignedTo'.displayName + } else { + $wi.'System.AssignedTo' + }) +} +$changedBy = + if ($wi.'System.ChangedBy'.displayName) { + $wi.'System.ChangedBy'.displayName + } elseif ($wi.'System.ChangedBy') { + $wi.'System.ChangedBy' } - -}) -join '' - - - - - - - - ${PSDevOps_HorizontalRule} - - - - - - <# -.Synopsis - Renders a HorizontalRule -.Description - Renders a HorizontalRule. +if ($changedBy) { + & justify "Last Updated:" "$changedBy @ $($wi.'System.ChangedDate' -as [DateTime])" +} +$createdBy = + if ($wi.'System.CreatedBy'.displayName) { + $wi.'System.CreatedBy'.displayName + } elseif ($wi.'System.CreatedBy') { + $wi.'System.CreatedBy' + } +if ($createdby) { + & justify "Created:" "$createdBy @ $($wi.'System.CreatedDate' -as [DateTime])" +} +if ($wi.'System.Description') { + "Description:" + . ${PSDevOps_HorizontalRule} -Character '_' + $wi.HTMLToText("$($wi.'System.Description')") + . ${PSDevOps_HorizontalRule} -Character '_' +} - If $request or $host.UI.SupportsHTML, this will render a <hr/> tag. +if ($wi.'Microsoft.VSTS.TCM.ReproSteps') { + "Repro Steps:" + . ${PSDevOps_HorizontalRule} -Character '_' + [Environment]::NewLine + $wi.HTMLToText("$($wi.'Microsoft.VSTS.TCM.ReproSteps')") + . ${PSDevOps_HorizontalRule} -Character '_' + [Environment]::NewLine +} - Otherwise, this will render a line filled with a given -Character (by default, a '-') -.Notes - IsFormatPart: true -#> -param( -# The Character used for a Horizontal Rule -[char] -$Character = '-', -# The CSS Class used for the Horizontal Rule (If ($request -or $host.SupportsHTML)) -[string] -$Class -) -$canUseHTML = $Request -or $host.UI.SupportsHTML -if ($canUseHTML) { - if (-not $Class) { - '<hr/>' - } else { - "<hr class='$class' />" - } - return -} -return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + +) -join [Environment]::NewLine - - + + + PSDevOps.WorkItemType + + PSDevOps.WorkItemType + + + + + + + + + + + + + + + + + + + Name + + + + if ($_.Icon.id) { + $_.Icon.id + } else { + $_.Icon + } + + + + Color + + + Description + + + + + + + + PSDevOps.WorkProcess.Field + + PSDevOps.WorkProcess.Field + + + + + + + + + + + + + + + + + + + Name + + + Type + + + Required + + + Customization + + + Description + + + + + + + + PSDevOps.WorkProcess + + PSDevOps.WorkProcess + + + + + + + + + + + + + + + + + + Name + + + IsEnabled + + + IsDefault + + + Description + + + + + + + + Picklist + + PSDevOps.WorkProcess + + + + + + + + + + + + + + + Name + + + IsPicklist + + + PicklistID + + + + + + + diff --git a/PSDevOps.psd1 b/PSDevOps.psd1 index 01936d36..0924ec2b 100644 --- a/PSDevOps.psd1 +++ b/PSDevOps.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.5.8' + ModuleVersion = '0.5.9' RootModule = 'PSDevOps.psm1' Description = 'PowerShell Tools for DevOps' Guid = 'e6b56c5f-41ac-4ba4-8b88-2c063f683176' @@ -9,7 +9,25 @@ ProjectURI = 'https://github.com/StartAutomating/PSDevOps' LicenseURI = 'https://github.com/StartAutomating/PSDevOps/blob/master/LICENSE' ReleaseNotes = @' -0.5.8: +## 0.5.9: +* New-GitHubAction: Adding -OutputPath (#162) +* New-GitHubWorkflow: Adding -OutputPath (#163) +* New-ADOPipeline: Adding -OutputPath (#164) +* Updating Action (Preferring local bits and other cleanup) (#165) +* Import-BuildStep: Adding -SourceFile and -BuildStepName (Fixes #153) +* Updating ReleaseModule Step: Allowing -ReleaseAsset (Fixes #160) +* PublishPowerShellGallery : Adding -Exclude (Fixes #159). Fixing Module Version Comparison (Fixes #149) +* Connect-ADO: Adding -NoCache (Fixes #150) +* Convert-BuildStep: Fixing Github object parameter behavior (Fixes #158) +* Adding Get-ADOServiceHealth (Fixes #152) +* Adding Get-ADOAuditLog (Fixes #151) +* Adding PSDevOps.PSSVG.ps1 (Fixes #157) +* Updating Workflow (Fixes #155 Fixes #156) +* Adding GitHub/On/Issue (Fixes #154) + +--- + +## 0.5.8: * Running EZOut in Workflow (#148) * Adding support for HelpOut (#147) * Updating action (pushing changes) #144 @@ -24,9 +42,11 @@ * Get-ADOBuild: Passing along ProjectID and ProjectName * Get/Set-ADOPermission: Repov2 issue (#140) * Recategorizing Functions + --- -0.5.7: ---- + + +## 0.5.7: * Fixing issue with setting branch permissions (#136) * Get/Set-ADOPermission: Support for ServiceEndpoints (#137) * Set-ADOPermission: Exposing specialized parameter sets (#138) diff --git a/PSDevOps.psm1 b/PSDevOps.psm1 index 36ab64dd..4534fff3 100644 --- a/PSDevOps.psm1 +++ b/PSDevOps.psm1 @@ -4,6 +4,7 @@ param() #region Import Functions $functionsRoot = Join-Path $psScriptRoot Functions foreach ($file in Get-ChildItem -Path "$functionsRoot" -Filter *-*.ps1 -Recurse) { + if ($file.Name -match '\.[^\.]+\.ps1') { continue } . $file.FullName } #endregion Import Functions diff --git a/PSDevOps.types.ps1xml b/PSDevOps.types.ps1xml index 62f6c6b3..324ec937 100644 --- a/PSDevOps.types.ps1xml +++ b/PSDevOps.types.ps1xml @@ -1,5 +1,5 @@ - + PSDevOps.Agent @@ -833,6 +833,14 @@ param($params) Invoke-GitRESTApi -Uri '$($property.Value)' -UrlParameter `$psbou + + DefaultDisplay + Organization +Project +LastUpdateTime +Description + + @@ -867,6 +875,14 @@ param($params) Invoke-GitRESTApi -Uri '$($property.Value)' -UrlParameter `$psbou + + DefaultDisplay + Organization +Project +LastUpdateTime +Description + + diff --git a/README.md b/README.md index 3bf64397..3ed420f2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -PSDevOps -======== +
+ +
+ PowerShell Tools for DevOps --------------------------- +[![Gallery Downloads](https://img.shields.io/powershellgallery/dt/PSDevOps)](https://www.powershellgallery.com/packages/PSDevOps/) [![Build Status](https://dev.azure.com/StartAutomating/PSDevOps/_apis/build/status/StartAutomating.PSDevOps?branchName=master)](https://dev.azure.com/StartAutomating/PSDevOps/_build/latest?definitionId=5) +[![Build Status](https://github.com/StartAutomating/Irregular/actions/workflows/IrregularTests.yml/badge.svg)](https://github.com/StartAutomating/PSDevOps/actions/workflows/TestAndPublish.yml) --------------------------- __PSDevOps helps you automate DevOps using PowerShell.__ diff --git a/action.yml b/action.yml index 9f62403c..6963624e 100644 --- a/action.yml +++ b/action.yml @@ -26,22 +26,8 @@ inputs: required: false description: The user name associated with a git commit. branding: - icon: github + icon: activity color: blue -outputs: - - PSDevOpsScriptRuntime: - description: The time it took the .PSDevOpsScript parameter to run - value: ${{steps.PSDevOpsAction.outputs.PSDevOpsScriptRuntime}} - PSDevOpsPS1Runtime: - description: The time it took all .PSDevOps.ps1 files to run - value: ${{steps.PSDevOpsAction.outputs.PSDevOpsPS1Runtime}} - PSDevOpsPS1Files: - description: The .PSDevOps.ps1 files that were run (separated by semicolons) - value: ${{steps.PSDevOpsAction.outputs.PSDevOpsPS1Files}} - PSDevOpsPS1Count: - description: The number of .PSDevOps.ps1 files that were run - value: ${{steps.PSDevOpsAction.outputs.PSDevOpsPS1Count}} runs: using: composite steps: @@ -50,12 +36,12 @@ runs: shell: pwsh env: GitHubToken: ${{inputs.GitHubToken}} - Parameter: ${{inputs.Parameter}} UserEmail: ${{inputs.UserEmail}} - CommitMessage: ${{inputs.CommitMessage}} + SkipPSDevOpsPS1: ${{inputs.SkipPSDevOpsPS1}} + Parameter: ${{inputs.Parameter}} PSDevOpsScript: ${{inputs.PSDevOpsScript}} UserName: ${{inputs.UserName}} - SkipPSDevOpsPS1: ${{inputs.SkipPSDevOpsPS1}} + CommitMessage: ${{inputs.CommitMessage}} run: | $Parameters = @{} $Parameters.PSDevOpsScript = ${env:PSDevOpsScript} @@ -63,9 +49,9 @@ runs: $Parameters.SkipPSDevOpsPS1 = $parameters.SkipPSDevOpsPS1 -match 'true'; $Parameters.GitHubToken = ${env:GitHubToken} $Parameters.Parameter = ${env:Parameter} - $Parameters.Parameter = ConvertFrom-JSON @' - ${{parameters.$ParameterName}} - '@ + $Parameters.Parameter = ConvertFrom-JSON @" + $($Parameters.Parameter) + "@ $Parameters.CommitMessage = ${env:CommitMessage} $Parameters.UserEmail = ${env:UserEmail} $Parameters.UserName = ${env:UserName} @@ -124,43 +110,111 @@ runs: $UserName ) + #region Initial Logging + + # Output the parameters passed to this script (for debugging) "::group::Parameters" | Out-Host [PSCustomObject]$PSBoundParameters | Format-List | Out-Host "::endgroup::" | Out-Host - if ($env:GITHUB_ACTION_PATH) { - $PSDevOpsModulePath = Join-Path $env:GITHUB_ACTION_PATH 'PSDevOps.psd1' - if (Test-path $PSDevOpsModulePath) { - Import-Module $PSDevOpsModulePath -Force -PassThru | Out-String - } else { - throw "PSDevOps not found" - } - } elseif (-not (Get-Module PSDevOps)) { - throw "Action Path not found" + # Get the GitHub Event + $gitHubEvent = + if ($env:GITHUB_EVENT_PATH) { + [IO.File]::ReadAllText($env:GITHUB_EVENT_PATH) | ConvertFrom-Json + } else { $null } + + # Log the GitHub Event + @" + ::group::GitHubEvent + $($gitHubEvent | ConvertTo-Json -Depth 100) + ::endgroup:: + "@ | Out-Host + + # Check that there is a workspace (and throw if there is not) + if (-not $env:GITHUB_WORKSPACE) { throw "No GitHub workspace" } + + #endregion Initial Logging + + # Check to ensure we are on a branch + $branchName = git rev-parse --abrev-ref HEAD + # If we were not, return. + if (-not $branchName) { + "::warning::Not on a branch" | Out-Host + return + } + + #region Configure UserName and Email + if (-not $UserName) { + $UserName = + if ($env:GITHUB_TOKEN) { + Invoke-RestMethod -uri "https://api.github.com/user" -Headers @{ + Authorization = "token $env:GITHUB_TOKEN" + } | + Select-Object -First 1 -ExpandProperty name + } else { + $env:GITHUB_ACTOR + } } - "::notice title=ModuleLoaded::PSDevOps Loaded from Path - $($PSDevOpsModulePath)" | Out-Host + if (-not $UserEmail) { + $GitHubUserEmail = + if ($env:GITHUB_TOKEN) { + Invoke-RestMethod -uri "https://api.github.com/user/emails" -Headers @{ + Authorization = "token $env:GITHUB_TOKEN" + } | + Select-Object -First 1 -ExpandProperty email + } else {''} + $UserEmail = + if ($GitHubUserEmail) { + $GitHubUserEmail + } else { + "$UserName@github.com" + } + } + git config --global user.email $UserEmail + git config --global user.name $UserName + #endregion Configure UserName and Email + git pull | Out-Host - $ght = - if ($GitHubToken) { - $GitHubToken - } elseif ($env:GITHUB_TOKEN) { - $env:GITHUB_TOKEN + + #region Load Action Module + $ActionModuleName = "EZOut" + $ActionModuleFileName = "$ActionModuleName.psd1" + + # Try to find a local copy of the action's module. + # This allows the action to use the current branch's code instead of the action's implementation. + $PSD1Found = Get-ChildItem -Recurse -Filter "*.psd1" | + Where-Object Name -eq $ActionModuleFileName | + Select-Object -First 1 + + $ActionModulePath, $ActionModule = + # If there was a .PSD1 found + if ($PSD1Found) { + $PSD1Found.FullName # import from there. + Import-Module $PSD1Found.FullName -Force -PassThru + } + # Otherwise, if we have a GITHUB_ACTION_PATH + elseif ($env:GITHUB_ACTION_PATH) + { + $actionModulePath = Join-Path $env:GITHUB_ACTION_PATH $ActionModuleFileName + if (Test-path $actionModulePath) { + $actionModulePath + Import-Module $actionModulePath -Force -PassThru + } else { + throw "$actionModuleName not found" + } + } + elseif (-not (Get-Module $ActionModuleName)) { + throw "$actionModulePath could not be loaded." } - "::group::Connecting to Github" | Out-Host - $connectStart = [DateTime]::now - Connect-GitHub -PersonalAccessToken $GitHubToken -PassThru | - ForEach-Object { - $githubModule = $_ - "::notice title=Connected::Connect-GitHub finished - $($githubModule.ExportedCommands.Count) Commands Imported" | Out-Host - $githubModule.ExportedCommands.Keys -join [Environment]::Newline | Out-Host - } | - Out-Host - "::endgroup::" | Out-Host + + "::notice title=ModuleLoaded::$actionModuleName Loaded from Path - $($actionModulePath)" | Out-Host + #endregion Load Action Module + $anyFilesChanged = $false - $processScriptOutput = { process { + filter ProcessScriptOutput { $out = $_ $outItem = Get-Item -Path $out -ErrorAction SilentlyContinue $fullName, $shouldCommit = @@ -175,11 +229,32 @@ runs: git commit -m "$($out.Message)" } elseif ($out.CommitMessage) { git commit -m "$($out.CommitMessage)" + } elseif ($gitHubEvent.head_commit.message) { + git commit -m "$($gitHubEvent.head_commit.message)" } $anyFilesChanged = $true } $out - } } + } + + #endregion Declare Functions and Variables + + $ght = + if ($GitHubToken) { + $GitHubToken + } elseif ($env:GITHUB_TOKEN) { + $env:GITHUB_TOKEN + } + "::group::Connecting to Github" | Out-Host + $connectStart = [DateTime]::now + Connect-GitHub -PersonalAccessToken $GitHubToken -PassThru | + ForEach-Object { + $githubModule = $_ + "::notice title=Connected::Connect-GitHub finished - $($githubModule.ExportedCommands.Count) Commands Imported" | Out-Host + $githubModule.ExportedCommands.Keys -join [Environment]::Newline | Out-Host + } | + Out-Host + "::endgroup::" | Out-Host if (-not $UserName) { $UserName = $env:GITHUB_ACTOR } @@ -194,11 +269,11 @@ runs: $PSDevOpsScriptStart = [DateTime]::Now if ($PSDevOpsScript) { Invoke-Expression -Command $PSDevOpsScript | - . $processScriptOutput | + ProcessScriptOutput | Out-Host } $PSDevOpsScriptTook = [Datetime]::Now - $PSDevOpsScriptStart - "::set-output name=PSDevOpsScriptRuntime::$($PSDevOpsScriptTook.TotalMilliseconds)" | Out-Host + # "::set-output name=PSDevOpsScriptRuntime::$($PSDevOpsScriptTook.TotalMilliseconds)" | Out-Host $PSDevOpsPS1Start = [DateTime]::Now $PSDevOpsPS1List = @() @@ -211,15 +286,15 @@ runs: $PSDevOpsPS1Count++ "::notice title=Running::$($_.Fullname)" | Out-Host . $_.FullName | - . $processScriptOutput | + ProcessScriptOutput | Out-Host } } $PSDevOpsPS1EndStart = [DateTime]::Now $PSDevOpsPS1Took = [Datetime]::Now - $PSDevOpsPS1Start - "::set-output name=PSDevOpsPS1Count::$($PSDevOpsPS1List.Length)" | Out-Host - "::set-output name=PSDevOpsPS1Files::$($PSDevOpsPS1List -join ';')" | Out-Host - "::set-output name=PSDevOpsPS1Runtime::$($PSDevOpsPS1Took.TotalMilliseconds)" | Out-Host + # "::set-output name=PSDevOpsPS1Count::$($PSDevOpsPS1List.Length)" | Out-Host + # "::set-output name=PSDevOpsPS1Files::$($PSDevOpsPS1List -join ';')" | Out-Host + # "::set-output name=PSDevOpsPS1Runtime::$($PSDevOpsPS1Took.TotalMilliseconds)" | Out-Host if ($CommitMessage -or $anyFilesChanged) { if ($CommitMessage) { dir $env:GITHUB_WORKSPACE -Recurse | @@ -232,10 +307,7 @@ runs: git commit -m $ExecutionContext.SessionState.InvokeCommand.ExpandString($CommitMessage) } - - - - + $checkDetached = git symbolic-ref -q HEAD if (-not $LASTEXITCODE) { "::notice::Pushing Changes" | Out-Host diff --git a/docs/Add-ADOAreaPath.md b/docs/Add-ADOAreaPath.md index 503c1739..572358ed 100644 --- a/docs/Add-ADOAreaPath.md +++ b/docs/Add-ADOAreaPath.md @@ -1,4 +1,3 @@ - Add-ADOAreaPath --------------- ### Synopsis @@ -12,7 +11,13 @@ Adds an Azure DevOps AreaPath. AreaPaths are used to logically group work items --- ### Related Links * [Get-ADOAreaPath](Get-ADOAreaPath.md) + + + * [Remove-ADOAreaPath](Remove-ADOAreaPath.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +38,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -43,9 +55,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -53,9 +72,16 @@ The AreaPath. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -64,9 +90,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -76,9 +109,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -94,7 +134,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.AreaPath +* PSDevOps.AreaPath + + --- @@ -103,5 +145,3 @@ PSDevOps.AreaPath Add-ADOAreaPath [-Organization] [-Project] [-AreaPath] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-ADOAttachment.md b/docs/Add-ADOAttachment.md index 27e2a1a7..7cb0c972 100644 --- a/docs/Add-ADOAttachment.md +++ b/docs/Add-ADOAttachment.md @@ -1,4 +1,3 @@ - Add-ADOAttachment ----------------- ### Synopsis @@ -12,6 +11,9 @@ Adds an Azure DevOps Attachment --- ### Related Links * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -37,9 +39,16 @@ The attachment path. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -47,9 +56,16 @@ The Attachment name. This is used to upload information for an Azure DevOps ext -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Type** @@ -57,9 +73,16 @@ The Attachment type. This is used to upload information for an Azure DevOps ext -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ContainerFolder** @@ -67,9 +90,16 @@ The Container Folder. This is required when uploading artifacts. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ArtifactName** @@ -77,9 +107,16 @@ The Artifact Name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsSummary** @@ -87,9 +124,16 @@ If set, the upload will be treated as a summary. Summary uploads must be markdo -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsLog** @@ -97,12 +141,21 @@ If set, the upload will be treated as a log file. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -123,5 +176,3 @@ Add-ADOAttachment -Path -IsSummary [] Add-ADOAttachment -Path [-Name] [-Type] [] ``` --- - - diff --git a/docs/Add-ADODashboard.md b/docs/Add-ADODashboard.md index 0dbdc341..18dd3b6d 100644 --- a/docs/Add-ADODashboard.md +++ b/docs/Add-ADODashboard.md @@ -1,4 +1,3 @@ - Add-ADODashboard ---------------- ### Synopsis @@ -12,6 +11,9 @@ Creates Dashboards from Azure DevOps, or Creates Widgets in a Dashboard in Azure --- ### Related Links * [Get-ADODashboard](Get-ADODashboard.md) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +36,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -44,9 +53,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -54,9 +70,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -64,9 +87,16 @@ The name of the dashboard or widget. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -74,9 +104,16 @@ A description of the dashboard -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Widget** @@ -84,9 +121,16 @@ Widgets created with the dashboard. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DashboardID** @@ -94,9 +138,16 @@ The DashboardID. This dashboard will contain the new widgets. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ContributionID** @@ -104,9 +155,16 @@ The ContributionID. This describes the exact extension contribution the widget -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Row** @@ -114,9 +172,16 @@ The row of the widget. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Column** @@ -124,9 +189,16 @@ The column of the widget. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RowSpan** @@ -134,9 +206,16 @@ The number of rows the widget should occupy. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColumnSpan** @@ -144,9 +223,16 @@ The number of columns the widget should occupy. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Setting** @@ -154,9 +240,16 @@ The widget settings. Settings are specific to each widget. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -165,9 +258,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -177,9 +277,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -195,10 +302,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Dashboard +* PSDevOps.Dashboard + + +* PSDevOps.Widget -PSDevOps.Widget --- @@ -210,5 +319,3 @@ Add-ADODashboard -Organization -Project [-Team ] -Name Add-ADODashboard -Organization -Project [-Team ] -Name -DashboardID -ContributionID [-Row ] [-Column ] [-RowSpan ] [-ColumnSpan ] [-Setting ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-ADOIterationPath.md b/docs/Add-ADOIterationPath.md index c15f592e..f22a914c 100644 --- a/docs/Add-ADOIterationPath.md +++ b/docs/Add-ADOIterationPath.md @@ -1,4 +1,3 @@ - Add-ADOIterationPath -------------------- ### Synopsis @@ -12,7 +11,13 @@ Adds an Azure DevOps IterationPath. IterationPaths are used to logically group --- ### Related Links * [Get-ADOIterationPath](Get-ADOIterationPath.md) + + + * [Remove-ADOIterationPath](Remove-ADOIterationPath.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +38,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -43,9 +55,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -53,9 +72,16 @@ The IterationPath. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **StartDate** @@ -63,9 +89,16 @@ The start date of the iteration. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[DateTime]```|false |4 |true (ByPropertyName)| +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndDate** @@ -73,9 +106,16 @@ The end date of the iteration. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[DateTime]```|false |5 |true (ByPropertyName)| +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -84,9 +124,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -96,9 +143,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -114,7 +168,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.IterationPath +* PSDevOps.IterationPath + + --- @@ -123,5 +179,3 @@ PSDevOps.IterationPath Add-ADOIterationPath [-Organization] [-Project] [-IterationPath] [[-StartDate] ] [[-EndDate] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-ADOPicklist.md b/docs/Add-ADOPicklist.md index 68e66fe2..6d5bf962 100644 --- a/docs/Add-ADOPicklist.md +++ b/docs/Add-ADOPicklist.md @@ -1,4 +1,3 @@ - Add-ADOPicklist --------------- ### Synopsis @@ -12,7 +11,13 @@ Creates Picklists in Azure DevOps. --- ### Related Links * [Get-ADOPicklist](Get-ADOPicklist.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/create](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/create) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistName** @@ -38,9 +50,16 @@ The name of the picklist -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DateType** @@ -53,9 +72,19 @@ Valid Values: * Double * Integer * String -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IsSuggested** @@ -63,9 +92,16 @@ If set, will make the items in the picklist "suggested", and allow user input. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Item** @@ -74,9 +110,16 @@ If a PicklistID is provided, or -PicklistName already exists, will add these ite -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistID** @@ -84,9 +127,16 @@ The PicklistID of an existing picklist. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -95,9 +145,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -107,9 +164,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -125,7 +189,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Picklist.Detail +* PSDevOps.Picklist.Detail + + --- @@ -137,5 +203,3 @@ Add-ADOPicklist -Organization -PicklistName [-DateType [-DateType ] [-IsSuggested] -Item -PicklistID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-ADOTeam.md b/docs/Add-ADOTeam.md index 381dd718..65ce1b8e 100644 --- a/docs/Add-ADOTeam.md +++ b/docs/Add-ADOTeam.md @@ -1,4 +1,3 @@ - Add-ADOTeam ----------- ### Synopsis @@ -12,7 +11,13 @@ Gets teams from Azure DevOps or TFS --- ### Related Links * [Get-ADOTeam](Get-ADOTeam.md) + + + * [Get-ADOProject](Get-ADOProject.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The project name or identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -48,9 +67,16 @@ The Team Name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -58,9 +84,16 @@ The Team Description. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UserDescriptor** @@ -68,9 +101,16 @@ The Security Descriptor of the User. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TeamDescriptor** @@ -78,9 +118,16 @@ The Security Descriptor of the Team. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -89,9 +136,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -101,9 +155,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -119,7 +180,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Team +* PSDevOps.Team + + --- @@ -131,5 +194,3 @@ Add-ADOTeam -Organization -Project -Team [-Descriptio Add-ADOTeam -Organization -UserDescriptor -TeamDescriptor [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-ADOWiki.md b/docs/Add-ADOWiki.md index 1447cab3..8a3f92ce 100644 --- a/docs/Add-ADOWiki.md +++ b/docs/Add-ADOWiki.md @@ -1,4 +1,3 @@ - Add-ADOWiki ----------- ### Synopsis @@ -12,7 +11,13 @@ Creates Wikis in Azure DevOps. --- ### Related Links * [Get-ADOWiki](Get-ADOWiki.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/create](https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/create) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +39,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -44,9 +56,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -54,9 +73,16 @@ The name of the wiki. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -64,9 +90,16 @@ The ID of the repository used for the wiki. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WikiType** @@ -79,9 +112,19 @@ Valid Values: * ProjectWiki * CodeWiki -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RootPath** @@ -89,9 +132,16 @@ The root path of the wiki within the repository. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -100,9 +150,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |7 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -112,9 +169,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |8 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -130,7 +194,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Wiki +* PSDevOps.Wiki + + --- @@ -139,5 +205,3 @@ PSDevOps.Wiki Add-ADOWiki [-Organization] [-Project] [-Name] [[-RepositoryID] ] [[-WikiType] ] [[-RootPath] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Add-Git.md b/docs/Add-Git.md index ef78c297..a2eecc6c 100644 --- a/docs/Add-Git.md +++ b/docs/Add-Git.md @@ -1,4 +1,3 @@ - Add-Git ------- ### Synopsis @@ -24,9 +23,16 @@ The path to add to git. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DryRun** @@ -35,9 +41,16 @@ be ignored. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -45,9 +58,16 @@ Allow adding otherwise ignored files. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Interactive** @@ -58,9 +78,16 @@ mode for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Patch** @@ -75,9 +102,16 @@ See 'Interactive mode' for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Edit** @@ -93,9 +127,16 @@ apply to the index. See EDITING PATCHES below. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IntentToAdd** @@ -107,9 +148,16 @@ such files with git diff and committing them with git commit -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Refresh** @@ -118,9 +166,16 @@ information in the index. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IgnoreErrors** @@ -132,9 +187,16 @@ true to make this the default behaviour. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IgnoreMissing** @@ -145,9 +207,16 @@ tree or not. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Renormalize** @@ -159,9 +228,16 @@ This option implies -u. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -181,5 +257,3 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co Add-Git [-Path ] [-DryRun] [-Force] [-Interactive] [-Patch] [-Edit] [-IntentToAdd] [-Refresh] [-IgnoreErrors] [-IgnoreMissing] [-Renormalize] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Assets/PSDevOps.svg b/docs/Assets/PSDevOps.svg new file mode 100644 index 00000000..53a58792 --- /dev/null +++ b/docs/Assets/PSDevOps.svg @@ -0,0 +1,14 @@ + + + + + + + + + PSDevOps + + ∞ + + + \ No newline at end of file diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 100644 index 00000000..354a7fe6 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1,447 @@ +## 0.5.9: +* New-GitHubAction: Adding -OutputPath (#162) +* New-GitHubWorkflow: Adding -OutputPath (#163) +* New-ADOPipeline: Adding -OutputPath (#164) +* Updating Action (Preferring local bits and other cleanup) (#165) +* Import-BuildStep: Adding -SourceFile and -BuildStepName (Fixes #153) +* Updating ReleaseModule Step: Allowing -ReleaseAsset (Fixes #160) +* PublishPowerShellGallery : Adding -Exclude (Fixes #159). Fixing Module Version Comparison (Fixes #149) +* Connect-ADO: Adding -NoCache (Fixes #150) +* Convert-BuildStep: Fixing Github object parameter behavior (Fixes #158) +* Adding Get-ADOServiceHealth (Fixes #152) +* Adding Get-ADOAuditLog (Fixes #151) +* Adding PSDevOps.PSSVG.ps1 (Fixes #157) +* Updating Workflow (Fixes #155 Fixes #156) +* Adding GitHub/On/Issue (Fixes #154) + +--- + +## 0.5.8: +* Running EZOut in Workflow (#148) +* Adding support for HelpOut (#147) +* Updating action (pushing changes) #144 +* Updating GitHub Workflow steps/jobs - adding support for HelpOut and EZOut +* Initial Version of PSDevOps Action (#144) +* Adding Remove-ADOPermission (#143) +* Set-ADOPermission: Fixing help typo +* Adding FlushRequestQueue Part +* Fixing Refactoring Related Import Issue +* Adding Initial Extensions (related to -ADOTest commands) +* Add-ADOTest: Initial Commit +* Get-ADOBuild: Passing along ProjectID and ProjectName +* Get/Set-ADOPermission: Repov2 issue (#140) +* Recategorizing Functions + +--- + +## 0.5.7: + +* Fixing issue with setting branch permissions (#136) +* Get/Set-ADOPermission: Support for ServiceEndpoints (#137) +* Set-ADOPermission: Exposing specialized parameter sets (#138) +* PSDevOps.WorkProcess objects now return .ProcessName and .ProcessID as alias properties + +--- + +## 0.5.6: +### Azure DevOps Improvements +* Get-ADOPermission : Can now get permissions related to Dashboards, Analytics, AreaPaths, and IterationPaths +* Set-ADOPermission : Now can easily set permissions based off of a variety of pipeline inputs (Fixes #128 and #91) +* Get-ADOAreaPath : Removing "Area" from paths passed in, formatting returns with 'AreaPath' instead of 'Path' +* Get-ADOIterationPath : Removing "Iteration" from paths passed in, formatting returns with 'IterationPath' instead of 'Path' +* Get-ADOBuild : Extended Type Definitions now contain an alias property of BuildPath +### GitHub Workflow Improvements +* Adding "On" files for issue creation, deletion, or modification (Fixes #132) +* Adding "On" files for common scheduling needs (Fixes #134) +* ReleaseNameFormat can not be customized in ReleaseModule step (Fixes #130) + +--- + +## 0.5.5.1: +* Allowing for [Reflection.AssemblyMetaData] attributes on step .ps1 files (to customize YAML). Issue #123 +* Better support for Object and array parameters in Azure DevOps. Issue #125. + +--- + +## 0.5.5: +* Azure DevOps: Adding support for Shared Queries (Fixes #117) + * Get-ADOWorkItem -SharedQuery can get shared queries + * New-ADOWorkItem -WIQL will create shared queries. -FolderName will create folders. + * Remove-ADOWorkItem -QueryID can remove a shared query by ID +* GitHub Workflows: + * Adding Job/Step definitions to Release Module + * Adding -NoCoverage to RunPester Step + * Creating Example workflow that publishes PSDevOps. + +--- + +## 0.5.4.2: +* Adding Register-ADOArtifactFeed (Fixes #118) + +--- + +## 0.5.4.1: +* Fixing Invoke-ADORestApi issues: #111,#114,#115 +* Attaching .BuildID and .DefinitionID properties to Get-ADOBuild where appropriate. + +--- + +## 0.5.4: +* Formatting Improvments: + * Get-ADOField now includes .Type + * Get-ADOExtension now includes .Version +* Set-ADOTeam -DefaultAreaPath/-AreaPath parameter set issue fixed (fixes #103 / #92) + * Added tests for Set-ADOTeam +* GitHub Workflow Definition Improvements: + * New Triggers: + * On PullToMain + * New Jobs: + * UpdateModuleTag + * PublishToGallery + * New Steps: + * PublishPowerShellGallery + * TagModuleVersion +* New-GitHubWorkflow/New-ADOPipeline now support -RootDirectory +* Fixing pluralization / list issue with multiple GitHub Workflow "On" + +--- + +## 0.5.3 +* Get-ADORepository : Adding -PullRequestID +* New/Set-ADOWorkItem: Fixing pipelining issue + +--- + +## 0.5.2 +* Get-ADOTeam: Adding alias -AreaPath for -TeamFieldValue, carrying on team property +* Set-ADOTeam: Support for -DefaultAreaPath/-AreaPath (TeamFieldValues api, fixing issue #92) +* Get-ADOTest: Enabling pagination and filtering of results. + * Invoke-ADORestAPI: Fixing -Cache(ing) correctly (#88) + * Invoke-GitHubRESTAPI: Only using .ContentEncoding if present in results (PowerShell core fix) +* Get-ADOWorkItem: + * Fixing -Related (#79) + * Fixing -Comment errors when there are no commments (#80) +* New/Set-ADOWorkItem: + * Adding -Relationship and -Comment (#81) + * Improving Formatting of Work Items (#82) + * Adding -Tag +* Invoke-ADORestAPI: Fixing issue with -QueryParameter + +--- + +## 0.5.1 +* Bugfixes: + * Get-ADOTest: Fixing parameter sets and adding formatting. + * Invoke-GitHubRESTAPI: Only using .ContentEncoding when present. + +--- + +## 0.5 +* Improved Git Functionality + * New-GitHubAction + * Invoke-GitHubRESTApi + * Connect/Disconnect-GitHub (enabling smart aliases like api.github.com/zen and api.github.com/repos//) + * Formatting for GitHub Issues and Repos +* Azure DevOps Additions/Fixes + * Invoke-ADORestAPI -AsJob + * Get-ADOArtifactFeed now has -Metric, -PackageList, -PackageVersionList, -Provenance + * Get-ADOIdentity [new] + * Get-ADOProject now has -Board, -TestVariable, -TestConfiguration + * Get-ADOPermission is now more API-complete and has parameter sets for permission types + * Set-ADOPermission + * Get-ADOExtension can now read extension data + * Set-ADOExtension can now set extension data + * Get-ADOTest [new] + * New-ADOPipeline now has -RootDirectory + * Tons of New Type Definitions and Formatters + +--- + +## 0.4.9 +* New Command: Wait-ADOBuild +* Start-ADOBuild + * Supports -Debug (to start a build with extra tracing) + * Allows parameters as PSObject +* Get-ADORepository: Added -IncludeHidden, -IncludeRemoteURL, -IncludeLink +* Improvements to Pipelines and Workflows: + * Pester, PSScriptAnalyzer, and ScriptCop now produce output variables + * PSDevOps now includes a file to generate it's own build + * PublishTest/CodeCoverage Results steps will always() run + * Convert-BuildStep will add a .Name to each script step. + +--- + +## 0.4.8 +* Improved Tracing + * New Commands: Write-ADOOutput, Trace-ADOCommand/GitHubCommand + * Renaming Command / Adding Parameters: Set-ADOVariable -> Write-ADOVariable. Added -IsOutput & -IsReadOnly. + * Adding Trace-GitHubCommand/ADOCommand + * Improved logging of parameters in Convert-BuildStep +* New Functionality in Azure DevOps: + * Get-ADOProject now has -TestRun, -TestPlan, -Release, and -PendingApproval (and better progress bars) + * Get-ADOWorkItemType now has -Field + * Commands for Picklists: Add/Get/Remove/Update-ADOPicklist + +--- + +## 0.4.7 +* New Commands: + * Add/Get/Remove-ADOWiki + * Get-ADOPermission +* Bugfixes: + * Honoring Get-ADOBuild -DefinitionName +* Disconnect-ADO is now run prior at the start of Connect-ADO, and on module unload. + +--- + +## 0.4.6 +* New-ADOPipeline/New-GitHubWorkflow: Adding -BuildScript +* Connect-ADO: Auto-detecting connected user's teams and adding tab completion for -Project/-ProjectID/-Team/-TeamID +* Convert-BuildStep: Re-ordering YAML for GitHub Workflows (putting .runs last) +* Convert-ADOPipeline: Not returning .inputs when there are no .inputs +* Get-ADOProject: Adding -PolicyType and -PolicyConfiguration +* Get-ADORepository: Adding -PullRequest, -SourceReference, -TargetReference, -ReviewerIdentity, -CreatorIdentity. +* Get-ADOBuild: Adding -DefinitionName +* Invoke-ADORestAPI: Passing content length of 0 when body is empty. +* Updating README + +--- + +## 0.4.5 +* New Commands: + * Connect/Disconnect-ADO: Caching connection info and saving default parameters! + * New-ADOBuild : Create build definitions! + * Remove-ADOAgentPool : Cleaning up pools, queues, and agents. +* Core Improvements + * Invoke-ADORestApi + * Now supports -ContinuationToken (and auto-continues unless passed a $first or $top query parameter) + * Caches access tokens. + * BREAKING: Invoke-ADORestApi No longer has -Proxy* parameters. +* Updated Commands: + * Get-ADOUser/Get-ADOTeam : Additional Graph scenarios added. + * New/Set-ADOWorkItem : Added -BypassRule, -ValidateOnly, -SkipNotification + +--- + +## 0.4.4 +* Get-ADOTask: Adding -YAMLSchema. +* Get-ADOTeam: Adding -Setting/-FieldValue/-Iteration/-Board. +* Get-ADOAreaPath/ADOIterationPath: Making parameter names match cmdlet. Honoring -AreaPath/-IterationPath. +* Get-ADOProject: Adding -ProcessConfiguration, -Plan, -PlanID, and -DeliveryTimeline. +* New Command: Set-ADOTeam + +--- + +## 0.4.3 +* Renaming commands: + * New-ADODashboard -> Add-ADODashboard + * New-ADOTeam -> Add-ADOTeam +* Add-ADOTeam can now add members to a team +* Get-ADOTeam can now get an -Identity +* New Command: Get-ADOUser +* Get-ADOAgentPool: Fixed pipelining bug, added -AgentName/-IncludeCapability/-IncludeLastCompletedRequest/-IncludeAssignedRequest. +* Set-ADOProject: Can now -EnableFeature and -DisableFeature + +--- + +## 0.4.2 +* Build Step Improvements: + * New-ADOPipeline now has -PowerShellCore and -WindowsPowerShell + * Import-BuildStep now has parameter sets + * New-ADOPipeline/New-GitHubWorkflow now refer to a metadata collection based off of their noun. + * BuildStep directories can be aliased: + * ADOPipeline directories can be: ADOPipeline, ADO, AzDo, and AzureDevOps. + * GitHubWorkflow directories can be: GitHubWorkflow, GitHubWorkflows, and GitHub. +* New Dashboard Commands: Clear/Update-ADODashboard +* New Extension Commands: Enable/Disbale-ADOExtension +* Improved formatting/types for Extensions. +* Breaking change: Install/Uninstall-ADOExtension now accept -PublisherID and -ExtensionID, not -PublisherName and -ExtensionName. + +--- + +## 0.4.1 +* More GitHub Functionality: + * Write-GitHubDebug + * Write-GitHubOutput + * Hide-GitHubOutput +* New-GitHubWorkflow allows for more complex event mapping. +* Azure DevOps Pipeline Changes + * Convert-BuildStep once again converts using ${{parameters}} syntax +* New/Improved Azure DevOps Cmdlets + * Get/New/Remove-ADODashboard + * Get-ADOAgentPool now supports -PoolID + * Set-ADOProject + * Repositories returned from a build definition are now decorated as PSDevOps.Repository +* Improved testing and static analysis compliance + +--- + +## 0.4 +* Overhaul of GitHub Workflow functionality. + * New-GitHubAction renamed to New-GitHubWorkflow + * /GitHubActions renamed to /GitHub + * Added -EventParameter to allow for parameters from events such as workflow_dispatch + * Added Write-GitHubError/GitHubWarning (updating Write-ADOError/Write-ADOWarning for consistency) + * Cleaning up GitHub Workflow parts +* Get-ADOTask no longer has -ApiVersion parameter + +--- + +## 0.3.9 +* New/Get/Remove-ADOWorkItemType: Create/get/remove work custom work item types, states, rules, and behaviors. +* Added Get-ADOBuild -IncludeAllProperty/-IncludeLatestBuild. +* ScriptCop Integration: PowerShelllStaticAnalysis stage now runs ScriptCop as well. +* Improved ScriptAnalyzer Integration: Rule name is now outputted. + +--- + +## 0.3.8 +* Add/Remove-ADOAreaPath +* Formatter for AreaPaths + +--- + +## 0.3.7 +* Convert-ADOPipeline now has -Passthru and -Wherefore +* Get-ADOWorkProcess now has -Behavior and -WorkItemType +* Get-ADOWorkItem now has -Mine, -CurrentIteration, -Comment, -Update, -Revision. + +--- + +## 0.3.6.1 +* Convert-ADOPipeline now binds to .Variables property +* Fixing bug in PSDevOps.WorkItem types file, which displayed in formatting. + +--- + +## 0.3.6 +* Added: Get-ADOTask, Convert-ADOPipeline + +--- + +## 0.3.5 +* New Command: Get-ADOTeam +* Get-ADOBuild -CodeCoverage +* Progress bars on Get-ADORepository +* Slight refactoring to make progress bars easier in any function + +--- + +## 0.3.4.1 +* Removing supplied parameters in commands generated by Import-ADOProxy. + +--- + +## 0.3.4 +* New capability: Import-ADOProxy (Import a proxy module with for your ADO / TFS instance) +* New REST Commands: Get-ADOAreaPath, Get-ADOIterationPath, Get-ADOExtension +* More Features: Get-ADORepository -FileList +* Massive Internal Refactoring (switching to dynamic parameters for -PersonalAccessToken etc, standardizing pstypenames) + +--- + +## 0.3.3 +* Now Caching Personal Access Tokens! +* URLEncoding all segments in Parts/ReplaceRouteParameter. +* Ensuring all Azure DevOps YAML Parameters are wrapped in a string. + +--- + +## 0.3.2 +* Pester workarounds - Steps/InstallPester and Steps/RunPester now accept a PesterMaxVersion (defaulting to 4.99.99) +* Convert-BuildStep handles blank parameter defaults correctly +* Get-ADOBuild can get yaml definitions directly, e.g Get-ADOBuild -DefinitionID 123 -DefinitionYaml + +--- + +## 0.3.1 +* Bugfixes and Improvements to Convert/Import/Expand-BuildStep: +1. Enforcing pluralization of certain fields within Azure DevOps +2. Handling [string[]], [int[]], [float[]], or [ScriptBlock] parameters +* Allowing lists of primitives to not be indented in YAML. +## 0.3.0 +* Added Convert/Import/Expand-BuildStep +* Allowing build steps to be defined in functions +* Automagically importing build step parameters + +--- + +## 0.2.9 +* Get/New/Remove-ADORepository +* Get/New/Remove-ADOServiceEndpoint +* Get-ADOAgentPool + * Improvements to New-ADOPipeline to avoid unexpected singletons + +--- + +## 0.2.8 +* Get/New/Update-ADOBuild +* Improving New-ADOPipeline: + * Unknown -InputObject properties will no longer be pluralized + * Added 'Pool' to list of known singletons + +--- + +## 0.2.7 +* New Cmdlet: Set-ADOArtifactFeed +* Improvements to New/Get/Remove-ADOArtifactFeed (better pipelining, renaming -FullyQualifiedID to -FeedID) + +--- + +## 0.2.6 +* New Cmdlets: + * New/Get/Remove-ADOArtifactFeed + * New/Remove-ADOProject + * New-GitHubAction + +--- + +## 0.2.5 +* Improving Get-ADOWorkItem: + * -Title allows getting work items by title + * -NoDetail allows for queries to only return IDs + * Passing -Field will skip formatting + * WorkItemsBatch will be used for query results. + * Passing an old -ApiVersion will not use workItemsBatch + * Formatting improved +* Adding Get-ADOWorkProcess +* Fixing issues with -ADOField commands when not provided a -Project + +--- + +## 0.2.4 +* Adding Adding -CanSortBy, -IsQueryable, and -ReadOnly to New-ADOField. +* Adding parameter help to New-ADOField + +--- + +## 0.2.3 +* Adding New/Remove-ADOField +* Adding help to Get-ADOField +* Adding formatting for fields + +--- + +## 0.2.2 +* Adding New/Set/Remove-ADOWorkItem +* Adding Get-ADOField +* New Parameter: Get-ADOWorkItem -WorkItemType +* New Parameter: New-ADOPipeline -Option +* Initial formatting +* Switching Parts to use latest VMImage + +--- + +## 0.2.1 +* Added Get-ADOWorkItem + +--- + +## 0.2 +* Added Invoke-ADORestAPI + +--- + +## 0.1 +Initial Commit +--- diff --git a/docs/Clear-ADODashboard.md b/docs/Clear-ADODashboard.md index 5e57bce4..d82550b0 100644 --- a/docs/Clear-ADODashboard.md +++ b/docs/Clear-ADODashboard.md @@ -1,4 +1,3 @@ - Clear-ADODashboard ------------------ ### Synopsis @@ -12,7 +11,13 @@ Clears Azure DevOps Dashboards, and Clears settings of Widgets on a dashboard. --- ### Related Links * [Get-ADODashboard](Get-ADODashboard.md) + + + * [Remove-ADODashboard](Remove-ADODashboard.md) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +35,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -40,9 +52,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -50,9 +69,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DashboardID** @@ -60,9 +86,16 @@ The DashboardID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WidgetID** @@ -70,9 +103,16 @@ The WidgetID. If provided, will get details about a given Azure DevOps Widget. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -81,9 +121,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -93,9 +140,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -111,10 +165,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Dashboard +* PSDevOps.Dashboard + + +* PSDevOps.Widget -PSDevOps.Widget --- @@ -126,5 +182,3 @@ Clear-ADODashboard -Organization -Project [-Team ] -Da Clear-ADODashboard -Organization -Project [-Team ] -DashboardID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Connect-ADO.md b/docs/Connect-ADO.md index 4882f3a8..8dcee624 100644 --- a/docs/Connect-ADO.md +++ b/docs/Connect-ADO.md @@ -1,4 +1,3 @@ - Connect-ADO ----------- ### Synopsis @@ -16,6 +15,9 @@ PersonalAccessTokens will be cached separately to improve security. --- ### Related Links * [Disconnect-ADO](Disconnect-ADO.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ When connecting to TFS, this is the Project Collection. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PersonalAccessToken** @@ -42,9 +51,16 @@ The Personal Access Token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UseDefaultCredentials** @@ -52,9 +68,16 @@ If set, will use default credentials when connecting. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Credential** @@ -62,9 +85,16 @@ The credential used to connect. -|Type |Requried|Postion|PipelineInput | -|--------------------|--------|-------|---------------------| -|```[PSCredential]```|false |3 |true (ByPropertyName)| +> **Type**: ```[PSCredential]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -72,19 +102,44 @@ The Server. If this points to a TFS server, it should be the root TFS url, i.e. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **NoCache** + +If set, will not cache teams and projects in order to create argument completers. +If you are using a restricted Personal Access Token, this may prevent errors. + + + +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Connection +* PSDevOps.Connection + + --- ### Syntax ```PowerShell -Connect-ADO [-Organization] [[-PersonalAccessToken] ] [-UseDefaultCredentials] [[-Credential] ] [[-Server] ] [] +Connect-ADO [-Organization] [[-PersonalAccessToken] ] [-UseDefaultCredentials] [[-Credential] ] [[-Server] ] [-NoCache] [] ``` --- - - diff --git a/docs/Connect-GitHub.md b/docs/Connect-GitHub.md index 4086b67c..4cab2477 100644 --- a/docs/Connect-GitHub.md +++ b/docs/Connect-GitHub.md @@ -1,4 +1,3 @@ - Connect-GitHub -------------- ### Synopsis @@ -12,6 +11,9 @@ Connects to GitHub, automatically creating smart aliases for all GitHub URLs. --- ### Related Links * [Invoke-GitHubRESTAPI](Invoke-GitHubRESTAPI.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ A URL that contains the GitHub OpenAPI definition -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -37,9 +46,16 @@ If set, will output the dynamically imported module. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Force** @@ -47,9 +63,16 @@ If set, will force a reload of the module. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PersonalAccessToken** @@ -57,9 +80,16 @@ The personal access token used to connect to GitHub. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Owner** @@ -67,9 +97,16 @@ If provided, will default the [owner] in GitHub API requests -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |3 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **UserName** @@ -77,9 +114,16 @@ If provided, will default the [username] in GitHub API requests -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |4 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Repo** @@ -87,14 +131,19 @@ If provided, will default the [repo] in GitHub API requests -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- ### Syntax ```PowerShell Connect-GitHub [[-GitHubOpenAPIUrl] ] [-PassThru] [-Force] [[-PersonalAccessToken] ] [[-Owner] ] [[-UserName] ] [[-Repo] ] [] ``` --- - - diff --git a/docs/Convert-ADOPipeline.md b/docs/Convert-ADOPipeline.md index 313708d7..3bf46cbd 100644 --- a/docs/Convert-ADOPipeline.md +++ b/docs/Convert-ADOPipeline.md @@ -1,4 +1,3 @@ - Convert-ADOPipeline ------------------- ### Synopsis @@ -12,7 +11,13 @@ Converts builds TFS or "Classic" builds to Azure DevOps YAML Pipelines. --- ### Related Links * [New-ADOPipeline](New-ADOPipeline.md) + + + * [Get-ADOTask](Get-ADOTask.md) + + + --- ### Examples #### EXAMPLE 1 @@ -31,9 +36,16 @@ This will be automatically populated when piping in a TFS Build definition. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|true |1 |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildVariable** @@ -42,9 +54,16 @@ This will be automatically populated when piping in a TFS build definition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |2 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TaskList** @@ -52,9 +71,16 @@ A list of task definitions. This will normally be the output from Get-ADOTask. -|Type |Requried|Postion|PipelineInput| -|------------------|--------|-------|-------------| -|```[PSObject[]]```|true |3 |false | +> **Type**: ```[PSObject[]]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **WhereFore** @@ -62,9 +88,16 @@ A dictionary of conditional transformations. -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |4 |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Passthru** @@ -73,15 +106,24 @@ If not set, will output the pipeline YAML. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -90,5 +132,3 @@ System.Management.Automation.PSObject Convert-ADOPipeline [-BuildStep] [[-BuildVariable] ] [-TaskList] [[-WhereFore] ] [-Passthru] [] ``` --- - - diff --git a/docs/Convert-BuildStep.md b/docs/Convert-BuildStep.md index 399f0728..212b0ed9 100644 --- a/docs/Convert-BuildStep.md +++ b/docs/Convert-BuildStep.md @@ -1,4 +1,3 @@ - Convert-BuildStep ----------------- ### Synopsis @@ -12,7 +11,13 @@ Converts Build Steps defined in a PowerShell script into build steps in a build --- ### Related Links * [Import-BuildStep](Import-BuildStep.md) + + + * [Expand-BuildStep](Expand-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The name of the build step -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScriptBlock** @@ -38,9 +50,16 @@ The Script Block that will be converted into a build step -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|------------------------------| -|```[ScriptBlock]```|false |named |true (ByValue, ByPropertyName)| +> **Type**: ```[ScriptBlock]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByValue, ByPropertyName) + + + --- #### **Module** @@ -48,9 +67,16 @@ The module that -ScriptBlock is declared in. If piping in a command, this will -|Type |Requried|Postion|PipelineInput | -|--------------------|--------|-------|---------------------| -|```[PSModuleInfo]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSModuleInfo]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Path** @@ -58,9 +84,16 @@ The path to the file -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Extension** @@ -68,9 +101,16 @@ The extension of the file -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **InputParameter** @@ -79,9 +119,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VariableParameter** @@ -90,9 +137,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EnvironmentParameter** @@ -101,9 +155,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueParameter** @@ -113,9 +174,16 @@ The build parameter would be foo_bar. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeParameter** @@ -123,9 +191,16 @@ The name of parameters that should be excluded. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultParameter** @@ -133,9 +208,16 @@ Default parameters for a build step -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildSystem** @@ -149,9 +231,19 @@ Valid Values: * ADOExtension * GitHubWorkflow * GitHubAction -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildOption** @@ -159,12 +251,21 @@ Options for the build system. The can contain any additional parameters passed -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[PSObject]```|false |named |false | +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Collections.IDictionary +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) + + --- @@ -176,5 +277,3 @@ Convert-BuildStep -Name [-ScriptBlock ] [-Module -Path -Extension [-InputParameter ] [-VariableParameter ] [-EnvironmentParameter ] [-UniqueParameter ] [-ExcludeParameter ] [-DefaultParameter ] [-BuildSystem ] [-BuildOption ] [] ``` --- - - diff --git a/docs/Disable-ADOExtension.md b/docs/Disable-ADOExtension.md index a3c85b03..0da72268 100644 --- a/docs/Disable-ADOExtension.md +++ b/docs/Disable-ADOExtension.md @@ -1,4 +1,3 @@ - Disable-ADOExtension -------------------- ### Synopsis @@ -12,7 +11,13 @@ Disables one or more Azure DevOps Extensions. --- ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) + + + * [Enable-ADOExtension](Enable-ADOExtension.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -38,9 +50,16 @@ The Publisher of an Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -48,9 +67,16 @@ The name of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,7 +129,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.InstalledExtension +* PSDevOps.InstalledExtension + + --- @@ -98,5 +140,3 @@ PSDevOps.InstalledExtension Disable-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Disconnect-ADO.md b/docs/Disconnect-ADO.md index 7e7e7bc3..2a206600 100644 --- a/docs/Disconnect-ADO.md +++ b/docs/Disconnect-ADO.md @@ -1,4 +1,3 @@ - Disconnect-ADO -------------- ### Synopsis @@ -12,6 +11,9 @@ Disconnects from Azure DevOps, clearing parameter value defaults and cached acce --- ### Related Links * [Connect-ADO](Connect-ADO.md) + + + --- ### Examples #### EXAMPLE 1 @@ -35,10 +37,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -47,5 +51,3 @@ System.Management.Automation.PSObject Disconnect-ADO [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Disconnect-GitHub.md b/docs/Disconnect-GitHub.md index 0eab1c7d..ae73f7aa 100644 --- a/docs/Disconnect-GitHub.md +++ b/docs/Disconnect-GitHub.md @@ -1,4 +1,3 @@ - Disconnect-GitHub ----------------- ### Synopsis @@ -14,6 +13,9 @@ This unloads any dynamically imported commands and clears the cached PersonalAcc --- ### Related Links * [Connect-GitHub](Connect-GitHub.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,5 +29,3 @@ Disconnect-GitHub Disconnect-GitHub [] ``` --- - - diff --git a/docs/Enable-ADOExtension.md b/docs/Enable-ADOExtension.md index 05b9ac96..2277086d 100644 --- a/docs/Enable-ADOExtension.md +++ b/docs/Enable-ADOExtension.md @@ -1,4 +1,3 @@ - Enable-ADOExtension ------------------- ### Synopsis @@ -12,7 +11,13 @@ Enables one or more Azure DevOps Extensions. --- ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) + + + * [Disable-ADOExtension](Disable-ADOExtension.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -38,9 +50,16 @@ The Publisher of an Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -48,9 +67,16 @@ The name of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,7 +129,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.InstalledExtension +* PSDevOps.InstalledExtension + + --- @@ -98,5 +140,3 @@ PSDevOps.InstalledExtension Enable-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Expand-BuildStep.md b/docs/Expand-BuildStep.md index 1c245247..382ace74 100644 --- a/docs/Expand-BuildStep.md +++ b/docs/Expand-BuildStep.md @@ -1,4 +1,3 @@ - Expand-BuildStep ---------------- ### Synopsis @@ -12,7 +11,13 @@ Component Files are .ps1 or datafiles within a directory that tells you what typ --- ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) + + + * [Import-BuildStep](Import-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +35,16 @@ Each value may contain the name of another Step or StepMap -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|true |1 |false | +> **Type**: ```[IDictionary]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **Parent** @@ -40,9 +52,16 @@ The immediate parent object -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[PSObject]```|false |2 |false | +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Root** @@ -50,9 +69,16 @@ The absolute root object -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[PSObject]```|false |3 |false | +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **Singleton** @@ -60,9 +86,16 @@ If set, the component will be expanded as a singleton (single object) -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **SingleItemName** @@ -70,9 +103,16 @@ A list of item names that automatically become singletons -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |4 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **PluralItemName** @@ -80,9 +120,16 @@ A list of item names that automatically become plurals -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |5 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **DictionaryItemName** @@ -90,9 +137,16 @@ A list of item names that automatically become dictionaries. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |6 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **BuildSystem** @@ -106,9 +160,19 @@ Valid Values: * ADOExtension * GitHubWorkflow * GitHubAction -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **VariableParameter** @@ -117,9 +181,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **InputParameter** @@ -128,9 +199,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |9 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EnvironmentParameter** @@ -139,9 +217,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |10 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueParameter** @@ -151,9 +236,16 @@ The build parameter would be foo_bar. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |11 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeParameter** @@ -161,9 +253,16 @@ The name of parameters that should be excluded. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |12 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultParameter** @@ -171,9 +270,16 @@ A collection of default parameters. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |13 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 13 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildOption** @@ -181,12 +287,21 @@ Options for the build system. The can contain any additional parameters passed -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[PSObject]```|false |14 |false | +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 14 + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- @@ -195,5 +310,3 @@ System.Management.Automation.PSObject Expand-BuildStep [-StepMap] [[-Parent] ] [[-Root] ] [-Singleton] [[-SingleItemName] ] [[-PluralItemName] ] [[-DictionaryItemName] ] [[-BuildSystem] ] [[-VariableParameter] ] [[-InputParameter] ] [[-EnvironmentParameter] ] [[-UniqueParameter] ] [[-ExcludeParameter] ] [[-DefaultParameter] ] [[-BuildOption] ] [] ``` --- - - diff --git a/docs/Get-ADOAgentPool.md b/docs/Get-ADOAgentPool.md index 00cb9a56..7b78987e 100644 --- a/docs/Get-ADOAgentPool.md +++ b/docs/Get-ADOAgentPool.md @@ -1,4 +1,3 @@ - Get-ADOAgentPool ---------------- ### Synopsis @@ -18,8 +17,17 @@ and just providing the organization will return all of the common pools. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list) + + + --- ### Examples #### EXAMPLE 1 @@ -35,9 +43,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PoolID** @@ -45,9 +60,16 @@ The Pool ID. When this is provided, will return agents associated with a given -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AgentName** @@ -55,9 +77,16 @@ If provided, will return agents of a given name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeCapability** @@ -65,9 +94,16 @@ If set, will return the capabilities of each returned agent. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeLastCompletedRequest** @@ -75,9 +111,16 @@ If set, will return the last completed request of each returned agent. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeAssignedRequest** @@ -85,9 +128,16 @@ If set, will return the requests queued for an agent. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -95,9 +145,16 @@ The project name or identifier. When this is provided, will return queues assoc -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -106,9 +163,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -118,12 +182,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevops.Pool +* PSDevops.Pool + + --- @@ -138,5 +211,3 @@ Get-ADOAgentPool -Organization -Project [-Server ] [-ApiV Get-ADOAgentPool -Organization [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOAreaPath.md b/docs/Get-ADOAreaPath.md index cdb3efc7..93ff6358 100644 --- a/docs/Get-ADOAreaPath.md +++ b/docs/Get-ADOAreaPath.md @@ -1,4 +1,3 @@ - Get-ADOAreaPath --------------- ### Synopsis @@ -12,8 +11,17 @@ Get area paths from Azure DevOps --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/Classification%20Nodes/Get%20Classification%20Nodes?view=azure-devops-rest-5.1#get-the-root-area-tree](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/Classification%20Nodes/Get%20Classification%20Nodes?view=azure-devops-rest-5.1#get-the-root-area-tree) + + + * [Add-ADOAreaPath](Add-ADOAreaPath.md) + + + * [Remove-ADOAreaPath](Remove-ADOAreaPath.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -39,9 +54,16 @@ The project name or identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -49,9 +71,16 @@ The AreaPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -60,9 +89,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -72,9 +108,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **Depth** @@ -82,12 +125,21 @@ The depth of items to get. By default, one. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |6 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.AreaPath +* PSDevOps.AreaPath + + --- @@ -96,5 +148,3 @@ PSDevOps.AreaPath Get-ADOAreaPath [-Organization] [-Project] [[-AreaPath] ] [[-Server] ] [[-ApiVersion] ] [[-Depth] ] [] ``` --- - - diff --git a/docs/Get-ADOArtifactFeed.md b/docs/Get-ADOArtifactFeed.md index 3ff2ebdb..618d09bc 100644 --- a/docs/Get-ADOArtifactFeed.md +++ b/docs/Get-ADOArtifactFeed.md @@ -1,4 +1,3 @@ - Get-ADOArtifactFeed ------------------- ### Synopsis @@ -12,6 +11,9 @@ Gets artifact feeds from Azure DevOps. Artifact feeds can be used to publish pa --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/get%20feeds?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/get%20feeds?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -37,9 +46,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedID** @@ -47,9 +63,16 @@ The name or ID of the feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **View** @@ -57,9 +80,16 @@ If set, will Get Artifact Feed Views -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Permission** @@ -67,9 +97,16 @@ If set, will get artifact permissions -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RetentionPolicy** @@ -77,9 +114,16 @@ If set, will get artifact retention policies -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PackageVersionList** @@ -87,9 +131,16 @@ If set, will list versions of a particular package. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Provenance** @@ -97,9 +148,16 @@ If set, will get provenance for a package version -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VersionID** @@ -107,9 +165,16 @@ A package version ID. Only required when getting version provenance. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PackageList** @@ -117,9 +182,16 @@ If set, will list packages within a feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeAllVersion** @@ -127,9 +199,16 @@ If set, will include all versions of packages within a feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeDescription** @@ -137,9 +216,16 @@ If set, will include descriptions of a package. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProtocolType** @@ -147,9 +233,16 @@ If provided, will return packages of a given protocol. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NPM** @@ -157,9 +250,16 @@ If set, will get information about a Node Package Manager module. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NuGet** @@ -167,9 +267,16 @@ If set, will get information about a Nuget module. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Python** @@ -177,9 +284,16 @@ If set, will get information about a Python module. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Universal** @@ -187,9 +301,16 @@ If set, will get information about a Universal package module. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PackageName** @@ -197,9 +318,16 @@ The Package Name. Must be used with -NPM, -NuGet, -Python, or -Universal. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PackageVersion** @@ -207,9 +335,16 @@ The Package Version. Must be used with -NPM, -NuGet, -Python, or -Universal. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedRole** @@ -223,9 +358,19 @@ Valid Values: * Collaborator * Contributor * Reader -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PackageID** @@ -233,9 +378,16 @@ A -PackageID. This can be used to get Packages -Metrics, -ListPackageVersion, o -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Metric** @@ -243,9 +395,16 @@ If set, will get package metrics. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeDeleted** @@ -253,9 +412,16 @@ If set, will include deleted feeds. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Change** @@ -263,9 +429,16 @@ If set, will get changes in artifact feeds. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -273,9 +446,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput| -|-----------|--------|-------|-------------| -|```[Uri]```|false |named |false | +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ApiVersion** @@ -283,18 +463,27 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.ArtfiactFeed +* PSDevOps.ArtfiactFeed + + +* PSDevOps.ArtfiactFeed.View -PSDevOps.ArtfiactFeed.View +* PSDevOps.ArtfiactFeed.Change -PSDevOps.ArtfiactFeed.Change --- @@ -339,5 +528,3 @@ Get-ADOArtifactFeed -Organization [-Project ] [-FeedID Get-ADOArtifactFeed -Organization [-Project ] [-FeedID ] -PackageID -Metric [-IncludeDeleted] [-Change] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOAuditLog.md b/docs/Get-ADOAuditLog.md new file mode 100644 index 00000000..4c9d4be1 --- /dev/null +++ b/docs/Get-ADOAuditLog.md @@ -0,0 +1,115 @@ +Get-ADOAuditLog +--------------- +### Synopsis +Gets the Azure DevOps Audit Log + +--- +### Description + +Gets the Azure DevOps Audit Log for a Given Organization + +--- +### Related Links +* [https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/audit-log/query](https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/audit-log/query) + + + +--- +### Examples +#### EXAMPLE 1 +```PowerShell +Get-ADOAuditLog +``` + +--- +### Parameters +#### **Organization** + +The Organization + + + +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **BatchSize** + +The size of the batch of audit log entries. + + + +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **StartTime** + +The start time. + + + +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **EndTime** + +The end time. + + + +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **ApiVersion** + +The api-version. By default, 7.1-preview.1 + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +### Syntax +```PowerShell +Get-ADOAuditLog -Organization [-BatchSize ] [-StartTime ] [-EndTime ] [-ApiVersion ] [] +``` +--- diff --git a/docs/Get-ADOBuild.md b/docs/Get-ADOBuild.md index 291279fe..d8ad2ab9 100644 --- a/docs/Get-ADOBuild.md +++ b/docs/Get-ADOBuild.md @@ -1,4 +1,3 @@ - Get-ADOBuild ------------ ### Synopsis @@ -34,13 +33,37 @@ Given a -Definition ID, we can get associated information: --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20logs?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20logs?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/timeline/get?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/timeline/get?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20build%20properties?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20build%20properties?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/get?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/get?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20definition%20properties?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20definition%20properties?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/metrics/get%20definition%20metrics?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/metrics/get%20definition%20metrics?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -61,9 +84,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -71,9 +101,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -81,9 +118,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -91,9 +135,16 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildID** @@ -101,9 +152,16 @@ Build ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detail** @@ -111,9 +169,16 @@ If set -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildMetadata** @@ -121,9 +186,16 @@ If set, returns system metadata about the -BuildID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Artifact** @@ -131,9 +203,16 @@ If set, will get artifacts from -BuildID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Log** @@ -141,9 +220,16 @@ If set, will get a list of logs associated with -BuildID -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **LogID** @@ -151,9 +237,16 @@ If provided, will retreive the specific log content of -BuildID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ChangeSet** @@ -161,9 +254,16 @@ If set, will return the changeset associated with the build -BuildID. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Report** @@ -171,9 +271,16 @@ If set, will return the build report associated with -BuildID. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Timeline** @@ -181,9 +288,16 @@ If set, will return the timeline for build -BuildID -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **CodeCoverage** @@ -191,9 +305,16 @@ If set, will return the code coverage associated with -BuildID -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Definition** @@ -201,9 +322,16 @@ If set, will get build definitions. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DefinitionID** @@ -211,9 +339,16 @@ If set, will get a specific build by definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Status** @@ -221,9 +356,16 @@ If set, will get the status of a defined build. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DefinitionMetadata** @@ -231,9 +373,16 @@ If set, will get definition properties -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Revision** @@ -241,9 +390,16 @@ If set, will get revisions to a build definition. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Resource** @@ -251,9 +407,16 @@ If set, will get authorized resources for a build definition. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Metric** @@ -261,9 +424,16 @@ If set, will get metrics about a build definition. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **First** @@ -271,9 +441,16 @@ If provided, will get the first N builds or build definitions -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[UInt32]```|false |named |false | +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BranchName** @@ -281,9 +458,16 @@ If provided, will only return builds for a given branch. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Tag** @@ -291,9 +475,16 @@ If provided, will only return builds one of these tags. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **After** @@ -301,9 +492,16 @@ If provided, will only return builds queued after this point in time. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[DateTime]```|false |named |false | +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Before** @@ -311,9 +509,16 @@ If provided, will only return builds queued before this point in time. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[DateTime]```|false |named |false | +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildResult** @@ -328,9 +533,19 @@ Valid Values: * None * Succeeded * PartiallySucceeded -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DefinitionName** @@ -338,9 +553,16 @@ Will only return build definitions with the specified name. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuiltAfter** @@ -348,9 +570,16 @@ If provided, will only return build definitions that have been built after this -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[DateTime]```|false |named |false | +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **NotBuiltSince** @@ -358,9 +587,16 @@ If provided, will only return build definitions that have not been built since t -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[DateTime]```|false |named |false | +> **Type**: ```[DateTime]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeAllProperty** @@ -368,9 +604,16 @@ If set, will return extended properities of a build definition. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeLatestBuild** @@ -378,9 +621,16 @@ If set, will include the latest build and latest completed build in a given buil -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DefinitionYAML** @@ -388,30 +638,39 @@ If provided, will return build definition YAML. No other information will be re -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Build +* PSDevOps.Build + +* PSDevOps.Build.Definition -PSDevOps.Build.Definition +* PSDevOps.Build.Timeline -PSDevOps.Build.Timeline +* PSDevOps.Build.Change -PSDevOps.Build.Change +* PSDevOps.Build.Report -PSDevOps.Build.Report +* PSDevOps.Build.Artifact -PSDevOps.Build.Artifact + +* PSDevOps.Build.CodeCoverage -PSDevOps.Build.CodeCoverage --- @@ -468,5 +727,3 @@ Get-ADOBuild -Organization -Project [-Server ] [-ApiVersi Get-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -DefinitionID [-DefinitionYAML] [] ``` --- - - diff --git a/docs/Get-ADODashboard.md b/docs/Get-ADODashboard.md index 091e34b1..9f69f8d3 100644 --- a/docs/Get-ADODashboard.md +++ b/docs/Get-ADODashboard.md @@ -1,4 +1,3 @@ - Get-ADODashboard ---------------- ### Synopsis @@ -12,6 +11,9 @@ Gets Azure DevOps Team Dashboards and Widgets within a dashboard. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/dashboard/dashboards/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/dashboard/dashboards/list) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +30,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +47,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -48,9 +64,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DashboardID** @@ -58,9 +81,16 @@ The DashboardID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Widget** @@ -68,9 +98,16 @@ If set, will widgets within a dashboard. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WidgetID** @@ -78,9 +115,16 @@ The WidgetID. If provided, will get details about a given Azure DevOps Widget. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -89,9 +133,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -101,15 +152,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Dashboard +* PSDevOps.Dashboard + + +* PSDevOps.Widget -PSDevOps.Widget --- @@ -127,5 +187,3 @@ Get-ADODashboard -Organization -Project [-Team ] -Dash Get-ADODashboard -Organization -Project [-Team ] -DashboardID [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOExtension.md b/docs/Get-ADOExtension.md index 89f479b6..f2eedf73 100644 --- a/docs/Get-ADOExtension.md +++ b/docs/Get-ADOExtension.md @@ -1,4 +1,3 @@ - Get-ADOExtension ---------------- ### Synopsis @@ -12,8 +11,17 @@ Gets Extensions to Azure DevOps. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed%20extensions/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed%20extensions/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed%20extensions/get?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/extensionmanagement/installed%20extensions/get?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/azure/devops/extend/develop/data-storage?view=azure-devops#how-settings-are-stored](https://docs.microsoft.com/en-us/azure/devops/extend/develop/data-storage?view=azure-devops#how-settings-are-stored) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionNameLike** @@ -39,9 +54,16 @@ A wildcard of the extension name. Only extensions where the Extension Name or I -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ExtensionNameMatch** @@ -49,9 +71,16 @@ A regular expression of the extension name. Only extensions where the Extension -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PublisherNameLike** @@ -59,9 +88,16 @@ A wildcard of the publisher name. Only extensions where the Publisher Name or I -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PublisherNameMatch** @@ -69,9 +105,16 @@ A regular expression of the publisher name. Only extensions where the Publisher -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PublisherID** @@ -79,9 +122,16 @@ The Publisher of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -89,9 +139,16 @@ The Extension Identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DataCollection** @@ -99,9 +156,16 @@ The data collection -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DataID** @@ -109,9 +173,16 @@ The data identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScopeType** @@ -124,9 +195,19 @@ Valid Values: * Default * Project * User -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScopeModifier** @@ -138,9 +219,19 @@ Valid Values: * Current * Me -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AssetType** @@ -148,9 +239,16 @@ A list of asset types -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeDisabled** @@ -158,9 +256,16 @@ If set, will include disabled extensions -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **InstallationIssue** @@ -168,9 +273,16 @@ If set, will include extension installation issues -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeError** @@ -178,9 +290,16 @@ If set, will include errors -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Contribution** @@ -188,9 +307,16 @@ If set, will expand contributions. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -199,9 +325,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -211,12 +344,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.InstalledExtension +* PSDevOps.InstalledExtension + + --- @@ -234,5 +376,3 @@ Get-ADOExtension -Organization [-ExtensionNameLike ] [-Extensio Get-ADOExtension -Organization -PublisherID -ExtensionID -DataCollection [-DataID ] [-ScopeType ] [-ScopeModifier ] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOField.md b/docs/Get-ADOField.md index 5a6051ab..d79aacd2 100644 --- a/docs/Get-ADOField.md +++ b/docs/Get-ADOField.md @@ -1,4 +1,3 @@ - Get-ADOField ------------ ### Synopsis @@ -12,8 +11,17 @@ Gets fields from Azure DevOps or Team Foundation Server. --- ### Related Links * [New-ADOField](New-ADOField.md) + + + * [Remove-ADOField](Remove-ADOField.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/fields/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/fields/list) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -39,9 +54,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FieldName** @@ -49,9 +71,16 @@ The name of the field. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -59,9 +88,16 @@ The processs identifier. This is used to get field information related to a par -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WorkItemTypeName** @@ -69,9 +105,16 @@ The name of the work item type. This is used to get field information related t -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -80,9 +123,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -90,9 +140,16 @@ If set, will force a refresh of the cached results. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ApiVersion** @@ -102,12 +159,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Field +* PSDevOps.Field + + --- @@ -119,5 +185,3 @@ Get-ADOField -Organization [-Project ] [-FieldName ] [- Get-ADOField -Organization [-Project ] [-FieldName ] -ProcessID -WorkItemTypeName [-Server ] [-Force] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOIdentity.md b/docs/Get-ADOIdentity.md index 3c5d0255..a6268791 100644 --- a/docs/Get-ADOIdentity.md +++ b/docs/Get-ADOIdentity.md @@ -1,4 +1,3 @@ - Get-ADOIdentity --------------- ### Synopsis @@ -12,8 +11,17 @@ Gets Identities from Azure Devops. Identities can be either users or groups. --- ### Related Links * [Get-ADOUser](Get-ADOUser.md) + + + * [Get-ADOTeam](Get-ADOTeam.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/ims/identities/read%20identities](https://docs.microsoft.com/en-us/rest/api/azure/devops/ims/identities/read%20identities) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AceDictionary** @@ -39,9 +54,16 @@ A dictionary of Access Control Entries -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |2 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Descriptors** @@ -49,9 +71,16 @@ A list of descriptors -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DescriptorBatchSize** @@ -59,9 +88,16 @@ The maximum number of specific descriptors to request in one batch. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |4 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Membership** @@ -69,9 +105,16 @@ If set, will get membership information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Recurse** @@ -79,9 +122,16 @@ If set, will recursively expand any group memberships discovered. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Filter** @@ -89,9 +139,16 @@ The filter used for a query -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **SearchType** @@ -106,9 +163,19 @@ Valid Values: * MailAddress * General * LocalGroupName -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |6 |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **ApiVersion** @@ -117,15 +184,24 @@ This API does not exist in TFS. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Team +* PSDevOps.Team + + +* PSDevOps.TeamMember -PSDevOps.TeamMember --- @@ -134,5 +210,3 @@ PSDevOps.TeamMember Get-ADOIdentity [-Organization] [[-AceDictionary] ] [[-Descriptors] ] [[-DescriptorBatchSize] ] [-Membership] [-Recurse] [[-Filter] ] [[-SearchType] ] [[-ApiVersion] ] [] ``` --- - - diff --git a/docs/Get-ADOIterationPath.md b/docs/Get-ADOIterationPath.md index ba0c5117..f18683a9 100644 --- a/docs/Get-ADOIterationPath.md +++ b/docs/Get-ADOIterationPath.md @@ -1,4 +1,3 @@ - Get-ADOIterationPath -------------------- ### Synopsis @@ -12,7 +11,13 @@ Get iteration paths from Azure DevOps --- ### Related Links * [Get-ADOAreaPath](Get-ADOAreaPath.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/Classification%20Nodes/Get%20Classification%20Nodes?view=azure-devops-rest-5.1#get-the-root-area-tree](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/Classification%20Nodes/Get%20Classification%20Nodes?view=azure-devops-rest-5.1#get-the-root-area-tree) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The project name or identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -48,9 +67,16 @@ The IterationPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **Depth** @@ -81,12 +121,21 @@ The depth of items to get. By default, one. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |6 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.IterationPath +* PSDevOps.IterationPath + + --- @@ -95,5 +144,3 @@ PSDevOps.IterationPath Get-ADOIterationPath [-Organization] [-Project] [[-IterationPath] ] [[-Server] ] [[-ApiVersion] ] [[-Depth] ] [] ``` --- - - diff --git a/docs/Get-ADOPermission.md b/docs/Get-ADOPermission.md index 5e305c7c..917b0459 100644 --- a/docs/Get-ADOPermission.md +++ b/docs/Get-ADOPermission.md @@ -1,4 +1,3 @@ - Get-ADOPermission ----------------- ### Synopsis @@ -12,8 +11,17 @@ Gets Azure DevOps security permissions. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20lists/query](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20lists/query) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/security/security%20namespaces/query](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/security%20namespaces/query) + + + * [https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference](https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference) + + + --- ### Examples #### EXAMPLE 1 @@ -36,9 +44,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PermissionType** @@ -46,9 +61,16 @@ If set, will list the type of permisssions. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **NamespaceID** @@ -58,9 +80,16 @@ https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-r -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SecurityToken** @@ -68,9 +97,16 @@ The Security Token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -79,9 +115,16 @@ If this is provided without anything else, will get permissions for the projectI -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TeamID** @@ -89,9 +132,16 @@ If provided, will get permissions related to a given teamID. ( see Get-ADOTeam) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -99,9 +149,16 @@ If provided, will get permissions related to an Area Path. ( see Get-ADOAreaPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -109,9 +166,16 @@ If provided, will get permissions related to an Iteration Path. ( see Get-ADOIte -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Overview** @@ -128,9 +192,16 @@ These are: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tagging** @@ -138,9 +209,16 @@ If set, will get permissions for tagging related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Analytics** @@ -148,9 +226,16 @@ If set, will get permissions for analytics related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ManageTFVC** @@ -158,9 +243,16 @@ If set, will get permissions for Team Foundation Version Control related to the -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Plan** @@ -168,9 +260,16 @@ If set, will get permissions for Delivery Plans. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Dashboard** @@ -178,9 +277,16 @@ If set, will get dashboard permissions related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ServiceEndpoint** @@ -188,9 +294,16 @@ If set, will get all service endpoints permissions. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -198,9 +311,16 @@ If set, will get endpoint permissions related to a particular endpoint. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -208,9 +328,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPath** @@ -218,9 +345,16 @@ The path to the build. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPermission** @@ -228,9 +362,16 @@ If set, will get build and release permissions for a given project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -238,9 +379,16 @@ If provided, will get build and release permissions for a given project's reposi -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BranchName** @@ -248,9 +396,16 @@ If provided, will get permissions for a given branch within a repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectRepository** @@ -258,9 +413,16 @@ If set, will get permissions for repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllRepository** @@ -268,9 +430,16 @@ If set, will get permissions for repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Descriptor** @@ -278,9 +447,16 @@ The Descriptor -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Recurse** @@ -288,9 +464,16 @@ If set and this is a hierarchical namespace, return child ACLs of the specified -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeExtendedInfo** @@ -298,9 +481,16 @@ If set, populate the extended information properties for the access control entr -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExpandACL** @@ -308,9 +498,16 @@ If set, will expand the ACE dictionary returned -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -319,9 +516,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -331,15 +535,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.SecurityNamespace +* PSDevOps.SecurityNamespace + + +* PSDevOps.AccessControlList -PSDevOps.AccessControlList --- @@ -399,5 +612,3 @@ Get-ADOPermission -Organization -ServiceEndpoint [-Descriptor [-BranchName ] -AllRepository [-Descriptor ] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOPicklist.md b/docs/Get-ADOPicklist.md index 8f611cf6..599403de 100644 --- a/docs/Get-ADOPicklist.md +++ b/docs/Get-ADOPicklist.md @@ -1,4 +1,3 @@ - Get-ADOPicklist --------------- ### Synopsis @@ -14,7 +13,13 @@ Picklists are lists of values that can be associated with a field, for example, --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/list) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/get](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/get) + + + --- ### Examples #### EXAMPLE 1 @@ -35,9 +40,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PickListID** @@ -45,9 +57,16 @@ The Picklist Identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistName** @@ -55,9 +74,16 @@ The name of the picklist -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Orphan** @@ -65,9 +91,16 @@ If set, will return orphan picklists. These picklists are not associated with a -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -76,9 +109,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -88,15 +128,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Project +* PSDevOps.Project + + +* PSDevOps.Property -PSDevOps.Property --- @@ -111,5 +160,3 @@ Get-ADOPicklist -Organization [-PicklistName ] -Orphan [-Server Get-ADOPicklist -Organization -PickListID [-PicklistName ] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOProject.md b/docs/Get-ADOProject.md index 940dd135..ad3a17a7 100644 --- a/docs/Get-ADOProject.md +++ b/docs/Get-ADOProject.md @@ -1,4 +1,3 @@ - Get-ADOProject -------------- ### Synopsis @@ -12,7 +11,13 @@ Gets projects from Azure DevOps or TFS. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/list) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/list) + + + --- ### Examples #### EXAMPLE 1 @@ -39,9 +44,16 @@ The project name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -49,9 +61,16 @@ The project identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Metadata** @@ -59,9 +78,16 @@ If set, will get project metadta -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ProcessConfiguration** @@ -69,9 +95,16 @@ If set, will return the process configuration of a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PolicyConfiguration** @@ -79,9 +112,16 @@ If set, will return the policy configuration of a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PolicyType** @@ -89,9 +129,16 @@ If set, will return the policy types available in a given project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Plan** @@ -99,9 +146,16 @@ If set, will return the plans related to a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestRun** @@ -109,9 +163,16 @@ If set, will return the test runs associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestPlan** @@ -119,9 +180,16 @@ If set, will return the test plans associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestVariable** @@ -129,9 +197,16 @@ If set, will return the test variables associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestConfiguration** @@ -139,9 +214,16 @@ If set, will return the test variables associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PlanID** @@ -149,9 +231,16 @@ If set, will a specific project plan. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DeliveryTimeline** @@ -159,9 +248,16 @@ If set, will return the project delivery timeline associated with a given planID -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Wiki** @@ -169,9 +265,16 @@ If set, will return any wikis associated with the project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Board** @@ -179,9 +282,16 @@ If set, will return any boards associated with the project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Release** @@ -189,9 +299,16 @@ If set, will return releases associated with the project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PendingApproval** @@ -199,9 +316,16 @@ If set, will return pending approvals associated with the project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Organization** @@ -209,9 +333,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -220,9 +351,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -232,15 +370,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Project +* PSDevOps.Project + + +* PSDevOps.Property -PSDevOps.Property --- @@ -303,5 +450,3 @@ Get-ADOProject -ProjectID -Organization [-Server ] [-ApiV Get-ADOProject -PlanID -DeliveryTimeline -Organization [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADORepository.md b/docs/Get-ADORepository.md index 74b2bbb4..2ffedd0c 100644 --- a/docs/Get-ADORepository.md +++ b/docs/Get-ADORepository.md @@ -1,4 +1,3 @@ - Get-ADORepository ----------------- ### Synopsis @@ -27,7 +26,13 @@ We can get repositories for a given -ProviderName. --- ### Related Links * [Remove-ADORepository](Remove-ADORepository.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list%20repositories](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list%20repositories) + + + --- ### Examples #### EXAMPLE 1 @@ -43,9 +48,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -53,9 +65,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -63,9 +82,16 @@ The Repository ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CommitList** @@ -73,9 +99,16 @@ If set, will list commits associated with a given repository. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Skip** @@ -83,9 +116,16 @@ If provided, will -Skip N items. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **First** @@ -93,9 +133,16 @@ If provided, will return the -First N items. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **FileList** @@ -103,9 +150,16 @@ If set, will get the file list from a repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RecursionLevel** @@ -119,9 +173,19 @@ Valid Values: * None * oneLevel * oneLevelPlusNestedEmptyFolders -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScopePath** @@ -129,9 +193,16 @@ When getting a -FileList, the path scope. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VersionDescriptor** @@ -139,9 +210,16 @@ The version string identifier (name of tag/branch, SHA1 of commit) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VersionOption** @@ -154,9 +232,19 @@ Valid Values: * none * firstParent * previousChange -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VersionType** @@ -169,9 +257,19 @@ Valid Values: * branch * commit * tag -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeMetadata** @@ -179,9 +277,16 @@ If -IncludeContentMetadata is set a -FileList will include content metadata. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Download** @@ -189,9 +294,16 @@ If set, will include the parent repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PullRequest** @@ -199,9 +311,16 @@ If set, will list pull requests related to a git repository. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GitRef** @@ -209,9 +328,16 @@ If set, will list git references related to a repository. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BranchStatistic** @@ -219,9 +345,16 @@ If set, will list git branch statistics related to a repository. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TreeId** @@ -229,9 +362,16 @@ If provided, will output a tree of commits. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CreatorIdentity** @@ -239,9 +379,16 @@ Filters pull requests, returning requests created by the -CreatorIdentity. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReviewerIdentity** @@ -249,9 +396,16 @@ Filters pull requests where the -ReviewerIdentity is a reviewer. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourceReference** @@ -259,9 +413,16 @@ Filters pull requests where the source branch is the -SourceReference. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TargetReference** @@ -269,9 +430,16 @@ Filters pull requests where the target branch is the -TargetReference. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PullRequestStatus** @@ -286,9 +454,19 @@ Valid Values: * all * completed * notset -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PullRequestID** @@ -296,9 +474,16 @@ Get pull request with a specific id -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PushList** @@ -306,9 +491,16 @@ If set, will list pushes associated with a repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeParent** @@ -316,9 +508,16 @@ If set, will include the parent repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Recycled** @@ -326,9 +525,16 @@ If set, will get repositories from the recycle bin -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeHidden** @@ -336,9 +542,16 @@ If set, will include hidden repositories. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeLink** @@ -346,9 +559,16 @@ If set, will include all related links to a repository. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IncludeRemoteUrl** @@ -356,9 +576,16 @@ If set, will return all GitHub remote URLs associated with a repository. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **SourceProvider** @@ -366,9 +593,16 @@ If set, will list repository source providers -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProviderName** @@ -377,9 +611,16 @@ If the -ProviderName is not TFVC or TFGit, an -EndpointID is also required -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -388,9 +629,16 @@ If the -ProviderName is not TFVC or TFGit, an -EndpointID is also required -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryName** @@ -398,9 +646,16 @@ The name of the repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Path** @@ -409,9 +664,16 @@ To use this parameter, -ProviderName is also required, and -EndpointID will be r -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CommitOrBranch** @@ -419,9 +681,16 @@ The commit or branch. By default, Master. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -430,9 +699,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -442,21 +718,30 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Repository +* PSDevOps.Repository + +* PSDevOps.Repository.SourceProvider -PSDevOps.Repository.SourceProvider +* PSDevOps.Repository.File -PSDevOps.Repository.File + +* PSDevOps.Repoistory.Recycled -PSDevOps.Repoistory.Recycled --- @@ -504,5 +789,3 @@ Get-ADORepository -Organization -Project -ProviderName -Project -ProviderName [-EndpointID ] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOServiceEndpoint.md b/docs/Get-ADOServiceEndpoint.md index 9d147806..13a25c92 100644 --- a/docs/Get-ADOServiceEndpoint.md +++ b/docs/Get-ADOServiceEndpoint.md @@ -1,4 +1,3 @@ - Get-ADOServiceEndpoint ---------------------- ### Synopsis @@ -16,7 +15,13 @@ To see the types of service endpoints, use Get-ADOServiceEndpoint -GetEndpointTy --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get%20service%20endpoints?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get%20service%20endpoints?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -37,9 +42,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -47,9 +59,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -57,9 +76,16 @@ The Endpoint ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **History** @@ -67,9 +93,16 @@ If set, will get the execution history of the endpoint. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GetEndpointType** @@ -77,9 +110,16 @@ If set, will get the types of endpoints. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -88,9 +128,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -100,18 +147,27 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.ServiceEndpoint +* PSDevOps.ServiceEndpoint + +* StartAutomating.PSDevOps.ServiceEndpoint.History -StartAutomating.PSDevOps.ServiceEndpoint.History + +* StartAutomating.PSDevOps.ServiceEndpoint.Type -StartAutomating.PSDevOps.ServiceEndpoint.Type --- @@ -129,5 +185,3 @@ Get-ADOServiceEndpoint -Organization -Project -EndpointID -Project -EndpointID [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOServiceHealth.md b/docs/Get-ADOServiceHealth.md new file mode 100644 index 00000000..58f99792 --- /dev/null +++ b/docs/Get-ADOServiceHealth.md @@ -0,0 +1,106 @@ +Get-ADOServiceHealth +-------------------- +### Synopsis +Gets the Azure DevOps Service Health + +--- +### Description + +Gets the Service Health of Azure DevOps. + +--- +### Related Links +* [https://docs.microsoft.com/en-us/rest/api/azure/devops/status/health/get](https://docs.microsoft.com/en-us/rest/api/azure/devops/status/health/get) + + + +--- +### Examples +#### EXAMPLE 1 +```PowerShell +Get-ADOServiceHealth +``` + +--- +### Parameters +#### **Service** + +If provided, will query for health in a given geographic region. + + + +Valid Values: + +* Artifacts +* Boards +* Core services +* Other services +* Pipelines +* Repos +* Test Plans + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **Geography** + +If provided, will query for health in a given geographic region. + + + +Valid Values: + +* APAC +* AU +* BR +* CA +* EU +* IN +* UK +* US + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **ApiVersion** + +The api-version. By default, 6.0 + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +### Syntax +```PowerShell +Get-ADOServiceHealth [[-Service] ] [[-Geography] ] [[-ApiVersion] ] [] +``` +--- diff --git a/docs/Get-ADOServiceHook.md b/docs/Get-ADOServiceHook.md index ff8946c9..41a7c0c4 100644 --- a/docs/Get-ADOServiceHook.md +++ b/docs/Get-ADOServiceHook.md @@ -1,4 +1,3 @@ - Get-ADOServiceHook ------------------ ### Synopsis @@ -14,10 +13,25 @@ A subscription maps a publisher of events to a consumer of events. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list%20consumer%20actions?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list%20consumer%20actions?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/publishers/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/publishers/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/publishers/list%20event%20types?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/publishers/list%20event%20types?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -60,9 +74,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Consumer** @@ -70,9 +91,16 @@ If set, will list consumers. Consumers can receive events from a publisher. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ConsumerID** @@ -80,9 +108,16 @@ The Consumer ID. This can be provided to get details of an event consumer, or t -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Action** @@ -90,9 +125,16 @@ If set, will list actions available in a given event consumer. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Publisher** @@ -100,9 +142,16 @@ If set, will list publishers. Publishers can provide events to a consumer. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -110,9 +159,16 @@ The Publisher ID. This can be provided to get details of an event publisher, or -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EventType** @@ -120,9 +176,16 @@ If set, will list event types available from a given event publisher. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -131,9 +194,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -143,24 +213,33 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevops.Subscription +* PSDevops.Subscription -PSDevops.Consumer +* PSDevops.Consumer -PSDevops.Publisher +* PSDevops.Publisher -PSDevops.EventType +* PSDevops.EventType + + +* PSDevops.Action -PSDevops.Action --- @@ -187,5 +266,3 @@ Get-ADOServiceHook -Organization -PublisherID -EventType [-Ser Get-ADOServiceHook -Organization -PublisherID [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOTask.md b/docs/Get-ADOTask.md index ffcb77c1..e7b27a9d 100644 --- a/docs/Get-ADOTask.md +++ b/docs/Get-ADOTask.md @@ -1,4 +1,3 @@ - Get-ADOTask ----------- ### Synopsis @@ -12,6 +11,9 @@ Gets Tasks and Task Groups from Azure DevOps --- ### Related Links * [Convert-ADOPipeline](Convert-ADOPipeline.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ The organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -42,9 +51,16 @@ The project. Required to get task groups. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TaskGroup** @@ -52,9 +68,16 @@ If set, will get task groups related to a project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **YAMLSchema** @@ -62,9 +85,16 @@ If set, will get the schema for YAML tasks within an organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -73,12 +103,21 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -PSDevOps.Task +* PSDevOps.Task + + --- @@ -93,5 +132,3 @@ Get-ADOTask -Organization -Project -TaskGroup [-Server ] Get-ADOTask -Organization -YAMLSchema [-Server ] [] ``` --- - - diff --git a/docs/Get-ADOTeam.md b/docs/Get-ADOTeam.md index a9cc5560..b2af6cc4 100644 --- a/docs/Get-ADOTeam.md +++ b/docs/Get-ADOTeam.md @@ -1,4 +1,3 @@ - Get-ADOTeam ----------- ### Synopsis @@ -12,6 +11,9 @@ Gets teams from Azure DevOps or TFS --- ### Related Links * [Get-ADOProject](Get-ADOProject.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -37,9 +46,16 @@ The project name or identifier -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Mine** @@ -47,9 +63,16 @@ If set, will return teams in which the current user is a member. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TeamID** @@ -57,9 +80,16 @@ The Team Identifier -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Member** @@ -67,9 +97,16 @@ If set, will return members of a team. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **SecurityDescriptor** @@ -77,9 +114,16 @@ The Security Descriptor. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Identity** @@ -87,9 +131,16 @@ If set, will return the team identity. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Setting** @@ -97,9 +148,16 @@ If set, will return the team settings. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **FieldValue** @@ -107,9 +165,16 @@ If set, will return the team field values. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Iteration** @@ -117,9 +182,16 @@ If set, will return iterations for the team. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Board** @@ -127,9 +199,16 @@ If set, will list team workboards. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **SecurityGroup** @@ -137,9 +216,16 @@ If set, will list the security groups. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -148,9 +234,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -160,15 +253,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Team +* PSDevOps.Team + + +* PSDevOps.TeamMember -PSDevOps.TeamMember --- @@ -207,5 +309,3 @@ Get-ADOTeam -Organization -Member -SecurityDescriptor [-Server Get-ADOTeam -Organization -SecurityGroup [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOTest.md b/docs/Get-ADOTest.md index 98af4d7d..1d874adb 100644 --- a/docs/Get-ADOTest.md +++ b/docs/Get-ADOTest.md @@ -1,4 +1,3 @@ - Get-ADOTest ----------- ### Synopsis @@ -12,10 +11,25 @@ Gets test plans, suites, points, and results from Azure DevOps or TFS. --- ### Related Links * [Get-ADOProject](Get-ADOProject.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/test/runs/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/test/runs/list) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/test/results/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/test/results/list) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/test/test%20%20suites/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/test/test%20%20suites/list) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/testplan/test%20%20suites/get%20test%20suites%20for%20plan](https://docs.microsoft.com/en-us/rest/api/azure/devops/testplan/test%20%20suites/get%20test%20suites%20for%20plan) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +46,16 @@ The project identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TestRun** @@ -42,9 +63,16 @@ If set, will return the test runs associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestRunID** @@ -52,9 +80,16 @@ If set, will return results related to a specific test run. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TestPlan** @@ -62,9 +97,16 @@ If set, will return the test plans associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestPlanID** @@ -72,9 +114,16 @@ If set, will return results related to a specific test plan. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TestVariable** @@ -82,9 +131,16 @@ If set, will return the test variables associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestConfiguration** @@ -92,9 +148,16 @@ If set, will return the test variables associated with a project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestSuite** @@ -102,9 +165,16 @@ If set, will list test suites related to a plan. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestSuiteID** @@ -112,9 +182,16 @@ If set, will return results related to a particular test suite. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TestPoint** @@ -122,9 +199,16 @@ If set, will return test points within a suite. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TestResult** @@ -132,9 +216,16 @@ If set, will return test results within a run. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **First** @@ -142,9 +233,16 @@ If set, will return the first N results within a test run. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Total** @@ -152,9 +250,16 @@ If provided, will return the continue to return results of the maximum batch siz -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Skip** @@ -162,9 +267,16 @@ If set, will return the skip N results within a test run. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Outcome** @@ -189,9 +301,19 @@ Valid Values: * Passed * InProgress * NotImpacted -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ResultDetail** @@ -204,9 +326,19 @@ Valid Values: * None * Iterations * WorkItems -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TestAttachment** @@ -214,9 +346,16 @@ If set, will return test attachments to a run. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Organization** @@ -224,9 +363,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -235,9 +381,16 @@ By default, cached data will be returned. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -246,9 +399,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -258,15 +418,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Project +* PSDevOps.Project + + +* PSDevOps.Property -PSDevOps.Property --- @@ -305,5 +474,3 @@ Get-ADOTest -ProjectID -TestConfiguration -Organization [-Forc Get-ADOTest -ProjectID -TestSuiteID -Organization [-Force] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOUser.md b/docs/Get-ADOUser.md index 7dcb8718..d2c0d76b 100644 --- a/docs/Get-ADOUser.md +++ b/docs/Get-ADOUser.md @@ -1,4 +1,3 @@ - Get-ADOUser ----------- ### Synopsis @@ -12,8 +11,17 @@ Gets users from Azure DevOps. --- ### Related Links * [Get-ADOTeam](Get-ADOTeam.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/search%20user%20entitlements](https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/search%20user%20entitlements) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **StorageKey** @@ -39,9 +54,16 @@ If set, will get details about a particular user storage key -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MemberURL** @@ -49,9 +71,16 @@ If set, will get details about a particular member URL. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -59,9 +88,16 @@ The project name or identifier. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **TeamID** @@ -69,9 +105,16 @@ The Team Identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Entitlement** @@ -79,9 +122,16 @@ If set, will get user entitlement data. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Filter** @@ -89,9 +139,16 @@ If provided, will filter user entitlement data. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **OrderBy** @@ -99,9 +156,16 @@ If provided, will order user entitlement data. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Select** @@ -109,9 +173,16 @@ If provided, will select given properties of user entitlement data. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SubjectType** @@ -119,9 +190,16 @@ If provided, will get graph users of one or more subject types. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -130,9 +208,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -142,15 +227,24 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Team +* PSDevOps.Team + + +* PSDevOps.TeamMember -PSDevOps.TeamMember --- @@ -174,5 +268,3 @@ Get-ADOUser -Organization -Project -TeamID [-Server < Get-ADOUser -Organization -Entitlement [-Filter ] [-OrderBy ] [-Select ] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOWiki.md b/docs/Get-ADOWiki.md index 7ce09e29..812970b9 100644 --- a/docs/Get-ADOWiki.md +++ b/docs/Get-ADOWiki.md @@ -1,4 +1,3 @@ - Get-ADOWiki ----------- ### Synopsis @@ -12,6 +11,9 @@ Gets Azure DevOps Wikis related to a project. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/list](https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/list) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -37,9 +46,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WikiID** @@ -47,9 +63,16 @@ The Wiki Identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -58,9 +81,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -70,12 +100,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Wiki +* PSDevOps.Wiki + + --- @@ -87,5 +126,3 @@ Get-ADOWiki -Organization -Project [-Server ] [-ApiVersio Get-ADOWiki -Organization -Project -WikiID [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOWorkItem.md b/docs/Get-ADOWorkItem.md index 9aa99d21..6696869f 100644 --- a/docs/Get-ADOWorkItem.md +++ b/docs/Get-ADOWorkItem.md @@ -1,4 +1,3 @@ - Get-ADOWorkItem --------------- ### Synopsis @@ -12,8 +11,17 @@ Gets work item from Azure DevOps or Team Foundation Server. --- ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/get%20work%20item?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/get%20work%20item?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +42,16 @@ The Work Item Title -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Query** @@ -44,9 +59,16 @@ A query. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Mine** @@ -54,9 +76,16 @@ Gets work items assigned to me. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CurrentIteration** @@ -64,9 +93,16 @@ Gets work items in the current iteration. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoDetail** @@ -75,9 +111,16 @@ If not provided, details will be retreived for all work items. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -85,9 +128,16 @@ The Work Item ID -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|true |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Comment** @@ -95,9 +145,16 @@ If set, will get comments related to a work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Revision** @@ -105,9 +162,16 @@ If set, will get revisions of a work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Update** @@ -115,9 +179,16 @@ If set, will get updates of a work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Organization** @@ -125,9 +196,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -135,9 +213,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -145,9 +230,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **First** @@ -155,9 +247,16 @@ If provided, will only return the first N results from a query. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |named |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WorkItemType** @@ -165,9 +264,16 @@ If set, will return work item types. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SharedQuery** @@ -175,9 +281,16 @@ If set, will return work item shared queries -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeDeleted** @@ -185,9 +298,16 @@ If set, will return shared queries that have been deleted. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Depth** @@ -195,9 +315,16 @@ If provided, will return shared queries up to a given depth. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SharedQueryFilter** @@ -205,9 +332,16 @@ If provided, will filter the shared queries returned -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExpandSharedQuery** @@ -222,9 +356,19 @@ Valid Values: * Minimal * None * Wiql -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Field** @@ -232,9 +376,16 @@ One or more fields. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Related** @@ -242,9 +393,16 @@ If set, will get related items -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -253,9 +411,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -265,12 +430,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.WorkItem +* PSDevOps.WorkItem + + --- @@ -300,5 +474,3 @@ Get-ADOWorkItem [-Title ] [-Mine] [-CurrentIteration] -Organization ] [-Mine] [-CurrentIteration] -Organization [-Project ] -WorkItemType [-Field ] [-Related] [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOWorkItemType.md b/docs/Get-ADOWorkItemType.md index 13ce7c82..4b0ed2b4 100644 --- a/docs/Get-ADOWorkItemType.md +++ b/docs/Get-ADOWorkItemType.md @@ -1,4 +1,3 @@ - Get-ADOWorkItemType ------------------- ### Synopsis @@ -12,6 +11,9 @@ Gets work item types from Azure DevOps --- ### Related Links * [Get-ADOWorkProcess](Get-ADOWorkProcess.md) + + + --- ### Examples #### EXAMPLE 1 @@ -38,9 +40,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -48,9 +57,16 @@ The ProcessID. This is returned from Get-ADOWorkProcess. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReferenceName** @@ -58,9 +74,16 @@ The Reference Name of the Work Item Type. This can be provided by piping Get-AD -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Layout** @@ -68,9 +91,16 @@ If set, will get the layout associated with a given work item type. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Page** @@ -78,9 +108,16 @@ If set, will get the pages within a given work item type layout. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **State** @@ -88,9 +125,16 @@ If set, will get the states associated with a given work item type. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Rule** @@ -98,9 +142,16 @@ If set, will get the rules associated with a given work item type. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Behavior** @@ -108,9 +159,16 @@ If set, will get the behaviors associated with a given work item type. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Field** @@ -118,9 +176,16 @@ If set, will get the fields associated with a given work item type. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Project** @@ -128,9 +193,16 @@ The name of the project. If provided, will get work item type information relat -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Icon** @@ -138,9 +210,16 @@ If set, will get work item icons available to the organization. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -149,9 +228,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -161,27 +247,36 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.WorkItemType +* PSDevOps.WorkItemType + + +* PSDevOps.State -PSDevOps.State +* PSDevOps.Rule -PSDevOps.Rule +* PSDevOps.Behavior -PSDevOps.Behavior +* PSDevOps.Layout -PSDevOps.Layout +* PSDevOps.ProcessField -PSDevOps.ProcessField --- @@ -214,5 +309,3 @@ Get-ADOWorkItemType -Organization -Project [-Server ] [-A Get-ADOWorkItemType -Organization -Icon [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-ADOWorkProcess.md b/docs/Get-ADOWorkProcess.md index 6dea8cc6..f4eedaf8 100644 --- a/docs/Get-ADOWorkProcess.md +++ b/docs/Get-ADOWorkProcess.md @@ -1,4 +1,3 @@ - Get-ADOWorkProcess ------------------ ### Synopsis @@ -12,6 +11,9 @@ Gets work processes from Azure DevOps. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/list?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -42,9 +51,16 @@ The Project Identifier. If this is provided, will get the work process associat -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -52,9 +68,16 @@ The process identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WorkItemType** @@ -62,9 +85,16 @@ If set, will list work item types in a given Work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Behavior** @@ -72,9 +102,16 @@ If set, will list behaviors associated with a given work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -83,9 +120,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -95,12 +139,21 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.WorkProcess +* PSDevOps.WorkProcess + + --- @@ -121,5 +174,3 @@ Get-ADOWorkProcess -Organization -ProcessID -WorkItemType [-Se Get-ADOWorkProcess -Organization -ProcessID [-Server ] [-ApiVersion ] [] ``` --- - - diff --git a/docs/Get-BuildStep.md b/docs/Get-BuildStep.md index 8030c119..1f36cd22 100644 --- a/docs/Get-BuildStep.md +++ b/docs/Get-BuildStep.md @@ -1,4 +1,3 @@ - Get-BuildStep ------------- ### Synopsis @@ -14,6 +13,9 @@ Build Steps are scripts or data fragments used to compose a build. --- ### Related Links * [Import-BuildStep](Import-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +31,16 @@ If provided, only return build steps that are like this name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Extension** @@ -39,9 +48,16 @@ If provided, only return build steps matching this extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Type** @@ -49,9 +65,16 @@ If provided, only return build steps of a given type. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildSystem** @@ -59,12 +82,21 @@ If provided, only return build steps for a given build system. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -PSDevOps.BuildStep +* PSDevOps.BuildStep + + --- @@ -73,5 +105,3 @@ PSDevOps.BuildStep Get-BuildStep [[-Name] ] [[-Extension] ] [[-Type] ] [[-BuildSystem] ] [] ``` --- - - diff --git a/docs/Get-PSDevOps.md b/docs/Get-PSDevOps.md index 1e80d8a8..47914edd 100644 --- a/docs/Get-PSDevOps.md +++ b/docs/Get-PSDevOps.md @@ -1,4 +1,3 @@ - Get-PSDevOps ------------ ### Synopsis @@ -43,9 +42,16 @@ The name of the script. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScriptPath** @@ -55,9 +61,16 @@ If the paths resolve to scripts or commands -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ModuleInfo** @@ -66,9 +79,16 @@ Get-Module PSDevOps | Get-PSDevOps -|Type |Requried|Postion|PipelineInput | -|----------------------|--------|-------|------------------------------| -|```[PSModuleInfo[]]```|false |3 |true (ByValue, ByPropertyName)| +> **Type**: ```[PSModuleInfo[]]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByValue, ByPropertyName) + + + --- #### **Pattern** @@ -83,9 +103,16 @@ By default: -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |4 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Recurse** @@ -93,14 +120,19 @@ If set, will search directories recursively. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Syntax ```PowerShell Get-PSDevOps [[-Name] ] [[-ScriptPath] ] [[-ModuleInfo] ] [[-Pattern] ] [-Recurse] [] ``` --- - - diff --git a/docs/Hide-GitHubOutput.md b/docs/Hide-GitHubOutput.md index d8cd47ad..096ee2c7 100644 --- a/docs/Hide-GitHubOutput.md +++ b/docs/Hide-GitHubOutput.md @@ -1,4 +1,3 @@ - Hide-GitHubOutput ----------------- ### Synopsis @@ -12,7 +11,13 @@ Prevents a message from being printed in a GitHub Workflow log. --- ### Related Links * [Write-GitHubOutput](Write-GitHubOutput.md) + + + * [https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions](https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions) + + + --- ### Examples #### EXAMPLE 1 @@ -29,12 +34,21 @@ The message to hide. Any time this string would appear in logs, it will be repl -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -43,5 +57,3 @@ System.String Hide-GitHubOutput [-Message] [] ``` --- - - diff --git a/docs/Import-ADOProxy.md b/docs/Import-ADOProxy.md index 0d7a086e..fa11aed2 100644 --- a/docs/Import-ADOProxy.md +++ b/docs/Import-ADOProxy.md @@ -1,4 +1,3 @@ - Import-ADOProxy --------------- ### Synopsis @@ -14,7 +13,13 @@ A Proxy module will wrap all commands, but will always provide one or more defau --- ### Related Links * [Connect-ADO](Connect-ADO.md) + + + * [Disconnect-ADO](Disconnect-ADO.md) + + + --- ### Examples #### EXAMPLE 1 @@ -40,9 +45,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -50,9 +62,16 @@ The project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -60,9 +79,16 @@ The server. This can be used to provide a TFS instance -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Prefix** @@ -71,9 +97,16 @@ If not provided, this will be the -Server + -Organization + -Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeCommand** @@ -81,9 +114,16 @@ A list of command wildcards to include. By default, all applicable commands. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeCommand** @@ -91,9 +131,16 @@ A list of commands to exclude. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -101,9 +148,16 @@ If set, will return the imported module. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Force** @@ -111,15 +165,24 @@ If set, will unload a previously loaded copy of the module. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSModuleInfo](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSModuleInfo) -System.Management.Automation.PSModuleInfo --- @@ -128,5 +191,3 @@ System.Management.Automation.PSModuleInfo Import-ADOProxy [-Organization] [[-Project] ] [[-Server] ] [[-Prefix] ] [[-IncludeCommand] ] [[-ExcludeCommand] ] [-PassThru] [-Force] [] ``` --- - - diff --git a/docs/Import-BuildStep.md b/docs/Import-BuildStep.md index 1a2d9740..dfc1fb47 100644 --- a/docs/Import-BuildStep.md +++ b/docs/Import-BuildStep.md @@ -1,4 +1,3 @@ - Import-BuildStep ---------------- ### Synopsis @@ -12,7 +11,13 @@ Imports Build Steps defined in a module. --- ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) + + + * [Expand-BuildStep](Expand-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The name of the module containing build steps. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourcePath** @@ -38,9 +50,67 @@ The source path. This path contains definitions for a given single build system -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **SourceFile** + +The source path to a single item. + + + +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **BuildStepType** + +The type the source file will be in a given build system. By default, step. + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **BuildStepName** + +An optional name for the build step. If none is provided, the filename will be used + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeCommand** @@ -48,9 +118,16 @@ A list of commands to include. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeCommand** @@ -58,9 +135,16 @@ A list of commands to exclude -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildSystem** @@ -75,9 +159,19 @@ Valid Values: * ADOExtension * GitHubAction * GitHubWorkflow -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildSystemAlias** @@ -87,24 +181,47 @@ By default, GitHubWorkflows can exist within a directory named GitHubWorkflow, G -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |named |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildSystemInclude** -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |named |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildCommandType** -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |named |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + --- @@ -115,6 +232,7 @@ Import-BuildStep -ModuleName [-IncludeCommand ] [-ExcludeComm ```PowerShell Import-BuildStep -SourcePath [-BuildSystem ] [-BuildSystemAlias ] [-BuildSystemInclude ] [-BuildCommandType ] [] ``` +```PowerShell +Import-BuildStep -SourceFile [-BuildStepType ] [-BuildStepName ] [-BuildSystem ] [-BuildSystemAlias ] [-BuildSystemInclude ] [-BuildCommandType ] [] +``` --- - - diff --git a/docs/Install-ADOExtension.md b/docs/Install-ADOExtension.md index 84300b1d..0f636985 100644 --- a/docs/Install-ADOExtension.md +++ b/docs/Install-ADOExtension.md @@ -1,4 +1,3 @@ - Install-ADOExtension -------------------- ### Synopsis @@ -12,7 +11,13 @@ Installs Azure DevOps Extensions from the Marketplace --- ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) + + + * [Uninstall-ADOExtension](Uninstall-ADOExtension.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -38,9 +50,16 @@ The Publisher of an Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -48,9 +67,16 @@ The name of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Version** @@ -58,9 +84,16 @@ The version of the extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -69,9 +102,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -81,9 +121,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |6 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -99,7 +146,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Extension +* PSDevOps.Extension + + --- @@ -108,5 +157,3 @@ PSDevOps.Extension Install-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Version] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Invoke-ADORestAPI.md b/docs/Invoke-ADORestAPI.md index 5241cf99..2613ee51 100644 --- a/docs/Invoke-ADORestAPI.md +++ b/docs/Invoke-ADORestAPI.md @@ -1,4 +1,3 @@ - Invoke-ADORestAPI ----------------- ### Synopsis @@ -12,6 +11,9 @@ Invokes the Azure DevOps REST API --- ### Related Links * [Invoke-RestMethod](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +32,16 @@ The REST API Url -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|true |1 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Method** @@ -61,9 +70,19 @@ Valid Values: * POST * PUT * TRACE -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Body** @@ -73,9 +92,16 @@ Otherwise, this value will be converted into JSON. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Object]```|false |named |true (ByPropertyName)| +> **Type**: ```[Object]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UrlParameter** @@ -83,9 +109,16 @@ Parameters provided as part of the URL (in segments or a query string). -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryParameter** @@ -93,9 +126,16 @@ Additional parameters provided after the URL. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ContentType** @@ -104,9 +144,16 @@ If this parameter is omitted and the request method is POST, Invoke-RestMethod s -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Headers** @@ -114,9 +161,16 @@ Specifies the headers of the web request. Enter a hash table or dictionary. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PersonalAccessToken** @@ -124,9 +178,16 @@ A Personal Access Token -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Credential** @@ -135,9 +196,16 @@ Type a user name, such as User01 or Domain01\User01, or enter a PSCredential obj -|Type |Requried|Postion|PipelineInput| -|--------------------|--------|-------|-------------| -|```[PSCredential]```|false |named |false | +> **Type**: ```[PSCredential]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **UseDefaultCredentials** @@ -145,9 +213,16 @@ Indicates that the cmdlet uses the credentials of the current user to send the w -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ContinuationToken** @@ -156,9 +231,16 @@ Invoke-ADORestAPI will call recursively invoke itself until a response does not -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PSTypeName** @@ -166,9 +248,16 @@ The typename of the results. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Property** @@ -176,9 +265,16 @@ A set of additional properties to add to an object -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RemoveProperty** @@ -186,9 +282,16 @@ A list of property names to remove from an object -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExpandProperty** @@ -196,9 +299,16 @@ If provided, will expand a given property returned from the REST api. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DecorateProperty** @@ -207,9 +317,16 @@ This allows nested REST properties to work with the PowerShell Extended Type Sys -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Cache** @@ -217,9 +334,16 @@ If set, will cache results from a request. Only HTTP GET results will be cached -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **AsByte** @@ -227,9 +351,16 @@ If set, will return results as a byte array. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AsJob** @@ -239,9 +370,16 @@ This parameter will also be ignore when calling with -DynamicParameter or -MapPa -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DynamicParameter** @@ -249,9 +387,16 @@ If set, will get the dynamic parameters that should be provided to any function -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MapParameter** @@ -260,12 +405,21 @@ Unmapped parameters will be added as a noteproperty of the returned dictionary. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|true |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- @@ -280,5 +434,3 @@ Invoke-ADORestAPI [-PersonalAccessToken ] [-Credential ] [ Invoke-ADORestAPI [-PersonalAccessToken ] [-Credential ] [-UseDefaultCredentials] [-Cache] [-AsByte] [-AsJob] -MapParameter [] ``` --- - - diff --git a/docs/Invoke-GitHubRestAPI.md b/docs/Invoke-GitHubRestAPI.md index 65a7715f..d09218ce 100644 --- a/docs/Invoke-GitHubRestAPI.md +++ b/docs/Invoke-GitHubRestAPI.md @@ -1,4 +1,3 @@ - Invoke-GitHubRestAPI -------------------- ### Synopsis @@ -12,6 +11,9 @@ Invokes the GitHub REST API --- ### Related Links * [Invoke-RestMethod](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +32,16 @@ The REST API Url -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Method** @@ -61,9 +70,19 @@ Valid Values: * POST * PUT * TRACE -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Body** @@ -73,15 +92,29 @@ Otherwise, this value will be converted into JSON. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Object]```|false |named |true (ByPropertyName)| +> **Type**: ```[Object]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UrlParameter** -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryParameter** @@ -89,9 +122,16 @@ Additional parameters provided in the query string. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PersonalAccessToken** @@ -99,9 +139,16 @@ A Personal Access Token -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Page** @@ -110,9 +157,16 @@ If this is not provided, additional results will be fetched until they are exhau -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PerPage** @@ -120,9 +174,16 @@ The number of items to retreive on a single page. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PSTypeName** @@ -133,9 +194,16 @@ so would: "https://api.github.com/users/{UserName}/repos") -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Property** @@ -143,9 +211,16 @@ A set of additional properties to add to an object -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RemoveProperty** @@ -153,9 +228,16 @@ A list of property names to remove from an object -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExpandProperty** @@ -163,9 +245,16 @@ If provided, will expand a given property returned from the REST api. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DecorateProperty** @@ -174,9 +263,16 @@ This allows nested REST properties to work with the PowerShell Extended Type Sys -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Cache** @@ -184,9 +280,16 @@ If set, will cache results from a request. Only HTTP GET results will be cached -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AsJob** @@ -196,9 +299,16 @@ This parameter will also be ignore when calling with -DynamicParameter or -MapPa -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DynamicParameter** @@ -206,9 +316,16 @@ If set, will get the dynamic parameters that should be provided to any function -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MapParameter** @@ -217,9 +334,16 @@ Unmapped parameters will be added as a noteproperty of the returned dictionary. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|true |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GitApiUrl** @@ -229,9 +353,16 @@ It will default to $env:GIT_API_URL if it is set, otherwise 'https://api.github. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ContentType** @@ -240,9 +371,16 @@ If this parameter is omitted and the request method is POST, Invoke-RestMethod s -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Headers** @@ -250,9 +388,16 @@ Specifies the headers of the web request. Enter a hash table or dictionary. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UserAgent** @@ -260,12 +405,21 @@ Provides a custom user agent. GitHub API requests require a User Agent. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- @@ -280,5 +434,3 @@ Invoke-GitHubRestAPI [-PersonalAccessToken ] [-Cache] [-AsJob] -DynamicP Invoke-GitHubRestAPI [-PersonalAccessToken ] [-Cache] [-AsJob] -MapParameter [] ``` --- - - diff --git a/docs/New-ADOArtifactFeed.md b/docs/New-ADOArtifactFeed.md index 8cc3c16a..a58d6198 100644 --- a/docs/New-ADOArtifactFeed.md +++ b/docs/New-ADOArtifactFeed.md @@ -1,4 +1,3 @@ - New-ADOArtifactFeed ------------------- ### Synopsis @@ -14,7 +13,13 @@ Artifact feeds are used to publish packages. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed%20view?view=azure-devops-rest-5.1#feedvisibility](https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed%20view?view=azure-devops-rest-5.1#feedvisibility) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +35,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -40,9 +52,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -51,9 +70,16 @@ The Feed Name -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -62,9 +88,16 @@ The feed description. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoBadge** @@ -72,9 +105,16 @@ If set, this feed will not support the generation of package badges. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublicUpstream** @@ -90,9 +130,19 @@ Valid Values: * PyPi * Maven * PowerShellGallery -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UpstreamSource** @@ -100,9 +150,16 @@ A property bag describing upstream sources -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllowConflictUpstream** @@ -110,9 +167,16 @@ If set, will allow package names to conflict with the names of packages upstream -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsReadOnly** @@ -121,9 +185,16 @@ It is important to note that feed views are immutable; therefore, this flag will -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedID** @@ -131,9 +202,16 @@ The feed id. This can be supplied to create a veiw for a particular feed. -|Type |Requried|Postion|PipelineInput | -|------------|--------|-------|---------------------| -|```[Guid]```|false |named |true (ByPropertyName)| +> **Type**: ```[Guid]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ShowDeletedPackageVersions** @@ -141,9 +219,16 @@ If set, the feed will not hide all deleted/unpublished versions -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedRole** @@ -157,9 +242,19 @@ Valid Values: * Collaborator * Contributor * Reader -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **View** @@ -167,9 +262,16 @@ If set, will create a new view for an artifact feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ViewVisibility** @@ -182,9 +284,19 @@ Valid Values: * Collection * Organization * Private -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -192,9 +304,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -202,9 +321,16 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -220,10 +346,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.ArtifactFeed +* PSDevOps.ArtifactFeed + + +* PSDevOps.ArtifactFeed.View -PSDevOps.ArtifactFeed.View --- @@ -235,5 +363,3 @@ New-ADOArtifactFeed -Organization [-Project ] -Name [- New-ADOArtifactFeed -Organization [-Project ] -Name -FeedID -View [-ViewVisibility ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOBuild.md b/docs/New-ADOBuild.md index 96777f44..1b3e0df6 100644 --- a/docs/New-ADOBuild.md +++ b/docs/New-ADOBuild.md @@ -1,4 +1,3 @@ - New-ADOBuild ------------ ### Synopsis @@ -12,6 +11,9 @@ Creates Build Definitions in Azure DevOps. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/create](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/create) + + + --- ### Examples #### EXAMPLE 1 @@ -36,9 +38,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -46,9 +55,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -56,9 +72,16 @@ The name of the build. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Path** @@ -66,9 +89,16 @@ The folder path of the definition. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **YAMLFileName** @@ -76,9 +106,16 @@ The path to a YAML file containing the build definition -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Comment** @@ -86,9 +123,16 @@ A comment about the build defintion revision. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -96,9 +140,16 @@ A description of the build definition. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |7 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DropLocation** @@ -106,9 +157,16 @@ The drop location for the build -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildNumberFormat** @@ -116,9 +174,16 @@ The build number format -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Repository** @@ -126,9 +191,16 @@ The repository used by the build definition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|true |10 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Queue** @@ -136,9 +208,16 @@ The queue used by the build definition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |11 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Demand** @@ -146,9 +225,16 @@ A collection of demands for the build definition. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |12 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Variable** @@ -156,9 +242,16 @@ A collection of variables for the build definition. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |13 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 13 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Secret** @@ -166,9 +259,16 @@ A collection of secrets for the build definition. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |14 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 14 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tag** @@ -176,9 +276,16 @@ A list of tags for the build definition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |15 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 15 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -187,9 +294,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |16 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 16 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -199,9 +313,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |17 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 17 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -217,7 +338,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Build.Definition +* PSDevOps.Build.Definition + + --- @@ -226,5 +349,3 @@ PSDevOps.Build.Definition New-ADOBuild [-Organization] [-Project] [-Name] [[-Path] ] [[-YAMLFileName] ] [[-Comment] ] [[-Description] ] [[-DropLocation] ] [[-BuildNumberFormat] ] [-Repository] [[-Queue] ] [[-Demand] ] [[-Variable] ] [[-Secret] ] [[-Tag] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOField.md b/docs/New-ADOField.md index 114338ec..9ce1eaf2 100644 --- a/docs/New-ADOField.md +++ b/docs/New-ADOField.md @@ -1,4 +1,3 @@ - New-ADOField ------------ ### Synopsis @@ -12,6 +11,9 @@ Creates new work item fields in Azure DevOps or Team Foundation Server. --- ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ The friendly name of the field -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReferenceName** @@ -43,9 +52,16 @@ If not provided, the ReferenceName will Custom. + -Name (stripped of whitespace) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Type** @@ -82,9 +98,19 @@ Valid Values: * plainText * string * treePath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -92,9 +118,16 @@ A description for the field. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ValidValue** @@ -103,9 +136,16 @@ If provided, an associated picklist will be created with these values. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CanSortBy** @@ -113,9 +153,16 @@ If set, the field can be used to sort. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsQueryable** @@ -123,9 +170,16 @@ If set, the field can be used in queries. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReadOnly** @@ -133,9 +187,16 @@ If set, the field will be read only. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllowCustomValue** @@ -144,9 +205,16 @@ This is ignored if not used with -ValidValue. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Organization** @@ -154,9 +222,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |6 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -164,9 +239,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |7 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -175,9 +257,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |8 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -187,9 +276,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |9 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -205,7 +301,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Field +* PSDevOps.Field + + --- @@ -214,5 +312,3 @@ PSDevOps.Field New-ADOField [-Name] [[-ReferenceName] ] [[-Type] ] [[-Description] ] [[-ValidValue] ] [-CanSortBy] [-IsQueryable] [-ReadOnly] [-AllowCustomValue] [-Organization] [[-Project] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOPipeline.md b/docs/New-ADOPipeline.md index 189d8c90..dc6a1743 100644 --- a/docs/New-ADOPipeline.md +++ b/docs/New-ADOPipeline.md @@ -1,4 +1,3 @@ - New-ADOPipeline --------------- ### Synopsis @@ -12,7 +11,13 @@ Create a new Azure DevOps Pipeline. --- ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) + + + * [Import-BuildStep](Import-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +38,16 @@ The InputObject -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|false |1 |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByValue) + + + --- #### **UseSystemAccessToken** @@ -43,9 +55,16 @@ If set, will use map the system access token to an environment variable in each -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Option** @@ -55,9 +74,16 @@ For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessTok -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |2 |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **VariableParameter** @@ -66,9 +92,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EnvironmentParameter** @@ -77,9 +110,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeParameter** @@ -87,9 +127,16 @@ The name of parameters that should be excluded. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueParameter** @@ -99,9 +146,16 @@ The build parameter would be foo_bar. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultParameter** @@ -109,9 +163,16 @@ A collection of default parameters. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |7 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildScript** @@ -119,9 +180,16 @@ A list of build scripts. Each build script will run as a step in the same job. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |8 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:false + + + --- #### **PassThru** @@ -129,9 +197,16 @@ If set, will output the created objects instead of creating YAML. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PowerShellCore** @@ -139,9 +214,16 @@ If set, will run scripts using PowerShell core, even if on Windows. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WindowsPowerShell** @@ -149,9 +231,16 @@ If set will run script using WindowsPowerShell if available. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **RootDirectory** @@ -159,22 +248,49 @@ If provided, will directly reference build steps beneath this directory. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |9 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:false + + + +--- +#### **OutputPath** + +If provided, will output to a given path and return a file. + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + +* [IO.FileInfo](https://learn.microsoft.com/en-us/dotnet/api/System.IO.FileInfo) -System.Management.Automation.PSObject --- ### Syntax ```PowerShell -New-ADOPipeline [[-InputObject] ] [-UseSystemAccessToken] [[-Option] ] [[-VariableParameter] ] [[-EnvironmentParameter] ] [[-ExcludeParameter] ] [[-UniqueParameter] ] [[-DefaultParameter] ] [[-BuildScript] ] [-PassThru] [-PowerShellCore] [-WindowsPowerShell] [[-RootDirectory] ] [] +New-ADOPipeline [[-InputObject] ] [-UseSystemAccessToken] [[-Option] ] [[-VariableParameter] ] [[-EnvironmentParameter] ] [[-ExcludeParameter] ] [[-UniqueParameter] ] [[-DefaultParameter] ] [[-BuildScript] ] [-PassThru] [-PowerShellCore] [-WindowsPowerShell] [[-RootDirectory] ] [[-OutputPath] ] [] ``` --- - - diff --git a/docs/New-ADOProject.md b/docs/New-ADOProject.md index fea526cc..4bdfc85a 100644 --- a/docs/New-ADOProject.md +++ b/docs/New-ADOProject.md @@ -1,4 +1,3 @@ - New-ADOProject -------------- ### Synopsis @@ -12,6 +11,9 @@ Creates new projects in Azure DevOps or TFS. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/list?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/list?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The name of the project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -37,9 +46,16 @@ The project description. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Process** @@ -47,9 +63,16 @@ The process template used by the project. By default, 'Agile' -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Public** @@ -58,9 +81,16 @@ If not set, the project will be created as a private project. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Abbreviation** @@ -68,9 +98,16 @@ The project abbreviation -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |4 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Organization** @@ -78,9 +115,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -89,9 +133,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -101,9 +152,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -119,7 +177,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Project +* PSDevOps.Project + + --- @@ -128,5 +188,3 @@ PSDevOps.Project New-ADOProject [-Name] [-Description] [[-Process] ] [-Public] [[-Abbreviation] ] [-Organization] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADORepository.md b/docs/New-ADORepository.md index 0366a7bf..7d5b4c51 100644 --- a/docs/New-ADORepository.md +++ b/docs/New-ADORepository.md @@ -1,4 +1,3 @@ - New-ADORepository ----------------- ### Synopsis @@ -12,7 +11,13 @@ Creates a new repository in Azure DevOps. --- ### Related Links * [Get-ADORepository](Get-ADORepository.md) + + + * [Remove-ADORepository](Remove-ADORepository.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryName** @@ -48,9 +67,16 @@ The name of the repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UpstreamName** @@ -58,9 +84,16 @@ The name of the upstream repository (this creates a forked repository from the s -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UpstreamID** @@ -68,9 +101,16 @@ The ID of an upstream repository (this creates a forked repository) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -79,9 +119,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -91,9 +138,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -109,10 +163,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Repository +* PSDevOps.Repository + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -hashtable --- @@ -121,5 +177,3 @@ hashtable New-ADORepository [-Organization] [-Project] [-RepositoryName] [[-UpstreamName] ] [[-UpstreamID] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOServiceEndpoint.md b/docs/New-ADOServiceEndpoint.md index 0347ace6..6b2739b0 100644 --- a/docs/New-ADOServiceEndpoint.md +++ b/docs/New-ADOServiceEndpoint.md @@ -1,4 +1,3 @@ - New-ADOServiceEndpoint ---------------------- ### Synopsis @@ -16,6 +15,9 @@ To see the types of service endpoints, use Get-ADOServiceEndpoint -GetEndpointTy --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/create?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/create?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -36,9 +38,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -46,9 +55,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -56,9 +72,16 @@ The name of the endpoint -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AdministratorsGroup** @@ -66,9 +89,16 @@ Initial administrators of the endpoint -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |4 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Authorization** @@ -76,9 +106,16 @@ Endpoint authorization data -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |5 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Data** @@ -86,9 +123,16 @@ General endpoint data -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |6 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReadersGroup** @@ -96,9 +140,16 @@ Initial readers of the endpoint -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |7 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Type** @@ -106,9 +157,16 @@ The endpoint type. To see available endpoint types, use Get-ADOServiceEndpoint -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -116,9 +174,16 @@ The endpoint description. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Url** @@ -126,9 +191,16 @@ The endpoint service URL. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |10 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsShared** @@ -136,9 +208,16 @@ If set, the endpoint will be shared across projects -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -147,9 +226,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |11 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -159,9 +245,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |12 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -177,10 +270,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.ServiceEndpoint +* PSDevOps.ServiceEndpoint + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -hashtable --- @@ -189,5 +284,3 @@ hashtable New-ADOServiceEndpoint [-Organization] [-Project] [-Name] [[-AdministratorsGroup] ] [[-Authorization] ] [[-Data] ] [[-ReadersGroup] ] [[-Type] ] [[-Description] ] [[-Url] ] [-IsShared] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOWorkItem.md b/docs/New-ADOWorkItem.md index 2487b84e..278a9303 100644 --- a/docs/New-ADOWorkItem.md +++ b/docs/New-ADOWorkItem.md @@ -1,4 +1,3 @@ - New-ADOWorkItem --------------- ### Synopsis @@ -12,6 +11,9 @@ Creates new work items in Azure DevOps or Team Foundation Server. --- ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +30,16 @@ The InputObject -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|------------------------------| -|```[PSObject]```|true |named |true (ByValue, ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByValue, ByPropertyName) + + + --- #### **Type** @@ -38,9 +47,16 @@ The type of the work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryName** @@ -48,9 +64,16 @@ If set, will create a shared query for work items. The -InputObject will be pas -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryPath** @@ -58,9 +81,16 @@ If provided, will create shared queries beneath a given folder. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WIQL** @@ -68,9 +98,16 @@ If provided, create a shared query with a given WIQL. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryType** @@ -83,9 +120,19 @@ Valid Values: * Flat * OneHop * Tree -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryRecursiveOption** @@ -97,9 +144,19 @@ Valid Values: * childFirst * parentFirst -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FolderName** @@ -107,9 +164,16 @@ If provided, create a shared query folder. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ParentID** @@ -117,9 +181,16 @@ The work item ParentID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Organization** @@ -127,9 +198,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -137,9 +215,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Relationship** @@ -147,9 +232,16 @@ A collection of relationships for the work item. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Comment** @@ -157,9 +249,16 @@ A list of comments to be added to the work item. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tag** @@ -167,9 +266,16 @@ A list of tags to assign to the work item. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BypassRule** @@ -177,9 +283,16 @@ If set, will not validate rules. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ValidateOnly** @@ -187,9 +300,16 @@ If set, will only validate rules, but will not update the work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SupressNotification** @@ -197,9 +317,16 @@ If set, will only validate rules, but will not update the work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -208,9 +335,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -220,9 +354,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -238,7 +379,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.WorkItem +* PSDevOps.WorkItem + + --- @@ -253,5 +396,3 @@ New-ADOWorkItem -QueryName [-QueryPath ] -WIQL [-Query New-ADOWorkItem [-QueryPath ] -FolderName -Organization -Project [-Tag ] [-ValidateOnly] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOWorkItemType.md b/docs/New-ADOWorkItemType.md index 4583aa72..83c19554 100644 --- a/docs/New-ADOWorkItemType.md +++ b/docs/New-ADOWorkItemType.md @@ -1,4 +1,3 @@ - New-ADOWorkItemType ------------------- ### Synopsis @@ -14,7 +13,13 @@ Also creates custom rules or states for a work item type. --- ### Related Links * [Get-ADOWorkItemType](Get-ADOWorkItemType.md) + + + * [Remove-ADOWorkItemType](Remove-ADOWorkItemType.md) + + + --- ### Examples #### EXAMPLE 1 @@ -41,9 +46,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -51,9 +63,16 @@ The process identifier. This can be piped in from Get-ADOWorkProcess. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -61,9 +80,16 @@ The name of the custom work item type, custom work item type state, custom work -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Icon** @@ -72,9 +98,16 @@ To list available icons, use Get-ADOWorkItemType -Icon -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Color** @@ -82,9 +115,16 @@ The color of the work item type or state. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -92,9 +132,16 @@ The description for the custom work item type. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **InheritsFrom** @@ -102,9 +149,16 @@ The work item type the custom work item should inherit, or the backlog behavior -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsDisabled** @@ -112,9 +166,16 @@ If set, will create the work item type disabled. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BehaviorID** @@ -122,9 +183,16 @@ If set, will associate a given work item type with a behavior (for instance, add -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsDefault** @@ -132,9 +200,16 @@ If set, will make the given work item type the default within a particular behav -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Behavior** @@ -142,9 +217,16 @@ If set, will create a new state for a custom work item instead of a custom work -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ReferenceName** @@ -152,9 +234,16 @@ The Reference Name of a WorkItemType. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **State** @@ -162,9 +251,16 @@ If set, will create a new state for a custom work item instead of a custom work -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|true |named |false | +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Order** @@ -172,9 +268,16 @@ The order of the a custom state for a custom work item. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **StateCategory** @@ -189,9 +292,19 @@ Valid Values: * Resolved * Completed * Removed -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **RuleConditionType** @@ -211,9 +324,19 @@ Valid Values: * whenValueIsNotDefined * whenWas * whenWorkItemIsCreated -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Field** @@ -221,9 +344,16 @@ The field for a given rule condition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Value** @@ -231,9 +361,16 @@ The value of a given rule condition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RuleActionType** @@ -256,9 +393,19 @@ Valid Values: * setDefaultFromField * setDefaultValue * setValueToEmpty -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TargetField** @@ -266,9 +413,16 @@ The target field for a given rule action. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TargetValue** @@ -276,9 +430,16 @@ The target value for a given rule action. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -287,9 +448,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -299,9 +467,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -317,16 +492,18 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.WorkItemType +* PSDevOps.WorkItemType -PSDevOps.Rule +* PSDevOps.Rule -PSDevOps.State +* PSDevOps.State + + +* PSDevOps.Behavior -PSDevOps.Behavior --- @@ -347,5 +524,3 @@ New-ADOWorkItemType -Organization -ProcessID [-Name] New-ADOWorkItemType -Organization -ProcessID [-Name] -ReferenceName -RuleConditionType [-Field ] [-Value ] -RuleActionType [-TargetField ] [-TargetValue ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-ADOWorkProcess.md b/docs/New-ADOWorkProcess.md index 80155b6c..5d62dd12 100644 --- a/docs/New-ADOWorkProcess.md +++ b/docs/New-ADOWorkProcess.md @@ -1,4 +1,3 @@ - New-ADOWorkProcess ------------------ ### Synopsis @@ -19,6 +18,9 @@ Can Provide: --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/create](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/create) + + + --- ### Examples #### EXAMPLE 1 @@ -43,9 +45,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -53,9 +62,16 @@ The name of the work process -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -63,9 +79,16 @@ A description of the work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ParentProcessID** @@ -73,9 +96,16 @@ The parent process identifier. If not provided, will default to the process ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReferenceName** @@ -83,9 +113,16 @@ A reference name for the work process. If one is not provided, Azure Devops wil -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -94,9 +131,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -106,9 +150,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -124,7 +175,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.WorkProcess +* PSDevOps.WorkProcess + + --- @@ -133,5 +186,3 @@ PSDevOps.WorkProcess New-ADOWorkProcess [-Organization] [-Name] [[-Description] ] [[-ParentProcessID] ] [[-ReferenceName] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/New-GitHubAction.md b/docs/New-GitHubAction.md index da4a708d..617b85fb 100644 --- a/docs/New-GitHubAction.md +++ b/docs/New-GitHubAction.md @@ -1,4 +1,3 @@ - New-GitHubAction ---------------- ### Synopsis @@ -9,9 +8,21 @@ Creates a new GitHub action --- ### Related Links * [New-GitHubWorkflow](New-GitHubWorkflow.md) + + + * [Import-BuildStep](Import-BuildStep.md) + + + * [Convert-BuildStep](Convert-BuildStep.md) + + + * [Expand-BuildStep](Expand-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +38,16 @@ The name of the action. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |1 |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **Description** @@ -37,9 +55,16 @@ A description of the action. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |1 |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **Action** @@ -48,9 +73,16 @@ While we don't want to restrict the steps here, we _do_ want to be able to sugge -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DockerImage** @@ -58,9 +90,16 @@ The DockerImage used for a GitHub Action. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NodeJSScript** @@ -68,9 +107,16 @@ The NodeJS main script used for a GitHub Action. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ActionInput** @@ -78,9 +124,16 @@ The git hub action inputs. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ActionOutput** @@ -88,9 +141,16 @@ The git hub action outputs. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Option** @@ -100,9 +160,16 @@ For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessTok -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |named |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ExcludeParameter** @@ -110,9 +177,16 @@ The name of parameters that should be excluded. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueParameter** @@ -122,9 +196,16 @@ The build parameter would be foo_bar. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultParameter** @@ -132,9 +213,16 @@ A collection of default parameters. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -142,9 +230,16 @@ If set, will output the created objects instead of creating YAML. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildScript** @@ -152,9 +247,16 @@ A list of build scripts. Each build script will run as a step in the action. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Icon** @@ -162,9 +264,16 @@ The icon used for branding. By default, a terminal icon. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Color** @@ -182,19 +291,46 @@ Valid Values: * red * purple * gray-dark -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + +--- +#### **OutputPath** + +If provided, will output to a given path and return a file. + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- ### Syntax ```PowerShell -New-GitHubAction [-Name] [-Description] [-Action ] [-DockerImage ] [-NodeJSScript ] [-ActionInput ] [-ActionOutput ] [-Option ] [-ExcludeParameter ] [-UniqueParameter ] [-DefaultParameter ] [-PassThru] [-BuildScript ] [-Icon ] [-Color ] [] +New-GitHubAction [-Name] [-Description] [-Action ] [-DockerImage ] [-NodeJSScript ] [-ActionInput ] [-ActionOutput ] [-Option ] [-ExcludeParameter ] [-UniqueParameter ] [-DefaultParameter ] [-PassThru] [-BuildScript ] [-Icon ] [-Color ] [-OutputPath ] [] ``` --- - - diff --git a/docs/New-GitHubWorkflow.md b/docs/New-GitHubWorkflow.md index 3ce57427..58b3b9f3 100644 --- a/docs/New-GitHubWorkflow.md +++ b/docs/New-GitHubWorkflow.md @@ -1,4 +1,3 @@ - New-GitHubWorkflow ------------------ ### Synopsis @@ -9,6 +8,9 @@ Creates a new GitHub Workflow --- ### Related Links * [Import-BuildStep](Import-BuildStep.md) + + + --- ### Examples #### EXAMPLE 1 @@ -24,9 +26,16 @@ The input object. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|false |1 |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByValue) + + + --- #### **Name** @@ -34,9 +43,16 @@ The name of the workflow. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |2 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Option** @@ -46,9 +62,16 @@ For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessTok -|Type |Requried|Postion|PipelineInput| -|-------------------|--------|-------|-------------| -|```[IDictionary]```|false |3 |false | +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **Environment** @@ -56,9 +79,16 @@ A collection of environment variables used throughout the build. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |4 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **InputParameter** @@ -67,9 +97,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |5 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **VariableParameter** @@ -78,9 +115,16 @@ Wildcards accepted. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExcludeParameter** @@ -88,9 +132,16 @@ The name of parameters that should be excluded. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |7 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueParameter** @@ -100,9 +151,16 @@ The build parameter would be foo_bar. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultParameter** @@ -110,9 +168,16 @@ A collection of default parameters. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |9 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -120,9 +185,16 @@ If set, will output the created objects instead of creating YAML. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildScript** @@ -130,25 +202,60 @@ A list of build scripts. Each build script will run as a step in the same job. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |10 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:false + + + --- #### **RootDirectory** -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |11 |false | +If provided, will directly reference build steps beneath this directory. + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:false + + + +--- +#### **OutputPath** + +If provided, will output to a given path and return a file. + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- ### Syntax ```PowerShell -New-GitHubWorkflow [[-InputObject] ] [[-Name] ] [[-Option] ] [[-Environment] ] [[-InputParameter] ] [[-VariableParameter] ] [[-ExcludeParameter] ] [[-UniqueParameter] ] [[-DefaultParameter] ] [-PassThru] [[-BuildScript] ] [[-RootDirectory] ] [] +New-GitHubWorkflow [[-InputObject] ] [[-Name] ] [[-Option] ] [[-Environment] ] [[-InputParameter] ] [[-VariableParameter] ] [[-ExcludeParameter] ] [[-UniqueParameter] ] [[-DefaultParameter] ] [-PassThru] [[-BuildScript] ] [[-RootDirectory] ] [[-OutputPath] ] [] ``` --- - - diff --git a/docs/Push-Git.md b/docs/Push-Git.md index dc5a93c9..8dd72c9f 100644 --- a/docs/Push-Git.md +++ b/docs/Push-Git.md @@ -1,4 +1,3 @@ - Push-Git -------- ### Synopsis @@ -12,7 +11,13 @@ Pushes changes to a git repository. --- ### Related Links * [Add-Git](Add-Git.md) + + + * [Submit-Git](Submit-Git.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The argument. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReferenceSpec** @@ -69,9 +81,16 @@ the remote side is updated if a branch of the same name already exists on the re -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **All** @@ -79,9 +98,16 @@ Push all branches (i.e. refs under refs/heads/); cannot be used with other **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Prune** @@ -95,9 +121,16 @@ would make sure that remote refs/tmp/foo will be removed if refs/heads/foo doesn -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Mirror** @@ -114,9 +147,16 @@ This is the default if the configuration option remote..mirror is set. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DryRun** @@ -124,9 +164,16 @@ Do everything except actually send the updates. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Porcelain** @@ -136,9 +183,16 @@ The full symbolic names of the refs will be given. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Delete** @@ -147,9 +201,16 @@ This is the same as prefixing all refs with a colon. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tag** @@ -157,9 +218,16 @@ All refs under refs/tags are pushed, in addition to refspecs explicitly listed o -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FollowTag** @@ -173,9 +241,16 @@ For more information, see push.followTags in git-config(1). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Atomic** @@ -184,9 +259,16 @@ If the server does not support atomic pushes the push will fail. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PushOption** @@ -202,9 +284,16 @@ the values of configuration variable push.pushOption are used instead. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReceivePack** @@ -214,9 +303,16 @@ and you do not have the program in a directory on the default $PATH. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -237,9 +333,16 @@ See the ... section above for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SetUpstream** @@ -249,9 +352,16 @@ For more information, see branch..merge in git-config(1) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Unsigned** @@ -259,9 +369,16 @@ If set, no signing will be attempted. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Signed** @@ -280,9 +397,19 @@ Valid Values: * true * false * if-asked -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ForceWithLease** @@ -290,9 +417,16 @@ See git help push -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoVerify** @@ -302,9 +436,16 @@ With --no-verify, the hook is bypassed completely. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -320,7 +461,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -329,5 +472,3 @@ System.String Push-Git [[-Repository] ] [[-ReferenceSpec] ] [-All] [-Prune] [-Mirror] [-DryRun] [-Porcelain] [-Delete] [-Tag] [-FollowTag] [-Atomic] [-PushOption ] [-ReceivePack ] [-Force] [-SetUpstream] [-Unsigned] [-Signed ] [-ForceWithLease ] [-NoVerify] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..81b41ef1 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,275 @@ +
+ +
+ +PowerShell Tools for DevOps +--------------------------- +[![Build Status](https://dev.azure.com/StartAutomating/PSDevOps/_apis/build/status/StartAutomating.PSDevOps?branchName=master)](https://dev.azure.com/StartAutomating/PSDevOps/_build/latest?definitionId=5) +[![Build Status](https://github.com/StartAutomating/Irregular/actions/workflows/IrregularTests.yml/badge.svg)](https://github.com/StartAutomating/PSDevOps/actions/workflows/TestAndPublish.yml) +--------------------------- + +__PSDevOps helps you automate DevOps using PowerShell.__ + +### What is PSDevOps? + +PSDevOps is a PowerShell module that makes it easier to automate DevOps with PowerShell. + +* [Automate Azure DevOps](#Automate-Azure-DevOps) +* [Creating Complex Pipelines](#Creating-Complex-Pipelines) +* [Dealing with DevOps](#Dealing-with-DevOps) +* [Get the GitHub API](#PSDevOps-GitHub-API) +* [Write GitHub Actions](#Write-GitHub-Actions) +* [Write GitHub Workflows](#Write-GitHub-Workflows) + +#### What do you mean 'Easier to Automate'? + +If you're familiar with PowerShell, you might know about the Object Pipeline. +This allows you to pass objects together, instead of parsing text at each step. +While this is great, not many PowerShell commands or REST apis take full advantage of this feature. + +PSDevOps does. + +Almost every command in PSDevOps is pipeline-aware. +Related commands can often be piped together, and command results can often be piped back into a command to return additional information. + +Additionally, PSDevOps output is often 'decorated' with extended type information. + +This allows the PowerShell types and formatting engine to extend the return object and customize it's display. + +### Automate Azure DevOps + +The Azure DevOps REST API can be challenging to work with, and hard to remember. + +PSDevOps provides dozens of commands to automate Azure DevOps. + +Commands are named simply and clearly, using PowerShell's verb-noun convention, for example, Get-ADOProject, Get-ADORepository, Get-ADOBuild + +To see all commands from PSDevOps, run: + +~~~PowerShell +Get-Command -Module PSDevOps +~~~ + +Unlike many modules, these commands make use of the full feature set of PowerShell. +Here are a few things PSDevOps does differently: + +#### Using the Object Pipeline + +The Object Pipeline is a core feature of PowerShell that allows you to send structured information from step to step. + +Almost every function in PSDevOps is "pipeline aware", and can accept multiple types of objects + +~~~PowerShell +Connect-ADO -Organization $MyOrganization -PersonalAccessToken $MyPat +Get-ADOProject | Get-ADOTeam | Get-ADODashboard +~~~ + +Many commands can be piped back into themselves to return additional results, for instance: + +~~~PowerShell +Get-ADOBuild -Project MyProject -First 5 | # Get the first 5 builds + Get-ADOBuild -ChangeSet # Get the associated changesets. +~~~ + +~~~PowerShell +Get-ADOAgentPool | # Gets agent pools from the organization + Get-ADOAgentPool # Gets individual agents within a pool, because the prior object returned a PoolID. +~~~ + + +#### Invoke-ADORESTApi + +In orer to ensure that you can always work with Azure DevOps, even if there isn't already a function in PSDevOps, there's Invoke-ADORestAPI. + +Invoke-ADORestAPI can be used like Invoke-RESTMethod, and also has a number of additional features. + +For instance: + +* -AsJob (Launch long-running queries as a job) +* -Body (autoconverted to JSON) +* -ExpandProperty (Expand out a particular property from output) +* -PSTypeName (apply decoration to output) +* -UrlParameter (Replace parameters within a URL) +* -QueryParameter (Pass parameters within a querystring) + +#### Help + +Like any good PowerShell module, PSDevOps has help. Run Get-Help on any command to learn more about how to use it. + +~~~PowerShell +Get-Help Get-ADOBuild -Full +~~~ + +Commands that wrap the REST api should have a .LINK to the MSDN documentation on the API to help you understand what they are doing. + +#### Custom Formatting + +The Azure DevOps REST API can return a lot of unhelpful information. +To make it easier to work with Azure DevOps in Powershell, PSDevOps includes several custom formatters. + +For a simple example, try running one of the following commands: + +~~~PowerShell +Get-ADOProject +~~~ + +~~~PowerShell +Get-ADOTeam -Mine +~~~ + +#### Extended Types + +The Azure DevOps REST api often returns data that is inconsistently named or weakly typed. + +Where possible, PSDevOps uses the Extended Type System in PowerShell to augment the values returned from Azure DevOps. + +For example, when you run Get-ADOAgentPool, it will add two properties to the return value: +PoolID (an alias to ID) and DateCreated (which converts the string date in .CreatedOn to a [DateTime]). + + +#### Supporting -WhatIf and -Confirm + +Most commands in PSDevOps that change system state SupportShouldProcess, and have the automatic parameters -WhatIf and -Confirm. + +-Confirm works the same in PSDevOps as it does in any PowerShell module. Passing -Confirm will always prompt for confirmation, and Passing -Confirm:$false will never prompt for confirmation. + +PSDevOps does a bit better than most modules when it comes to supporting -WhatIf. In most modules, -WhatIf will write a message to the host about what might have run. In PSDevOps, passing -WhatIf should return the values about to be passed to the REST API. + +~~~PowerShell +New-ADOProject -Name Foo -Description bar -Confirm # Prompts for confirmation + +New-ADOProject -Name Foo -Description bar -WhatIf # Returns the data that would be passed to the REST endpoint. +~~~ + +### Creating Complex Pipelines + +While Azure DevOps templates are nice, they don't give you syntax highlighting for the scripts of each step. +Also, cross-repository templates can be painful. + +PSDevOps allows you to create Azure DevOps pipelines using New-ADOPipeline. + +For instance, this create a cross-platform test of the current repository's PowerShell module. + +~~~PowerShell +New-ADOPipeline -Job TestPowerShellOnLinux, TestPowerShellOnMac, TestPowerShellOnWindows +~~~ + +This creates a multistage pipeline that does PowerShell static analysis, tests the current module (crosssplatform), +and updates the PowerShell gallery using a Secret: + +~~~PowerShell +New-ADOPipeline -Stage PowerShellStaticAnalysis, TestPowerShellCrossPlatform, UpdatePowerShellGallery +~~~ + +This little one liner works wonderfully to build a CI/CD pipeline in Azure DevOps around almost any PowerShell modules. + +Parts are stored in a \ado\PartName\ as either a .ps1 or a .psd1 file. +PS1 files will implicitly become script tasks. +PSD1 files will be treated as task metadata, and can reference other parts. + +Any module that contains an \ADO directory and is tagged 'PSDevOps' or requires PSDevOps can contain parts. +Parts found in these modules will override parts found in PSDevOps. + +#### Advanced Azure DevOps Pipeline Logging + +PSDevOps can also be used to help you write information to the a pipeline's timeline. This can be considerably easier than memorizing the [Logging Commands Documentation](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands). + +PSDevOps makes this much nicer by abstracting away this ugliness into easy-to-use commands: + +* Add-ADOAttachment +* Set-ADOBuild +* Set-ADOEndpoint +* Set-ADOVariable +* Write-ADOError +* Write-ADOProgress +* Write-ADOWarning + + +### Dealing with DevOps + + +DevOps is a hybrid discipline combining the skillset of Devolopers and Operations. +With DevOps, the focus is on automation, and PowerShell is often the language of choice. + +By convention, most developers write their scripts according to a psuedostandard: + +> ```*-*.ps1``` Scripts containing a function +> ```*.*.ps1``` 'Special' Scripts, often used by particular modules +> ```*.ps1``` Simple scripts that are run interactively. + + +PSDevOps has a command, Get-PSDevOps, that helps to identify these scripts and their requirements. + +~~~PowerShell +Get-Module PSDevOps | Get-PSDevOps +~~~ + + +### PSDevOps GitHub API + +PSDevOps also provides a few functions to work with the GitHub API. + +* Connect/Disconnect-GitHub +* Invoke-GitHubRESTAPI + +Invoke-GitHubRESTAPI works like Invoke-ADORestAPI, as a general-purpose wrapper for GitHub REST API calls. + +It also has a number of additional features, for example: + +* -AsJob (Launch long-running queries as a job) +* -Body (autoconverted to JSON) +* -ExpandProperty (Expand out a particular property from output) +* -PSTypeName (apply decoration to output) +* -UrlParameter (Replace parameters within a URL) +* -QueryParameter (Pass parameters within a querystring) + +Because GitHub's REST api is predictable and exposed with OpenAPI, Invoke-GitHubRESTAPI also enables two very interesting scenarios: + +1. Connect-GitHub can automatically create a shortcut for every endpoint in the GitHub API +2. Invoke-GitHubRESTAPI can automatically decorate return values more apporopriately. + +This means that PSDevOps can integrate with GitHub's REST API with a very small amount of code, and easily customize how GitHub output displays and works in PowerShell. + +### Write GitHub Actions + +You can automatically generate GitHub actions off of any PowerShell script or command. + +First, create a /GitHub/Actions folder in your module directory, then put one or more .ps1 files in it. + +Then, +~~~PowerShell +Import-BuildStep -ModuleName YourModule +~~~ + +Then, you can generate your action.yml with some code like this. + +~~~PowerShell +New-GitHubAction -Name "Name Of Action" -Description 'Action Description' -Action MyAction -Icon minimize -ActionOutput ([Ordered]@{ + SomeOutput = [Ordered]@{ + description = "Some Output" + value = '${{steps.MyAction.outputs.SomeOutput}}' + } +}) +~~~ + +### Write GitHub Workflows + +You can use PSDevOps to write complex Github Workflows using the same techniques as Azure DevOps pipelines: + +~~~PowerShell +New-GitHubWorkflow -Name RunPester -On Demand, Push, PullRequest -Job TestPowerShellOnLinux +~~~ + +As with Azure DevOps, parts of the workflow can be defined within the \GitHub subdirectory of PSDevOps or any module. + +#### Advanced GitHub Workflow Logging + +PSDevOps also includes commands to make logging within a GitHub workflow easier. They are: + +* Hide-GitHubOutput +* Write-GitHubDebug +* Write-GitHubError +* Write-GitHubOutput +* Write-GitHubWarning + + diff --git a/docs/Register-ADOArtifactFeed.md b/docs/Register-ADOArtifactFeed.md index 27498980..459976db 100644 --- a/docs/Register-ADOArtifactFeed.md +++ b/docs/Register-ADOArtifactFeed.md @@ -1,4 +1,3 @@ - Register-ADOArtifactFeed ------------------------ ### Synopsis @@ -13,11 +12,29 @@ thThis allows Install-Module, Publish-Module, and Save-Module to work against an --- ### Related Links * [https://docs.microsoft.com/en-us/azure/devops/artifacts/tutorials/private-powershell-library?view=azure-devops](https://docs.microsoft.com/en-us/azure/devops/artifacts/tutorials/private-powershell-library?view=azure-devops) + + + * [Get-ADOArtifactFeed](Get-ADOArtifactFeed.md) + + + * [Unregister-ADOArtifactFeed](Unregister-ADOArtifactFeed.md) + + + * [Get-PSRepository](Get-PSRepository.md) + + + * [Register-PSRepository](Register-PSRepository.md) + + + * [Unregister-PSRepository](Unregister-PSRepository.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +50,16 @@ The name of the organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -43,9 +67,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -53,9 +84,16 @@ The name or ID of the feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PersonalAccessToken** @@ -63,9 +101,16 @@ The personal access token used to connect to the feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EmailAddress** @@ -73,9 +118,16 @@ The email address used to connect -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryName** @@ -84,9 +136,16 @@ By default, the RepositoryName will be $Organization-$Project-$Name -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryUrl** @@ -95,9 +154,16 @@ By default, the RepositoryURL is predicted using -Organization, -Project, and -N -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |7 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -105,12 +171,21 @@ If set, will remove the connection to an existing feed and then create a new one -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -Microsoft.PowerShell.Commands.PSRepository +* Microsoft.PowerShell.Commands.PSRepository + + --- @@ -119,5 +194,3 @@ Microsoft.PowerShell.Commands.PSRepository Register-ADOArtifactFeed [-Organization] [[-Project] ] [-Name] [[-PersonalAccessToken] ] [[-EmailAddress] ] [[-RepositoryName] ] [[-RepositoryUrl] ] [-Force] [] ``` --- - - diff --git a/docs/Remove-ADOAgentPool.md b/docs/Remove-ADOAgentPool.md index fc981f4d..58b9a9a4 100644 --- a/docs/Remove-ADOAgentPool.md +++ b/docs/Remove-ADOAgentPool.md @@ -1,4 +1,3 @@ - Remove-ADOAgentPool ------------------- ### Synopsis @@ -12,6 +11,9 @@ Removes pools from Azure DevOps or TFS --- ### Related Links * [Get-ADOAgentPool](Get-ADOAgentPool.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +30,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PoolID** @@ -38,9 +47,16 @@ The Pool Identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AgentID** @@ -48,9 +64,16 @@ The Agent Identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +82,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +101,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,10 +126,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -104,5 +143,3 @@ Remove-ADOAgentPool -Organization -PoolID -AgentID [- Remove-ADOAgentPool -Organization -PoolID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOAreaPath.md b/docs/Remove-ADOAreaPath.md index ba3417fc..5a5d0302 100644 --- a/docs/Remove-ADOAreaPath.md +++ b/docs/Remove-ADOAreaPath.md @@ -1,4 +1,3 @@ - Remove-ADOAreaPath ------------------ ### Synopsis @@ -12,7 +11,13 @@ Removes an Azure DevOps AreaPath. AreaPaths are used to logically group work it --- ### Related Links * [Add-ADOAreaPath](Add-ADOAreaPath.md) + + + * [Get-ADOAreaPath](Get-ADOAreaPath.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -48,9 +67,16 @@ The AreaPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,10 +129,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -101,5 +143,3 @@ System.Management.Automation.PSObject Remove-ADOAreaPath [-Organization] [-Project] [-AreaPath] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOArtifactFeed.md b/docs/Remove-ADOArtifactFeed.md index 74917a20..78993476 100644 --- a/docs/Remove-ADOArtifactFeed.md +++ b/docs/Remove-ADOArtifactFeed.md @@ -1,4 +1,3 @@ - Remove-ADOArtifactFeed ---------------------- ### Synopsis @@ -12,6 +11,9 @@ Removes artifact feeds from Azure DevOps. Artifact feeds are used to publish pa --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/artifacts/feed%20%20management/create%20feed?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +30,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +47,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedID** @@ -49,9 +65,16 @@ The Feed Name or ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ViewID** @@ -60,9 +83,16 @@ The View Name or ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **View** @@ -70,9 +100,16 @@ If set, will remove a view. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -80,9 +117,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -90,9 +134,16 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -108,10 +159,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -123,5 +176,3 @@ Remove-ADOArtifactFeed -Organization [-Project ] -FeedID [-Project ] -FeedID [-ViewID ] -View [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOBuild.md b/docs/Remove-ADOBuild.md index 3c2a4454..435a242f 100644 --- a/docs/Remove-ADOBuild.md +++ b/docs/Remove-ADOBuild.md @@ -1,4 +1,3 @@ - Remove-ADOBuild --------------- ### Synopsis @@ -12,8 +11,17 @@ Removes builds and build definitions from Azure DevOps. --- ### Related Links * [Get-ADOBuild](Get-ADOBuild.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/delete?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/delete?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/delete?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/delete?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -31,9 +39,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -41,9 +56,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -51,9 +73,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -61,9 +90,16 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildID** @@ -71,9 +107,16 @@ The Build ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -81,9 +124,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -99,10 +149,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -114,5 +166,3 @@ Remove-ADOBuild -Organization -Project [-Server ] [-ApiVe Remove-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -DefinitionID [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADODashboard.md b/docs/Remove-ADODashboard.md index 6cc64260..6cf169c0 100644 --- a/docs/Remove-ADODashboard.md +++ b/docs/Remove-ADODashboard.md @@ -1,4 +1,3 @@ - Remove-ADODashboard ------------------- ### Synopsis @@ -12,6 +11,9 @@ Removes Dashboards from Azure DevOps, or Removes Widgets from a Dashboard in Azu --- ### Related Links * [Get-ADODashboard](Get-ADODashboard.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -42,9 +51,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -52,9 +68,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DashboardID** @@ -62,9 +85,16 @@ The DashboardID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WidgetID** @@ -72,9 +102,16 @@ The WidgetID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -83,9 +120,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -95,9 +139,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -113,10 +164,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -System.Collections.Hashtable --- @@ -128,5 +181,3 @@ Remove-ADODashboard -Organization -Project [-Team ] -D Remove-ADODashboard -Organization -Project [-Team ] -DashboardID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOField.md b/docs/Remove-ADOField.md index a541680e..8d7dae31 100644 --- a/docs/Remove-ADOField.md +++ b/docs/Remove-ADOField.md @@ -1,4 +1,3 @@ - Remove-ADOField --------------- ### Synopsis @@ -12,8 +11,17 @@ Removes fields in Azure DevOps or Team Foundation Server. --- ### Related Links * [Get-ADOField](Get-ADOField.md) + + + * [New-ADOField](New-ADOField.md) + + + * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +42,16 @@ The name or reference name of the field -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Organization** @@ -44,9 +59,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -54,9 +76,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -65,9 +94,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -77,9 +113,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -95,10 +138,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -107,5 +152,3 @@ System.Collections.IDictionary Remove-ADOField [-Name] [-Organization] [[-Project] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOIterationPath.md b/docs/Remove-ADOIterationPath.md index 4c70032f..0d072516 100644 --- a/docs/Remove-ADOIterationPath.md +++ b/docs/Remove-ADOIterationPath.md @@ -1,4 +1,3 @@ - Remove-ADOIterationPath ----------------------- ### Synopsis @@ -12,7 +11,13 @@ Removes an Azure DevOps IterationPath. IterationPaths are used to logically gro --- ### Related Links * [Add-ADOIterationPath](Add-ADOIterationPath.md) + + + * [Get-ADOIterationPath](Get-ADOIterationPath.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -48,9 +67,16 @@ The IterationPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,10 +129,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -101,5 +143,3 @@ System.Management.Automation.PSObject Remove-ADOIterationPath [-Organization] [-Project] [-IterationPath] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOPermission.md b/docs/Remove-ADOPermission.md index 83ea92a3..cc7c9e22 100644 --- a/docs/Remove-ADOPermission.md +++ b/docs/Remove-ADOPermission.md @@ -1,4 +1,3 @@ - Remove-ADOPermission -------------------- ### Synopsis @@ -12,7 +11,13 @@ Removes Azure DevOps security permissions. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20entries/set%20access%20control%20entries](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20entries/set%20access%20control%20entries) + + + * [https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference](https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -39,9 +51,16 @@ If this is provided without anything else, will get permissions for the projectI -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TeamID** @@ -49,9 +68,16 @@ If provided, will set permissions related to a given teamID. ( see Get-ADOTeam) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -59,9 +85,16 @@ If provided, will set permissions related to an Area Path. ( see Get-ADOAreaPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -69,9 +102,16 @@ If provided, will set permissions related to an Iteration Path. ( see Get-ADOIte -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -79,9 +119,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPath** @@ -89,9 +136,16 @@ The path to the build. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPermission** @@ -99,9 +153,16 @@ If set, will set build and release permissions for a given project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectRepository** @@ -109,9 +170,16 @@ If set, will set permissions for repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -119,9 +187,16 @@ If provided, will set permissions for a given repositoryID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BranchName** @@ -129,9 +204,16 @@ If provided, will set permissions for a given branch within a repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllRepository** @@ -139,9 +221,16 @@ If set, will set permissions for all repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tagging** @@ -149,9 +238,16 @@ If set, will set permissions for tagging related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ManageTFVC** @@ -159,9 +255,16 @@ If set, will set permissions for Team Foundation Version Control related to the -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Plan** @@ -169,9 +272,16 @@ If set, will set permissions for Delivery Plans. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Dashboard** @@ -179,9 +289,16 @@ If set, will set dashboard permissions related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -189,9 +306,16 @@ If set, will set endpoint permissions related to a particular endpoint. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NamespaceID** @@ -199,9 +323,16 @@ The Security Namespace ID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SecurityToken** @@ -209,9 +340,16 @@ The Security Token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Descriptor** @@ -219,9 +357,16 @@ One or more descriptors -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Identity** @@ -229,9 +374,16 @@ One or more identities. Identities will be converted into descriptors. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Permission** @@ -239,9 +391,16 @@ One or more allow permissions. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -250,9 +409,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -262,9 +428,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -280,10 +453,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.SecurityNamespace +* PSDevOps.SecurityNamespace + + +* PSDevOps.AccessControlList -PSDevOps.AccessControlList --- @@ -334,5 +509,3 @@ Remove-ADOPermission -Organization -Plan [-Identity ] [-Permi Remove-ADOPermission -Organization -NamespaceID -SecurityToken [-Descriptor ] [-Identity ] [-Permission ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOPicklist.md b/docs/Remove-ADOPicklist.md index cd9c8b7c..200a5ec6 100644 --- a/docs/Remove-ADOPicklist.md +++ b/docs/Remove-ADOPicklist.md @@ -1,4 +1,3 @@ - Remove-ADOPicklist ------------------ ### Synopsis @@ -12,7 +11,13 @@ Removes Picklists from Azure DevOps, or Removes Widgets from a Picklist in Azure --- ### Related Links * [Get-ADOPicklist](Get-ADOPicklist.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/delete](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/delete) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistID** @@ -38,9 +50,16 @@ The PicklistID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Item** @@ -50,9 +69,16 @@ If this parameter is not provided, the picklist will not be deleted. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |named |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Server** @@ -61,9 +87,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -73,9 +106,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -91,10 +131,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -System.Collections.Hashtable --- @@ -103,5 +145,3 @@ System.Collections.Hashtable Remove-ADOPicklist -Organization -PicklistID [-Item ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOProject.md b/docs/Remove-ADOProject.md index fc097deb..7c4212d1 100644 --- a/docs/Remove-ADOProject.md +++ b/docs/Remove-ADOProject.md @@ -1,4 +1,3 @@ - Remove-ADOProject ----------------- ### Synopsis @@ -12,6 +11,9 @@ Removes projects in Azure DevOps or TFS. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/states/delete](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/states/delete) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The ID of the project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Organization** @@ -37,9 +46,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -48,9 +64,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -60,9 +83,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |4 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -78,10 +108,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -90,5 +122,3 @@ System.Management.Automation.PSObject Remove-ADOProject [-ProjectID] [-Organization] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADORepository.md b/docs/Remove-ADORepository.md index 6dae0593..91279081 100644 --- a/docs/Remove-ADORepository.md +++ b/docs/Remove-ADORepository.md @@ -1,4 +1,3 @@ - Remove-ADORepository -------------------- ### Synopsis @@ -12,6 +11,9 @@ Removes repositories from Azure DevOps. --- ### Related Links * [Get-ADORepository](Get-ADORepository.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -37,9 +46,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -47,9 +63,16 @@ The name or ID of the repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -58,9 +81,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -70,9 +100,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -88,10 +125,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -System.Collections.Hashtable --- @@ -100,5 +139,3 @@ System.Collections.Hashtable Remove-ADORepository [-Organization] [-Project] [-RepositoryID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOServiceEndpoint.md b/docs/Remove-ADOServiceEndpoint.md index 8c35df01..8299b6d0 100644 --- a/docs/Remove-ADOServiceEndpoint.md +++ b/docs/Remove-ADOServiceEndpoint.md @@ -1,4 +1,3 @@ - Remove-ADOServiceEndpoint ------------------------- ### Synopsis @@ -13,7 +12,13 @@ Service Endpoints allow you to connect an Azure DevOps project with to one or mo --- ### Related Links * [Get-ADOServiceEndpoint](Get-ADOServiceEndpoint.md) + + + * [New-ADOServiceEndpoint](New-ADOServiceEndpoint.md) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +35,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -40,9 +52,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -50,9 +69,16 @@ The Endpoint ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -61,9 +87,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -73,9 +106,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -91,10 +131,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -System.Collections.Hashtable --- @@ -103,5 +145,3 @@ System.Collections.Hashtable Remove-ADOServiceEndpoint [-Organization] [-Project] [-EndpointID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOTeam.md b/docs/Remove-ADOTeam.md index 491baf69..f16d9d4e 100644 --- a/docs/Remove-ADOTeam.md +++ b/docs/Remove-ADOTeam.md @@ -1,4 +1,3 @@ - Remove-ADOTeam -------------- ### Synopsis @@ -12,7 +11,13 @@ Removes teams from Azure DevOps or TFS --- ### Related Links * [New-ADOTeam](New-ADOTeam.md) + + + * [Get-ADOTeam](Get-ADOTeam.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The project name or identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TeamID** @@ -48,9 +67,16 @@ The Team Identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -71,9 +104,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -89,10 +129,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -101,5 +143,3 @@ System.Collections.IDictionary Remove-ADOTeam -Organization -Project -TeamID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOWiki.md b/docs/Remove-ADOWiki.md index 0c84ebb5..6227d920 100644 --- a/docs/Remove-ADOWiki.md +++ b/docs/Remove-ADOWiki.md @@ -1,4 +1,3 @@ - Remove-ADOWiki -------------- ### Synopsis @@ -12,8 +11,17 @@ Removes Azure DevOps Wikis from a project. --- ### Related Links * [Add-ADOWiki](Add-ADOWiki.md) + + + * [Get-ADOWiki](Get-ADOWiki.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/delete](https://docs.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/delete) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +37,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -39,9 +54,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WikiID** @@ -49,9 +71,16 @@ The WikiID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -59,9 +88,16 @@ The RepositoryID. If this is the same as the WikiID, it is a ProjectWiki, and t -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -70,9 +106,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -82,9 +125,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |6 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -100,10 +150,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -System.Collections.Hashtable --- @@ -112,5 +164,3 @@ System.Collections.Hashtable Remove-ADOWiki [-Organization] [-Project] [-WikiID] [[-RepositoryID] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOWorkItem.md b/docs/Remove-ADOWorkItem.md index cad23f88..d3c49fbb 100644 --- a/docs/Remove-ADOWorkItem.md +++ b/docs/Remove-ADOWorkItem.md @@ -1,4 +1,3 @@ - Remove-ADOWorkItem ------------------ ### Synopsis @@ -12,7 +11,13 @@ Remove work item from Azure DevOps or Team Foundation Server. --- ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/delete?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/delete?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +38,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -43,9 +55,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -53,9 +72,16 @@ The Work Item ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Query** @@ -63,9 +89,16 @@ A query -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **QueryID** @@ -73,9 +106,16 @@ If set, will return work item shared queries -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -84,9 +124,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -96,9 +143,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -114,10 +168,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) -System.Collections.IDictionary --- @@ -132,5 +188,3 @@ Remove-ADOWorkItem -Organization -Project -Query [-Se Remove-ADOWorkItem -Organization -Project -QueryID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Remove-ADOWorkItemType.md b/docs/Remove-ADOWorkItemType.md index 00e299db..d1f55f44 100644 --- a/docs/Remove-ADOWorkItemType.md +++ b/docs/Remove-ADOWorkItemType.md @@ -1,4 +1,3 @@ - Remove-ADOWorkItemType ---------------------- ### Synopsis @@ -14,7 +13,13 @@ Also removes custom work item type states, rules, and behaviors. --- ### Related Links * [Get-ADOWorkItemType](Get-ADOWorkItemType.md) + + + * [New-ADOWorkItemType](New-ADOWorkItemType.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +37,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -42,9 +54,16 @@ The Process identifier. This work process must contain the custom work item typ -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WorkItemTypeName** @@ -52,9 +71,16 @@ The name of the custom work item type. Values with a property 'ReferenceName' w -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **StateID** @@ -62,9 +88,16 @@ The id of a custom work item state that will be removed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RuleID** @@ -72,9 +105,16 @@ The id of a custom work item rule that will be removed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BehaviorID** @@ -82,9 +122,16 @@ The id of a custom work item behavior that will be removed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -93,9 +140,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -105,9 +159,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -123,7 +184,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + --- @@ -141,5 +204,3 @@ Remove-ADOWorkItemType -Organization -ProcessID [-WorkItemType Remove-ADOWorkItemType -Organization -ProcessID [-WorkItemTypeName] -StateID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOArtifactFeed.md b/docs/Set-ADOArtifactFeed.md index cd7bfb93..6a04115a 100644 --- a/docs/Set-ADOArtifactFeed.md +++ b/docs/Set-ADOArtifactFeed.md @@ -1,4 +1,3 @@ - Set-ADOArtifactFeed ------------------- ### Synopsis @@ -12,8 +11,17 @@ Changes the settings, permissions, views, and retention policies of an Azure Dev --- ### Related Links * [Get-ADOArtifactFeed](Get-ADOArtifactFeed.md) + + + * [New-ADOArtifactFeed](New-ADOArtifactFeed.md) + + + * [Remove-ADOArtifactFeed](Remove-ADOArtifactFeed.md) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +42,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -44,9 +59,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FeedID** @@ -54,9 +76,16 @@ The name or ID of the feed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -65,9 +94,16 @@ The Feed Name or View Name -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ShowDeletedPackageVersions** @@ -75,9 +111,16 @@ If set, the feed will not hide all deleted/unpublished versions -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllowConflictUpstream** @@ -85,9 +128,16 @@ If set, will allow package names to conflict with the names of packages upstream -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoBadge** @@ -95,9 +145,16 @@ If set, this feed will not support the generation of package badges. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublicUpstream** @@ -113,9 +170,19 @@ Valid Values: * PyPi * Maven * PowerShellGallery -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UpstreamSource** @@ -123,9 +190,16 @@ A property bag describing upstream sources -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -133,9 +207,16 @@ The feed description. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ViewID** @@ -144,9 +225,16 @@ The ViewID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ViewVisibility** @@ -159,9 +247,19 @@ Valid Values: * Collection * Organization * Private -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Permission** @@ -169,9 +267,16 @@ If set, will set artifact permissions. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|true |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RetentionPolicy** @@ -179,9 +284,16 @@ If set, will set artifact retention policies -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CountLimit** @@ -189,9 +301,16 @@ Maximum versions to preserve per package and package type. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |named |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DaysToKeep** @@ -199,9 +318,16 @@ Number of days to preserve a package version after its latest download. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |named |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -209,9 +335,16 @@ The server. By default https://feeds.dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -219,9 +352,16 @@ The api version. By default, 5.1-preview. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -237,13 +377,15 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.ArtifactFeed +* PSDevOps.ArtifactFeed -PSDevOps.ArtfiactFeed.RetentionPolicy +* PSDevOps.ArtfiactFeed.RetentionPolicy + + +* PSDevOps.ArtfiactFeed.View -PSDevOps.ArtfiactFeed.View --- @@ -264,5 +406,3 @@ Set-ADOArtifactFeed -Organization [-Project ] -FeedID Set-ADOArtifactFeed -Organization [-Project ] -FeedID -RetentionPolicy [-CountLimit ] [-DaysToKeep ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOBuild.md b/docs/Set-ADOBuild.md index 5242facc..e231e95d 100644 --- a/docs/Set-ADOBuild.md +++ b/docs/Set-ADOBuild.md @@ -1,4 +1,3 @@ - Set-ADOBuild ------------ ### Synopsis @@ -12,6 +11,9 @@ Sets the Azure DevOps Build information --- ### Related Links * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -42,9 +44,16 @@ A new build number (or identifier) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tag** @@ -52,9 +61,16 @@ One or more tags for this build -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReleaseName** @@ -62,9 +78,16 @@ The name of the release -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EnvironmentPath** @@ -72,12 +95,21 @@ Adds a location to the environment path -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -86,5 +118,3 @@ System.String Set-ADOBuild [-BuildNumber ] [-Tag ] [-ReleaseName ] [-EnvironmentPath ] [] ``` --- - - diff --git a/docs/Set-ADOEndpoint.md b/docs/Set-ADOEndpoint.md index c7aa89ce..051411f3 100644 --- a/docs/Set-ADOEndpoint.md +++ b/docs/Set-ADOEndpoint.md @@ -1,4 +1,3 @@ - Set-ADOEndpoint --------------- ### Synopsis @@ -12,6 +11,9 @@ Sets a Azure DevOps Endpoint --- ### Related Links * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +31,16 @@ The identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Url** @@ -39,9 +48,16 @@ The endpoint URL. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|true |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AccessToken** @@ -49,9 +65,16 @@ The access token -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -59,9 +82,16 @@ The name of the setting. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Value** @@ -69,12 +99,21 @@ The value of the setting. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -89,5 +128,3 @@ Set-ADOEndpoint -ID -Name -Value [] Set-ADOEndpoint -ID -AccessToken [-Name ] [] ``` --- - - diff --git a/docs/Set-ADOExtension.md b/docs/Set-ADOExtension.md index 2dd37914..3ddaec2e 100644 --- a/docs/Set-ADOExtension.md +++ b/docs/Set-ADOExtension.md @@ -1,4 +1,3 @@ - Set-ADOExtension ---------------- ### Synopsis @@ -21,9 +20,16 @@ The organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -31,9 +37,16 @@ The Publisher of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -41,9 +54,16 @@ The Extension Identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DataCollection** @@ -51,9 +71,16 @@ The data collection -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DataID** @@ -61,9 +88,16 @@ The data identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScopeType** @@ -76,9 +110,19 @@ Valid Values: * Default * Project * User -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ScopeModifier** @@ -90,9 +134,19 @@ Valid Values: * Current * Me -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **InputObject** @@ -100,9 +154,16 @@ The input object -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|true |named |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByValue) + + + --- #### **Overwrite** @@ -111,9 +172,16 @@ If not set, new properties may be added to an existing -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -122,9 +190,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -134,9 +209,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -156,5 +238,3 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co Set-ADOExtension -Organization -PublisherID -ExtensionID -DataCollection [-DataID ] [-ScopeType ] [-ScopeModifier ] -InputObject [-Overwrite] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOPermission.md b/docs/Set-ADOPermission.md index 3f1f42de..4a13f503 100644 --- a/docs/Set-ADOPermission.md +++ b/docs/Set-ADOPermission.md @@ -1,4 +1,3 @@ - Set-ADOPermission ----------------- ### Synopsis @@ -12,7 +11,13 @@ Sets Azure DevOps security permissions. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20entries/set%20access%20control%20entries](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20entries/set%20access%20control%20entries) + + + * [https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference](https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -39,9 +51,16 @@ If this is provided without anything else, will get permissions for the projectI -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TeamID** @@ -49,9 +68,16 @@ If provided, will set permissions related to a given teamID. ( see Get-ADOTeam) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -59,9 +85,16 @@ If provided, will set permissions related to an Area Path. ( see Get-ADOAreaPath -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IterationPath** @@ -69,9 +102,16 @@ If provided, will set permissions related to an Iteration Path. ( see Get-ADOIte -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -79,9 +119,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPath** @@ -89,9 +136,16 @@ The path to the build. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildPermission** @@ -99,9 +153,16 @@ If set, will set build and release permissions for a given project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectRepository** @@ -109,9 +170,16 @@ If set, will set permissions for repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RepositoryID** @@ -119,9 +187,16 @@ If provided, will set permissions for a given repositoryID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BranchName** @@ -129,9 +204,16 @@ If provided, will set permissions for a given branch within a repository -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllRepository** @@ -139,9 +221,16 @@ If set, will set permissions for all repositories within a project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tagging** @@ -149,9 +238,16 @@ If set, will set permissions for tagging related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ManageTFVC** @@ -159,9 +255,16 @@ If set, will set permissions for Team Foundation Version Control related to the -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Plan** @@ -169,9 +272,16 @@ If set, will set permissions for Delivery Plans. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Dashboard** @@ -179,9 +289,16 @@ If set, will set dashboard permissions related to the current project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EndpointID** @@ -189,9 +306,16 @@ If set, will set endpoint permissions related to a particular endpoint. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PermissionType** @@ -199,9 +323,16 @@ If set, will list the type of permisssions. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **NamespaceID** @@ -209,9 +340,16 @@ The Security Namespace ID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SecurityToken** @@ -219,9 +357,16 @@ The Security Token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Descriptor** @@ -229,9 +374,16 @@ One or more descriptors -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Identity** @@ -239,9 +391,16 @@ One or more identities. Identities will be converted into descriptors. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Allow** @@ -249,9 +408,16 @@ One or more allow permissions. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Deny** @@ -259,9 +425,16 @@ One or more deny permissions. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Overwrite** @@ -270,9 +443,16 @@ By default, will merge permissions for the specified token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Inherit** @@ -281,9 +461,16 @@ By permissions will not be inherited. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -292,9 +479,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -304,9 +498,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -322,10 +523,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.SecurityNamespace +* PSDevOps.SecurityNamespace + + +* PSDevOps.AccessControlList -PSDevOps.AccessControlList --- @@ -379,5 +582,3 @@ Set-ADOPermission -Organization [-PermissionType] [-Identity Set-ADOPermission -Organization -NamespaceID -SecurityToken [-Descriptor ] [-Identity ] [-Allow ] [-Deny ] [-Overwrite] [-Inherit] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOProject.md b/docs/Set-ADOProject.md index 67c02877..91397463 100644 --- a/docs/Set-ADOProject.md +++ b/docs/Set-ADOProject.md @@ -1,4 +1,3 @@ - Set-ADOProject -------------- ### Synopsis @@ -12,6 +11,9 @@ Sets metadata for an Azure DevOps project. --- ### Related Links * [Get-ADOProject](Get-ADOProject.md) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +32,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -40,9 +49,16 @@ The project identifier. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EnableFeature** @@ -50,9 +66,16 @@ The ID of a feature to enable. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DisableFeature** @@ -60,9 +83,16 @@ The ID of afeature to disable. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Metadata** @@ -70,9 +100,16 @@ A dictionary of project metadata. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -80,9 +117,16 @@ The name of a metadata property. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Value** @@ -90,9 +134,16 @@ The value of a metadata property -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -101,9 +152,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -113,9 +171,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -131,10 +196,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -146,5 +213,3 @@ Set-ADOProject -Organization -ProjectID [-EnableFeature -ProjectID [-Metadata ] [-Name ] [-Value ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOTeam.md b/docs/Set-ADOTeam.md index b9360c58..2b00eda9 100644 --- a/docs/Set-ADOTeam.md +++ b/docs/Set-ADOTeam.md @@ -1,4 +1,3 @@ - Set-ADOTeam ----------- ### Synopsis @@ -12,7 +11,13 @@ Sets metadata for an Azure DevOps team. --- ### Related Links * [Get-ADOTeam](Get-ADOTeam.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/work/teamsettings/update](https://docs.microsoft.com/en-us/rest/api/azure/devops/work/teamsettings/update) + + + --- ### Examples #### EXAMPLE 1 @@ -31,9 +36,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -41,9 +53,16 @@ The project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -51,9 +70,16 @@ The team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Setting** @@ -61,9 +87,16 @@ A dictionary of team settings. This is directly passed to the REST api. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Workday** @@ -71,9 +104,16 @@ The team working days. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultIteration** @@ -81,9 +121,16 @@ The default iteration for the team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BugBehavior** @@ -96,9 +143,19 @@ Valid Values: * AsRequirements * AsTasks * Off -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefaultAreaPath** @@ -106,9 +163,16 @@ The default area path used for a team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AreaPath** @@ -116,9 +180,16 @@ A list of valid area paths used for a team -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IncludeChildren** @@ -126,9 +197,16 @@ If set, will allow work items on the team to be assigned to child area paths of -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -137,9 +215,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -149,9 +234,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -167,10 +259,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- @@ -182,5 +276,3 @@ Set-ADOTeam -Organization -Project -Team [-DefaultAre Set-ADOTeam -Organization -Project -Team [-Setting ] [-Workday ] [-DefaultIteration ] [-BugBehavior ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOWorkItem.md b/docs/Set-ADOWorkItem.md index a19ba020..8c70eb4d 100644 --- a/docs/Set-ADOWorkItem.md +++ b/docs/Set-ADOWorkItem.md @@ -1,4 +1,3 @@ - Set-ADOWorkItem --------------- ### Synopsis @@ -12,8 +11,17 @@ Sets work item from Azure DevOps or Team Foundation Server. --- ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/update](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/update) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -44,9 +52,16 @@ The InputObject -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|------------------------------| -|```[PSObject]```|false |named |true (ByValue, ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByValue, ByPropertyName) + + + --- #### **Organization** @@ -54,9 +69,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -64,9 +86,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -74,9 +103,16 @@ The Work Item ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Query** @@ -84,9 +120,16 @@ A query -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ParentID** @@ -94,9 +137,16 @@ The work item ParentID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Relationship** @@ -104,9 +154,16 @@ A collection of relationships for the work item. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Comment** @@ -114,9 +171,16 @@ A list of comments to be added to the work item. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Tag** @@ -124,9 +188,16 @@ A list of tags to assign to the work item. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BypassRule** @@ -134,9 +205,16 @@ If set, will not validate rules. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ValidateOnly** @@ -144,9 +222,16 @@ If set, will only validate rules, but will not update the work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SupressNotification** @@ -154,9 +239,16 @@ If set, will only validate rules, but will not update the work item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -165,9 +257,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -177,9 +276,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -195,7 +301,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.WorkItem +* PSDevOps.WorkItem + + --- @@ -207,5 +315,3 @@ Set-ADOWorkItem [-InputObject ] -Organization -Project ] -Organization -Project -Query [-ParentID ] [-Relationship ] [-Comment ] [-Tag ] [-BypassRule] [-ValidateOnly] [-SupressNotification] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Set-ADOWorkProcess.md b/docs/Set-ADOWorkProcess.md index 2fc8e9e9..aef721e8 100644 --- a/docs/Set-ADOWorkProcess.md +++ b/docs/Set-ADOWorkProcess.md @@ -1,4 +1,3 @@ - Set-ADOWorkProcess ------------------ ### Synopsis @@ -18,6 +17,9 @@ Can: --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/edit%20process](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/edit%20process) + + + --- ### Examples #### EXAMPLE 1 @@ -42,9 +44,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProjectID** @@ -52,9 +61,16 @@ The Project Identifier. If this is provided, will get the work process associat -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ProcessID** @@ -62,9 +78,16 @@ The process identifier -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Default** @@ -72,9 +95,16 @@ If set, will make the work process the default for new projects. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NewName** @@ -82,9 +112,16 @@ If provided, will rename the work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -92,9 +129,16 @@ If provided, will update the description on the work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Disable** @@ -102,9 +146,16 @@ If set, will disable the work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Enable** @@ -112,9 +163,16 @@ If set, will enable the work process. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -123,9 +181,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -135,9 +200,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -153,7 +225,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.WorkProcess +* PSDevOps.WorkProcess + + --- @@ -168,5 +242,3 @@ Set-ADOWorkProcess -Organization -ProjectID [-Default] [-NewNa Set-ADOWorkProcess -Organization -ProcessID [-Default] [-NewName ] [-Description ] [-Disable] [-Enable] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Start-ADOBuild.md b/docs/Start-ADOBuild.md index c7626b48..35ce263a 100644 --- a/docs/Start-ADOBuild.md +++ b/docs/Start-ADOBuild.md @@ -1,4 +1,3 @@ - Start-ADOBuild -------------- ### Synopsis @@ -12,8 +11,17 @@ Starts a build in Azure DevOps, using an existing BuildID, --- ### Related Links * [Get-ADOBuild](Get-ADOBuild.md) + + + * [Stop-ADOBuild](Stop-ADOBuild.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/queues](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/queues) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +38,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -40,9 +55,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -50,9 +72,16 @@ The server. By default https://dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -60,9 +89,16 @@ The api version. By default, 5.1. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildID** @@ -70,9 +106,16 @@ The Build ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -80,9 +123,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionName** @@ -90,9 +140,16 @@ The Build Definition Name -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourceBranch** @@ -100,9 +157,16 @@ The source branch (the branch used for the build). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourceVersion** @@ -110,9 +174,16 @@ The source version (the commit used for the build). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Parameter** @@ -120,9 +191,16 @@ The build parameters -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -138,10 +216,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Build +* PSDevOps.Build + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -hashtable --- @@ -156,5 +236,3 @@ Start-ADOBuild -Organization -Project [-Server ] [-ApiVer Start-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -DefinitionName [-SourceBranch ] [-SourceVersion ] [-Parameter ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Stop-ADOBuild.md b/docs/Stop-ADOBuild.md index e6307f8b..6083ffb6 100644 --- a/docs/Stop-ADOBuild.md +++ b/docs/Stop-ADOBuild.md @@ -1,4 +1,3 @@ - Stop-ADOBuild ------------- ### Synopsis @@ -12,7 +11,13 @@ Cancels a running Azure DevOps Build. --- ### Related Links * [Start-ADOBuild](Start-ADOBuild.md) + + + * [Get-ADOBuild](Get-ADOBuild.md) + + + --- ### Examples #### EXAMPLE 1 @@ -34,9 +39,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -44,9 +56,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -54,9 +73,16 @@ The server. By default https://dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -64,9 +90,16 @@ The api version. By default, 5.1. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildID** @@ -74,9 +107,16 @@ The Build ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -92,10 +132,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Build +* PSDevOps.Build + + +* [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) -hashtable --- @@ -104,5 +146,3 @@ hashtable Stop-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -BuildID [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Submit-Git.md b/docs/Submit-Git.md index 75d3ae2a..3c4261ee 100644 --- a/docs/Submit-Git.md +++ b/docs/Submit-Git.md @@ -1,4 +1,3 @@ - Submit-Git ---------- ### Synopsis @@ -25,9 +24,16 @@ The -m option is mutually exclusive with -c, -C, and -F -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **All** @@ -36,9 +42,16 @@ but new files you have not told Git about are not affected. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Patch** @@ -47,9 +60,16 @@ See git-add(1) for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Commit** @@ -58,9 +78,16 @@ and the authorship information (including the timestamp) when creating the commi -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReEditCommit** @@ -68,9 +95,16 @@ Like -Commit, but with -c the editor is invoked, so that the user can further ed -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FixupCommit** @@ -80,9 +114,16 @@ See git-rebase(1) for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Squash** @@ -93,9 +134,16 @@ See git-rebase(1) for details. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ResetAuthor** @@ -106,9 +154,16 @@ This also renews the author timestamp. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Short** @@ -117,9 +172,16 @@ See git-status(1) for details. Implies --dry-run. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Branch** @@ -127,9 +189,16 @@ Show the branch and tracking info even in short-format. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Porcelain** @@ -138,9 +207,16 @@ See git-status(1) for details. Implies --dry-run. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Long** @@ -148,9 +224,16 @@ When doing a dry-run, give the output in the long-format. Implies --dry-run. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NullTerminatedOutput** @@ -160,9 +243,16 @@ Without the -z option, filenames with "unusual" characters are quoted as explain -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **File** @@ -171,9 +261,16 @@ Use - to read the message from the standard input. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Author** @@ -185,9 +282,16 @@ the commit author is then copied from the first such commit found. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Date** @@ -195,9 +299,16 @@ Override the author date used in the commit. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SignOff** @@ -209,9 +320,16 @@ under the same license and agrees to a Developer Certificate of Origin -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoVerify** @@ -220,9 +338,16 @@ See also githooks(5). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllowEmpty** @@ -233,9 +358,16 @@ is primarily for use by foreign SCM interface scripts. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AllowEmptyMessage** @@ -246,9 +378,16 @@ git-commit-tree(1). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Cleanup** @@ -263,9 +402,19 @@ Valid Values: * verbatim * scissors * default -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Edit** @@ -274,9 +423,16 @@ This option lets you further edit the message taken from these sources. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoEdit** @@ -285,9 +441,16 @@ For example, git commit --amend --no-edit amends a commit without changing its c -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Amend** @@ -322,9 +485,16 @@ FROM UPSTREAM REBASE" section in git-rebase(1).) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoPostRewrite** @@ -332,9 +502,16 @@ Bypass the post-rewrite hook. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Include** @@ -344,9 +521,16 @@ This is usually not what you want unless you are concluding a conflicted merge. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Only** @@ -363,9 +547,16 @@ If used together with --allow-empty paths are also not required, and an empty co -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UntrackedFile** @@ -391,9 +582,19 @@ Valid Values: * No * Normal * All -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Quiet** @@ -401,9 +602,16 @@ Suppress commit summary message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DryRun** @@ -413,9 +621,16 @@ uncommitted and paths that are untracked. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Status** @@ -425,9 +640,16 @@ Defaults to on, but can be used to override configuration variable commit.status -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoStatus** @@ -436,9 +658,16 @@ when using an editor to prepare the default commit message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GPGSign** @@ -448,9 +677,16 @@ if specified, it must be stuck to the option without a space -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoGPGSign** @@ -458,9 +694,16 @@ Countermand commit.gpgSign configuration variable that is set to force each and -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -480,5 +723,3 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co Submit-Git [-Message ] [-All] [-Patch] [-Commit ] [-ReEditCommit ] [-FixupCommit ] [-Squash ] [-ResetAuthor] [-Short] [-Branch] [-Porcelain] [-Long] [-NullTerminatedOutput] [-File ] [-Author ] [-Date ] [-SignOff] [-NoVerify] [-AllowEmpty] [-AllowEmptyMessage] [-Cleanup ] [-Edit] [-NoEdit] [-Amend] [-NoPostRewrite] [-Include] [-Only] [-UntrackedFile ] [-Quiet] [-DryRun] [-Status] [-NoStatus] [-GPGSign ] [-NoGPGSign] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Trace-ADOCommand.md b/docs/Trace-ADOCommand.md index 19bbc4bc..95061274 100644 --- a/docs/Trace-ADOCommand.md +++ b/docs/Trace-ADOCommand.md @@ -1,4 +1,3 @@ - Trace-ADOCommand ---------------- ### Synopsis @@ -12,7 +11,13 @@ Traces information a command line into the output of Azure DevOps. --- ### Related Links * [Write-ADOCommand](Write-ADOCommand.md) + + + * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +38,16 @@ The command line. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Parameter** @@ -43,12 +55,21 @@ A dictionary of parameters to the command. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -57,5 +78,3 @@ System.String Trace-ADOCommand -Command [-Parameter ] [] ``` --- - - diff --git a/docs/Trace-GitHubCommand.md b/docs/Trace-GitHubCommand.md index 6449abeb..33b78a5c 100644 --- a/docs/Trace-GitHubCommand.md +++ b/docs/Trace-GitHubCommand.md @@ -1,4 +1,3 @@ - Trace-GitHubCommand ------------------- ### Synopsis @@ -12,6 +11,9 @@ Traces information about a command as a debug message in a GitHub workflow. --- ### Related Links * [Write-GitDebug](Write-GitDebug.md) + + + --- ### Examples #### EXAMPLE 1 @@ -32,9 +34,16 @@ The command line. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Parameter** @@ -42,12 +51,21 @@ A dictionary of parameters to the command. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |named |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -56,5 +74,3 @@ System.String Trace-GitHubCommand -Command [-Parameter ] [] ``` --- - - diff --git a/docs/Uninstall-ADOExtension.md b/docs/Uninstall-ADOExtension.md index a14edd10..3c899717 100644 --- a/docs/Uninstall-ADOExtension.md +++ b/docs/Uninstall-ADOExtension.md @@ -1,4 +1,3 @@ - Uninstall-ADOExtension ---------------------- ### Synopsis @@ -12,7 +11,13 @@ Uninstalls Azure DevOps Extensions from an organization. --- ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) + + + * [Install-ADOExtension](Install-ADOExtension.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PublisherID** @@ -38,9 +50,16 @@ The Publisher of an Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExtensionID** @@ -48,9 +67,16 @@ The name of the Extension. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Reason** @@ -58,9 +84,16 @@ An optional reason the extension is being removed. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ReasonCode** @@ -68,9 +101,16 @@ An optional reason code. This can be used to group the reasons extensions have -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -79,9 +119,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -91,9 +138,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -109,7 +163,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Extension +* PSDevOps.Extension + + --- @@ -118,5 +174,3 @@ PSDevOps.Extension Uninstall-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Reason] ] [[-ReasonCode] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Update-ADOBuild.md b/docs/Update-ADOBuild.md index e9acd427..cce0489f 100644 --- a/docs/Update-ADOBuild.md +++ b/docs/Update-ADOBuild.md @@ -1,4 +1,3 @@ - Update-ADOBuild --------------- ### Synopsis @@ -12,7 +11,13 @@ Updates builds and build definitions in Azure DevOps. --- ### Related Links * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/update%20build?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/update%20build?view=azure-devops-rest-5.1) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/update?view=azure-devops-rest-5.1](https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/update?view=azure-devops-rest-5.1) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -38,9 +50,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -48,9 +67,16 @@ The server. By default https://dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -58,9 +84,16 @@ The api version. By default, 5.1. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **BuildID** @@ -68,9 +101,16 @@ The Build ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Build** @@ -78,9 +118,16 @@ The updated build information. This only needs to contain the changed informati -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|true |named |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DefinitionID** @@ -88,9 +135,16 @@ The Build Definition ID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Definition** @@ -98,9 +152,16 @@ The new build definition. This needs to contain the entire definition. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|true |named |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByValue) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -116,10 +177,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Build +* PSDevOps.Build + + +* PSDevOps.Build.Definition -PSDevOps.Build.Definition --- @@ -131,5 +194,3 @@ Update-ADOBuild -Organization -Project [-Server ] [-ApiVe Update-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -DefinitionID -Definition [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Update-ADODashboard.md b/docs/Update-ADODashboard.md index 6aa36814..2f9c570c 100644 --- a/docs/Update-ADODashboard.md +++ b/docs/Update-ADODashboard.md @@ -1,4 +1,3 @@ - Update-ADODashboard ------------------- ### Synopsis @@ -12,6 +11,9 @@ Creates Dashboards from Azure DevOps, or Creates Widgets in a Dashboard in Azure --- ### Related Links * [Get-ADODashboard](Get-ADODashboard.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,9 +35,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -43,9 +52,16 @@ The Project. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Team** @@ -53,9 +69,16 @@ The Team. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -63,9 +86,16 @@ The name of the dashboard or widget. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -73,9 +103,16 @@ A description of the dashboard -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Widget** @@ -83,9 +120,16 @@ Widgets created with the dashboard. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DashboardID** @@ -93,9 +137,16 @@ The DashboardID. This dashboard will contain the new widgets. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WidgetID** @@ -103,9 +154,16 @@ The WidgetID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ContributionID** @@ -113,9 +171,16 @@ The ContributionID. This describes the exact extension contribution the widget -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Row** @@ -123,9 +188,16 @@ The row of the widget. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Column** @@ -133,9 +205,16 @@ The column of the widget. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RowSpan** @@ -143,9 +222,16 @@ The number of rows the widget should occupy. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColumnSpan** @@ -153,9 +239,16 @@ The number of columns the widget should occupy. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Setting** @@ -163,9 +256,16 @@ The widget settings. Settings are specific to each widget. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |named |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -174,9 +274,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -186,9 +293,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -204,10 +318,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Dashboard +* PSDevOps.Dashboard + + +* PSDevOps.Widget -PSDevOps.Widget --- @@ -219,5 +335,3 @@ Update-ADODashboard -Organization -Project [-Team ] [- Update-ADODashboard -Organization -Project [-Team ] [-Name ] -DashboardID -WidgetID -ContributionID [-Row ] [-Column ] [-RowSpan ] [-ColumnSpan ] [-Setting ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Update-ADOPicklist.md b/docs/Update-ADOPicklist.md index 8a659086..c4ddd76c 100644 --- a/docs/Update-ADOPicklist.md +++ b/docs/Update-ADOPicklist.md @@ -1,4 +1,3 @@ - Update-ADOPicklist ------------------ ### Synopsis @@ -12,7 +11,13 @@ Updates Picklists in Azure DevOps. --- ### Related Links * [Get-ADOPicklist](Get-ADOPicklist.md) + + + * [https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/update](https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/lists/update) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Organization. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistName** @@ -38,9 +50,16 @@ The name of the picklist. Providing this parameter will rename the picklist. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **DateType** @@ -53,9 +72,19 @@ Valid Values: * Double * Integer * String -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | + + + +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IsSuggested** @@ -63,9 +92,16 @@ If set, will make the items in the picklist "suggested", and allow user input. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Item** @@ -74,9 +110,16 @@ If a PicklistID is provided, or -PicklistName already exists, will add these ite -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PicklistID** @@ -84,9 +127,16 @@ The PicklistID of an existing picklist. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -95,9 +145,16 @@ To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |named |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -107,9 +164,16 @@ See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-v -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -125,7 +189,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -PSDevOps.Picklist.Detail +* PSDevOps.Picklist.Detail + + --- @@ -134,5 +200,3 @@ PSDevOps.Picklist.Detail Update-ADOPicklist -Organization [-PicklistName ] [-DateType ] [-IsSuggested] -Item -PicklistID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` --- - - diff --git a/docs/Wait-ADOBuild.md b/docs/Wait-ADOBuild.md index 76369d38..9c1ca2a8 100644 --- a/docs/Wait-ADOBuild.md +++ b/docs/Wait-ADOBuild.md @@ -1,4 +1,3 @@ - Wait-ADOBuild ------------- ### Synopsis @@ -12,7 +11,13 @@ Waits for Azure DevOps or TFS Builds to complete, fail, get cancelled, or be pos --- ### Related Links * [Get-ADOBuild](Get-ADOBuild.md) + + + * [Start-ADOBuild](Start-ADOBuild.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +34,16 @@ The Organization -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Project** @@ -39,9 +51,16 @@ The Project -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BuildID** @@ -49,9 +68,16 @@ One or more build IDs. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |3 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Server** @@ -59,9 +85,16 @@ The server. By default https://dev.azure.com/. -|Type |Requried|Postion|PipelineInput | -|-----------|--------|-------|---------------------| -|```[Uri]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Uri]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ApiVersion** @@ -69,9 +102,16 @@ The api version. By default, 5.1. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |5 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:false + + + --- #### **PollingInterval** @@ -79,9 +119,16 @@ The time to wait before each retry. By default, 3 1/3 seconds. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[TimeSpan]```|false |6 |false | +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **Timeout** @@ -89,12 +136,21 @@ The timeout. If provided, the function will wait no longer than the timeout. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[TimeSpan]```|false |7 |false | +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- ### Outputs -PSDevOps.Build +* PSDevOps.Build + + --- @@ -103,5 +159,3 @@ PSDevOps.Build Wait-ADOBuild [-Organization] [-Project] [-BuildID] [[-Server] ] [[-ApiVersion] ] [[-PollingInterval] ] [[-Timeout] ] [] ``` --- - - diff --git a/docs/Write-ADODebug.md b/docs/Write-ADODebug.md index 16d87e34..0d8dbf79 100644 --- a/docs/Write-ADODebug.md +++ b/docs/Write-ADODebug.md @@ -1,4 +1,3 @@ - Write-ADODebug -------------- ### Synopsis @@ -12,8 +11,17 @@ Writes an Azure DevOps Debug --- ### Related Links * [Write-ADOError](Write-ADOError.md) + + + * [Write-ADOWarning](Write-ADOWarning.md) + + + * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -29,12 +37,21 @@ The Debug message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -43,5 +60,3 @@ System.String Write-ADODebug [-Message] [] ``` --- - - diff --git a/docs/Write-ADOError.md b/docs/Write-ADOError.md index 12a51c21..96725499 100644 --- a/docs/Write-ADOError.md +++ b/docs/Write-ADOError.md @@ -1,4 +1,3 @@ - Write-ADOError -------------- ### Synopsis @@ -12,7 +11,13 @@ Writes an Azure DevOps Error --- ### Related Links * [Write-ADOWarning](Write-ADOWarning.md) + + + * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The error message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourcePath** @@ -38,9 +50,16 @@ An optional source path. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **LineNumber** @@ -48,9 +67,16 @@ An optional line number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |3 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColumnNumber** @@ -58,9 +84,16 @@ An optional column number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |4 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Code** @@ -68,12 +101,21 @@ An optional error code. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -82,5 +124,3 @@ System.String Write-ADOError [-Message] [[-SourcePath] ] [[-LineNumber] ] [[-ColumnNumber] ] [[-Code] ] [] ``` --- - - diff --git a/docs/Write-ADOOutput.md b/docs/Write-ADOOutput.md index 4a0a03db..87815a33 100644 --- a/docs/Write-ADOOutput.md +++ b/docs/Write-ADOOutput.md @@ -1,4 +1,3 @@ - Write-ADOOutput --------------- ### Synopsis @@ -14,8 +13,17 @@ This output can be referenced in subsequent steps within a job. --- ### Related Links * [Write-ADOError](Write-ADOError.md) + + + * [Write-ADODebug](Write-ADODebug.md) + + + * [Write-ADOWarning](Write-ADOWarning.md) + + + --- ### Examples #### EXAMPLE 1 @@ -38,9 +46,16 @@ The InputObject. Values will be converted to a JSON array. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|true |1 |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByValue) + + + --- #### **Name** @@ -48,9 +63,16 @@ The Name of the Output. By default, 'Output'. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |2 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Depth** @@ -58,12 +80,21 @@ The JSON serialization depth. By default, 10 levels. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |3 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -72,5 +103,3 @@ System.String Write-ADOOutput [-InputObject] [[-Name] ] [[-Depth] ] [] ``` --- - - diff --git a/docs/Write-ADOProgress.md b/docs/Write-ADOProgress.md index 108cc2dd..1929e61a 100644 --- a/docs/Write-ADOProgress.md +++ b/docs/Write-ADOProgress.md @@ -1,4 +1,3 @@ - Write-ADOProgress ----------------- ### Synopsis @@ -12,7 +11,13 @@ Writes a progress record to the Azure DevOps pipeline. --- ### Related Links * [Write-ADOError](Write-ADOError.md) + + + * [Write-ADOWarning](Write-ADOWarning.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ This text describes the activity whose progress is being reported. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |1 |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **Status** @@ -38,9 +50,16 @@ This text describes current state of the activity. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |2 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Id** @@ -49,9 +68,16 @@ If the progress bars do not have different IDs, they are superimposed instead of -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |3 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **PercentComplete** @@ -60,9 +86,16 @@ Use the value -1 if the percentage complete is unknown or not applicable. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **SecondsRemaining** @@ -70,9 +103,16 @@ Specifies the projected number of seconds remaining until the activity is comple -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **CurrentOperation** @@ -80,9 +120,16 @@ This text describes the operation that is currently taking place. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ParentId** @@ -90,9 +137,16 @@ Specifies the parent activity of the current activity. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |named |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Completed** @@ -100,12 +154,21 @@ Indicates the progress timeline operation is completed. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -114,5 +177,3 @@ System.String Write-ADOProgress [-Activity] [[-Status] ] [[-Id] ] [-PercentComplete ] [-SecondsRemaining ] [-CurrentOperation ] [-ParentId ] [-Completed] [] ``` --- - - diff --git a/docs/Write-ADOVariable.md b/docs/Write-ADOVariable.md index b146aa9f..69f30e85 100644 --- a/docs/Write-ADOVariable.md +++ b/docs/Write-ADOVariable.md @@ -1,4 +1,3 @@ - Write-ADOVariable ----------------- ### Synopsis @@ -12,6 +11,9 @@ Writes a Azure DevOps Variable. --- ### Related Links * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +29,16 @@ The variable name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Value** @@ -37,9 +46,16 @@ The variable value. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |2 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IsSecret** @@ -47,9 +63,16 @@ If set, the variable will be a secret. Secret variables will not echo in logs. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IsReadOnly** @@ -57,9 +80,16 @@ If set, the variable will be marked as read only. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IsOutput** @@ -67,12 +97,21 @@ If set, the variable will be marked as output. Output variables may be referenc -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -81,5 +120,3 @@ System.String Write-ADOVariable [-Name] [[-Value] ] [-IsSecret] [-IsReadOnly] [-IsOutput] [] ``` --- - - diff --git a/docs/Write-ADOWarning.md b/docs/Write-ADOWarning.md index e2339c76..da72c748 100644 --- a/docs/Write-ADOWarning.md +++ b/docs/Write-ADOWarning.md @@ -1,4 +1,3 @@ - Write-ADOWarning ---------------- ### Synopsis @@ -12,7 +11,13 @@ Writes an Azure DevOps Warning --- ### Related Links * [Write-ADOError](Write-ADOError.md) + + + * [https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands](https://docs.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Warning message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SourcePath** @@ -38,9 +50,16 @@ An optional source path. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **LineNumber** @@ -48,9 +67,16 @@ An optional line number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |3 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColumnNumber** @@ -58,9 +84,16 @@ An optional column number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |4 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Code** @@ -68,12 +101,21 @@ An optional Warning code. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -82,5 +124,3 @@ System.String Write-ADOWarning [-Message] [[-SourcePath] ] [[-LineNumber] ] [[-ColumnNumber] ] [[-Code] ] [] ``` --- - - diff --git a/docs/Write-GitHubDebug.md b/docs/Write-GitHubDebug.md index c6c1042b..619152fd 100644 --- a/docs/Write-GitHubDebug.md +++ b/docs/Write-GitHubDebug.md @@ -1,4 +1,3 @@ - Write-GitHubDebug ----------------- ### Synopsis @@ -12,7 +11,13 @@ Writes an GitHub Workflow Warning --- ### Related Links * [Write-GitHubError](Write-GitHubError.md) + + + * [https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions](https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions) + + + --- ### Examples #### EXAMPLE 1 @@ -28,12 +33,21 @@ The Debug message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -42,5 +56,3 @@ System.String Write-GitHubDebug [-Message] [] ``` --- - - diff --git a/docs/Write-GitHubError.md b/docs/Write-GitHubError.md index f0d5a239..f7d324a0 100644 --- a/docs/Write-GitHubError.md +++ b/docs/Write-GitHubError.md @@ -1,4 +1,3 @@ - Write-GitHubError ----------------- ### Synopsis @@ -12,7 +11,13 @@ Writes a GitHub Workflow Error --- ### Related Links * [Write-GitHubWarning](Write-GitHubWarning.md) + + + * [https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions](https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The error message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **File** @@ -38,9 +50,16 @@ An optional source path. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Line** @@ -48,9 +67,16 @@ An optional line number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |3 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Col** @@ -58,12 +84,21 @@ An optional column number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |4 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -72,5 +107,3 @@ System.String Write-GitHubError [-Message] [[-File] ] [[-Line] ] [[-Col] ] [] ``` --- - - diff --git a/docs/Write-GitHubOutput.md b/docs/Write-GitHubOutput.md index 6efd412c..8bda70c3 100644 --- a/docs/Write-GitHubOutput.md +++ b/docs/Write-GitHubOutput.md @@ -1,4 +1,3 @@ - Write-GitHubOutput ------------------ ### Synopsis @@ -14,6 +13,9 @@ This output can be referenced in subsequent steps. --- ### Related Links * [Write-GitHubError](Write-GitHubError.md) + + + --- ### Examples #### EXAMPLE 1 @@ -36,9 +38,16 @@ The InputObject. Values will be converted to a JSON array. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|true |1 |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByValue) + + + --- #### **Name** @@ -46,9 +55,16 @@ The Name of the Output. By default, 'Output'. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |2 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Depth** @@ -56,12 +72,21 @@ The JSON serialization depth. By default, 10 levels. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |3 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -70,5 +95,3 @@ System.String Write-GitHubOutput [-InputObject] [[-Name] ] [[-Depth] ] [] ``` --- - - diff --git a/docs/Write-GitHubWarning.md b/docs/Write-GitHubWarning.md index c41c6547..412408b7 100644 --- a/docs/Write-GitHubWarning.md +++ b/docs/Write-GitHubWarning.md @@ -1,4 +1,3 @@ - Write-GitHubWarning ------------------- ### Synopsis @@ -12,7 +11,13 @@ Writes an GitHub Workflow Warning --- ### Related Links * [Write-GitHubError](Write-GitHubError.md) + + + * [https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions](https://docs.github.com/en/actions/reference/workflow-commands-for-GitHubhub-actions) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +33,16 @@ The Warning message. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **File** @@ -38,9 +50,16 @@ An optional source path. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Line** @@ -48,9 +67,16 @@ An optional line number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |3 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Col** @@ -58,12 +84,21 @@ An optional column number. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[UInt32]```|false |4 |true (ByPropertyName)| +> **Type**: ```[UInt32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.String +* [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) + + --- @@ -72,5 +107,3 @@ System.String Write-GitHubWarning [-Message] [[-File] ] [[-Line] ] [[-Col] ] [] ``` --- - -