diff --git a/.github/workflows/TestAndPublish.yml b/.github/workflows/TestAndPublish.yml index bcd50a5a..ada72ae3 100644 --- a/.github/workflows/TestAndPublish.yml +++ b/.github/workflows/TestAndPublish.yml @@ -117,7 +117,7 @@ jobs: Install-Module -Name Pester -Repository PSGallery -Force -Scope CurrentUser -MaximumVersion $PesterMaxVersion -SkipPublisherCheck -AllowClobber Import-Module Pester -Force -PassThru -MaximumVersion $PesterMaxVersion} @Parameters - name: Check out repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: RunPester id: RunPester shell: pwsh @@ -174,9 +174,6 @@ jobs: $result = Invoke-Pester -PassThru -Verbose -OutputFile ".\$moduleName.TestResults.xml" -OutputFormat NUnitXml @codeCoverageParameters - "::set-output name=TotalCount::$($result.TotalCount)", - "::set-output name=PassedCount::$($result.PassedCount)", - "::set-output name=FailedCount::$($result.FailedCount)" | Out-Host if ($result.FailedCount -gt 0) { "::debug:: $($result.FailedCount) tests failed" foreach ($r in $result.TestResult) { @@ -188,7 +185,7 @@ jobs: } } @Parameters - name: PublishTestResults - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: PesterResults path: '**.TestResults.xml' @@ -575,7 +572,7 @@ jobs: if: ${{ success() }} steps: - name: Check out repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 - name: Use PSSVG Action uses: StartAutomating/PSSVG@main id: PSSVG @@ -585,6 +582,46 @@ jobs: uses: StartAutomating/EZOut@master - name: UseHelpOut uses: StartAutomating/HelpOut@master + - name: Log in to ghcr.io + uses: docker/login-action@master + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + env: + REGISTRY: ghcr.io + - name: Extract Docker Metadata (for branch) + if: ${{github.ref_name != 'main' && github.ref_name != 'master' && github.ref_name != 'latest'}} + id: meta + uses: docker/metadata-action@master + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + - name: Extract Docker Metadata (for main) + if: ${{github.ref_name == 'main' || github.ref_name == 'master' || github.ref_name == 'latest'}} + id: metaMain + uses: docker/metadata-action@master + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + flavor: latest=true + - name: Build and push Docker image (from main) + if: ${{github.ref_name == 'main' || github.ref_name == 'master' || github.ref_name == 'latest'}} + uses: docker/build-push-action@master + with: + context: . + push: true + tags: ${{ steps.metaMain.outputs.tags }} + labels: ${{ steps.metaMain.outputs.labels }} + - name: Build and push Docker image (from branch) + if: ${{github.ref_name != 'main' && github.ref_name != 'master' && github.ref_name != 'latest'}} + uses: docker/build-push-action@master + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} env: NoCoverage: true SYSTEM_ACCESSTOKEN: ${{ secrets.AZUREDEVOPSPAT }} diff --git a/Assets/PSDevOps.svg b/Assets/PSDevOps.svg index c86ebc95..eb6f12f2 100644 --- a/Assets/PSDevOps.svg +++ b/Assets/PSDevOps.svg @@ -1,4 +1,5 @@ - + + @@ -11,4 +12,4 @@ ∞ - \ No newline at end of file + diff --git a/Container.init.ps1 b/Container.init.ps1 new file mode 100644 index 00000000..e8a17dfd --- /dev/null +++ b/Container.init.ps1 @@ -0,0 +1,95 @@ +<# +.SYNOPSIS + Initializes a container during build. +.DESCRIPTION + Initializes the container image with the necessary modules and packages. + + This script should be called from the Dockerfile, during the creation of the container image. + + ~~~Dockerfile + # Thank you Microsoft! Thank you PowerShell! Thank you Docker! + FROM mcr.microsoft.com/powershell + # Set the shell to PowerShell (thanks again, Docker!) + SHELL ["/bin/pwsh", "-nologo", "-command"] + # Run the initialization script. This will do all remaining initialization in a single layer. + RUN --mount=type=bind,src=./,target=/Initialize ./Initialize/Container.init.ps1 + ~~~ + + The scripts arguments can be provided with either an `ARG` or `ENV` instruction in the Dockerfile. +.NOTES + Did you know that in PowerShell you can 'use' namespaces that do not really exist? + This seems like a nice way to describe a relationship to a container image. + That is why this file is using the namespace 'mcr.microsoft.com/powershell'. + (this does nothing, but most likely will be used in the future) +#> +using namespace 'mcr.microsoft.com/powershell' + +param( +# The name of the module to be installed. +[string]$ModuleName = $( + if ($env:ModuleName) { $env:ModuleName } + else { + (Get-ChildItem -Path $PSScriptRoot | + Where-Object Extension -eq '.psd1' | + Select-String 'ModuleVersion\s=' | + Select-Object -ExpandProperty Path -First 1) -replace '\.psd1$' + } +), +# The packages to be installed. +[string[]]$InstallPackages = @( + if ($env:InstallPackages) { $env:InstallPackages -split ',' } + else { } +), +# The modules to be installed. +[string[]]$InstallModules = @( + if ($env:InstallModules) { $env:InstallModules -split ',' } + else { } +) +) + + +# Get the root module directory +$rootModuleDirectory = @($env:PSModulePath -split '[;:]')[0] + +# Determine the path to the module destination. +$moduleDestination = "$rootModuleDirectory/$ModuleName" +# Copy the module to the destination +# (this is being used instead of the COPY statement in Docker, to avoid additional layers). +Copy-Item -Path "$psScriptRoot" -Destination $moduleDestination -Recurse -Force + +# Copy all container-related scripts to the root of the container. +Get-ChildItem -Path $PSScriptRoot | + Where-Object Name -Match '^Container\..+?\.ps1$' | + Copy-Item -Destination / + +# If we have packages to install +if ($InstallPackages) { + # install the packages + apt-get update && apt-get install -y @InstallPackages && apt-get clean | Out-Host +} + +# Create a new profile +New-Item -Path $Profile -ItemType File -Force | + # and import this module in the profile + Add-Content -Value "Import-Module $ModuleName" -Force +# If we have modules to install +if ($InstallModules) { + # Install the modules + Install-Module -Name $InstallModules -Force -AcceptLicense -Scope CurrentUser + # and import them in the profile + Add-Content -Path $Profile -Value "Import-Module '$($InstallModules -join "','")'" -Force +} +# In our profile, push into the module's directory +Add-Content -Path $Profile -Value "Get-Module $ModuleName | Split-Path | Push-Location" -Force + +# Remove the .git directories from any modules +Get-ChildItem -Path $rootModuleDirectory -Directory -Force -Recurse | + Where-Object Name -eq '.git' | + Remove-Item -Recurse -Force + +# Congratulations! You have successfully initialized the container image. +# This script should work in about any module, with minor adjustments. +# If you have any adjustments, please put them below here, in the `#region Custom` + +#region Custom +#endregion Custom \ No newline at end of file diff --git a/Container.start.ps1 b/Container.start.ps1 new file mode 100644 index 00000000..da42a407 --- /dev/null +++ b/Container.start.ps1 @@ -0,0 +1,63 @@ +<# +.SYNOPSIS + Starts the container. +.DESCRIPTION + Starts a container. + + This script should be called from the Dockerfile as the ENTRYPOINT (or from within the ENTRYPOINT). + + It should be deployed to the root of the container image. + + ~~~Dockerfile + # Thank you Microsoft! Thank you PowerShell! Thank you Docker! + FROM mcr.microsoft.com/powershell + # Set the shell to PowerShell (thanks again, Docker!) + SHELL ["/bin/pwsh", "-nologo", "-command"] + # Run the initialization script. This will do all remaining initialization in a single layer. + RUN --mount=type=bind,src=./,target=/Initialize ./Initialize/Container.init.ps1 + + ENTRYPOINT ["pwsh", "-nologo", "-file", "/Container.start.ps1"] + ~~~ +.NOTES + Did you know that in PowerShell you can 'use' namespaces that do not really exist? + This seems like a nice way to describe a relationship to a container image. + That is why this file is using the namespace 'mcr.microsoft.com/powershell'. + (this does nothing, but most likely will be used in the future) +#> +using namespace 'ghcr.io/startautomating/psdevops' + +param() + +$env:IN_CONTAINER = $true +$PSStyle.OutputRendering = 'Ansi' + +$mountedDrives = @(if (Test-Path '/proc/mounts') { + (Select-String "\S+\s(?

\S+).+rw?,.+symlinkroot=/mnt/host" "/proc/mounts").Matches.Groups | + Where-Object Name -eq p | + Get-Item -path { $_.Value } | + New-PSDrive -Name { "Mount", $_.Name -join '.' } -PSProvider FileSystem -Root { $_.Value } -Scope Global -ErrorAction Ignore +}) + +if ($global:ContainerInfo.MountedPaths) { + "Mounted $($mountedPaths.Length) drives:" | Out-Host + $mountedDrives | Out-Host +} + +if ($args) { + # If there are arguments, output them (you could handle them in a more complex way). + "$args" | Out-Host +} else { + # If there are no arguments, see if there is a Microservice.ps1 + if (Test-Path './Microservice.ps1') { + # If there is a Microservice.ps1, run it. + . ./Microservice.ps1 + } +} + +# If you want to do something when the container is stopped, you can register an event. +# This can call a script that does some cleanup, or sends a message as the service is exiting. +Register-EngineEvent -SourceIdentifier PowerShell.Exiting -Action { + if (Test-Path '/Container.stop.ps1') { + & /Container.stop.ps1 + } +} | Out-Null \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..c6f838d0 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,14 @@ +# Thank you Microsoft! Thank you PowerShell! Thank you Docker! +FROM mcr.microsoft.com/powershell + +# Store the module name in an environment variable (this should not change) +ENV ModuleName="PSDevOps" + +# We set the shell to PowerShell, +SHELL ["/bin/pwsh", "-nologo", "-command"] + +# run the initialization script +RUN --mount=type=bind,src=./,target=/Initialize ./Initialize/Container.init.ps1 + +# and set the entry point to `/Container.start.ps1`. +ENTRYPOINT ["pwsh", "-noexit", "-nologo", "-file", "/Container.start.ps1"] \ No newline at end of file diff --git a/Functions/AzureDevOps/Get-ADOAuditLog.ps1 b/Functions/AzureDevOps/Get-ADOAuditLog.ps1 index 73c55df9..2b75e7c1 100644 --- a/Functions/AzureDevOps/Get-ADOAuditLog.ps1 +++ b/Functions/AzureDevOps/Get-ADOAuditLog.ps1 @@ -1,48 +1,56 @@ 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 + <# -#> + .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 + # 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. + + # The size of the batch of audit log entries. [Parameter(ValueFromPipelineByPropertyName)] [int] $BatchSize, -# The start time. + + # The start time. [Parameter(ValueFromPipelineByPropertyName)] [DateTime] $StartTime, -# The end time. + + # The end time. [Parameter(ValueFromPipelineByPropertyName)] [DateTime] $EndTime, -# The api-version. By default, 7.1-preview.1 + + # 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 { + 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. @@ -74,10 +82,12 @@ $Organization, ) ) '@, '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 + '=' } @@ -89,8 +99,11 @@ $Organization, return '' } } + + $myCmd = $MyInvocation.MyCommand function ConvertRestInput { + param([Collections.IDictionary]$RestInput = @{}, [switch]$ToQueryString) foreach ($ri in @($RestInput.GetEnumerator())) { $RestParameterAttributes = @($myCmd.Parameters[$ri.Key].Attributes) @@ -140,8 +153,8 @@ $Organization, } -} -process { + } + process { $InvokeCommand = 'Invoke-ADORestAPI' $invokerCommandinfo = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Invoke-ADORestAPI', 'All') @@ -158,12 +171,16 @@ process { 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]@{} @@ -173,7 +190,10 @@ process { $uriParameter[$uriParameterName] = $psBoundParameters[$uriParameterName] } } + $uri = $RestVariable.Replace($originalUri, $ReplaceRestVariable) + + $invokeSplat = @{} $invokeSplat.Uri = $uri if ($method) { @@ -182,9 +202,13 @@ process { 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)) { @@ -196,7 +220,10 @@ process { } } } + + $queryParams = ConvertRestInput $queryParams -ToQueryString + if ($invokerCommandinfo.Parameters['QueryParameter'] -and $invokerCommandinfo.Parameters['QueryParameter'].ParameterType -eq [Collections.IDictionary]) { $invokeSplat.QueryParameter = $QueryParams @@ -218,6 +245,8 @@ process { $invokeSplat.Uri = "$($invokeSplat.Uri)" + '?' + $queryParamStr } } + + Write-Verbose "$($invokeSplat.Uri)" if ($ForEachOutput) { if ($ForEachOutput.Ast.ProcessBlock) { @@ -228,6 +257,7 @@ process { } else { & $invokerCommandinfo @invokeSplat } -} + + } } diff --git a/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 b/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 index c4ea6073..ae1c0b8f 100644 --- a/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 +++ b/Functions/AzureDevOps/Get-ADOServiceHealth.ps1 @@ -1,47 +1,53 @@ 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 + <# -#> + .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. + # 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. + + # 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 + + # The api-version. By default, 6.0 [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty("api-version")] [string] $ApiVersion = '6.0-preview' ) - dynamicParam { . $GetInvokeParameters -DynamicParameter -} - begin { + 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) @@ -91,8 +97,8 @@ function Get-ADOServiceHealth { } -} -process { + } + process { $InvokeCommand = 'Invoke-ADORestAPI' $invokerCommandinfo = $ExecutionContext.SessionState.InvokeCommand.GetCommand('Invoke-ADORestAPI', 'All') @@ -109,14 +115,19 @@ process { 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) { @@ -125,9 +136,13 @@ process { 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)) { @@ -139,7 +154,10 @@ process { } } } + + $queryParams = ConvertRestInput $queryParams -ToQueryString + if ($invokerCommandinfo.Parameters['QueryParameter'] -and $invokerCommandinfo.Parameters['QueryParameter'].ParameterType -eq [Collections.IDictionary]) { $invokeSplat.QueryParameter = $QueryParams @@ -161,6 +179,8 @@ process { $invokeSplat.Uri = "$($invokeSplat.Uri)" + '?' + $queryParamStr } } + + Write-Verbose "$($invokeSplat.Uri)" if ($ForEachOutput) { if ($ForEachOutput.Ast.ProcessBlock) { @@ -171,7 +191,8 @@ process { } else { & $invokerCommandinfo @invokeSplat } -} + + } } diff --git a/GitHub/Jobs/BuildPSDevOps.psd1 b/GitHub/Jobs/BuildPSDevOps.psd1 index d9d89db3..1f3b7c9b 100644 --- a/GitHub/Jobs/BuildPSDevOps.psd1 +++ b/GitHub/Jobs/BuildPSDevOps.psd1 @@ -4,15 +4,12 @@ steps = @( @{ name = 'Check out repository' - uses = 'actions/checkout@v2' - }, - @{ - name = 'Use PSSVG Action' - uses = 'StartAutomating/PSSVG@main' - id = 'PSSVG' + uses = 'actions/checkout@v4' }, + 'RunPSSVG', 'RunPipeScript', 'RunEZOut', - 'RunHelpOut' + 'RunHelpOut', + 'BuildAndPublishContainer' ) } \ No newline at end of file diff --git a/GitHub/Steps/BuildAndPublishContainer.psd1 b/GitHub/Steps/BuildAndPublishContainer.psd1 new file mode 100644 index 00000000..4145af33 --- /dev/null +++ b/GitHub/Steps/BuildAndPublishContainer.psd1 @@ -0,0 +1,57 @@ +@{ + 'name'='Log in to ghcr.io' + 'uses'='docker/login-action@master' + 'with'=@{ + 'registry'='${{ env.REGISTRY }}' + 'username'='${{ github.actor }}' + 'password'='${{ secrets.GITHUB_TOKEN }}' + } + env = @{ + 'REGISTRY'='ghcr.io' + } +} +@{ + name = 'Extract Docker Metadata (for branch)' + if = '${{github.ref_name != ''main'' && github.ref_name != ''master'' && github.ref_name != ''latest''}}' + id = 'meta' + uses = 'docker/metadata-action@master' + with = @{ + 'images'='${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}' + } + env = @{ + REGISTRY = 'ghcr.io' + IMAGE_NAME = '${{ github.repository }}' + } +} +@{ + name = 'Extract Docker Metadata (for main)' + if = '${{github.ref_name == ''main'' || github.ref_name == ''master'' || github.ref_name == ''latest''}}' + id = 'metaMain' + uses = 'docker/metadata-action@master' + with = @{ + 'images'='${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}' + 'flavor'='latest=true' + } +} +@{ + name = 'Build and push Docker image (from main)' + if = '${{github.ref_name == ''main'' || github.ref_name == ''master'' || github.ref_name == ''latest''}}' + uses = 'docker/build-push-action@master' + with = @{ + 'context'='.' + 'push'='true' + 'tags'='${{ steps.metaMain.outputs.tags }}' + 'labels'='${{ steps.metaMain.outputs.labels }}' + } +} +@{ + name = 'Build and push Docker image (from branch)' + if = '${{github.ref_name != ''main'' && github.ref_name != ''master'' && github.ref_name != ''latest''}}' + uses = 'docker/build-push-action@master' + with = @{ + 'context'='.' + 'push'='true' + 'tags'='${{ steps.meta.outputs.tags }}' + 'labels'='${{ steps.meta.outputs.labels }}' + } +} \ No newline at end of file diff --git a/GitHub/Steps/Checkout.psd1 b/GitHub/Steps/Checkout.psd1 index 0f2210f5..fe5e294f 100644 --- a/GitHub/Steps/Checkout.psd1 +++ b/GitHub/Steps/Checkout.psd1 @@ -1,4 +1,4 @@ @{ name = 'Check out repository' - uses = 'actions/checkout@v2' + uses = 'actions/checkout@v4' } diff --git a/GitHub/Steps/PublishTestResults.psd1 b/GitHub/Steps/PublishTestResults.psd1 index be36ac60..894144af 100644 --- a/GitHub/Steps/PublishTestResults.psd1 +++ b/GitHub/Steps/PublishTestResults.psd1 @@ -1,6 +1,6 @@ @{ name = 'PublishTestResults' - uses = 'actions/upload-artifact@v2' + uses = 'actions/upload-artifact@v3' with = @{ name = 'PesterResults' path = '**.TestResults.xml' diff --git a/GitHub/Steps/RunPSSVG.psd1 b/GitHub/Steps/RunPSSVG.psd1 new file mode 100644 index 00000000..a9da053c --- /dev/null +++ b/GitHub/Steps/RunPSSVG.psd1 @@ -0,0 +1,5 @@ +@{ + name = 'Use PSSVG Action' + uses = 'StartAutomating/PSSVG@main' + id = 'PSSVG' +} \ No newline at end of file diff --git a/GitHub/Steps/RunPester.ps1 b/GitHub/Steps/RunPester.ps1 index 68bcdeeb..5919d627 100644 --- a/GitHub/Steps/RunPester.ps1 +++ b/GitHub/Steps/RunPester.ps1 @@ -39,9 +39,6 @@ if ($NoCoverage) { $result = Invoke-Pester -PassThru -Verbose -OutputFile ".\$moduleName.TestResults.xml" -OutputFormat NUnitXml @codeCoverageParameters -"::set-output name=TotalCount::$($result.TotalCount)", -"::set-output name=PassedCount::$($result.PassedCount)", -"::set-output name=FailedCount::$($result.FailedCount)" | Out-Host if ($result.FailedCount -gt 0) { "::debug:: $($result.FailedCount) tests failed" foreach ($r in $result.TestResult) { diff --git a/PSDevOps.GitHubWorkflow.psdevops.ps1 b/PSDevOps.GitHubWorkflow.psdevops.ps1 index ef4209d7..1998a2ed 100644 --- a/PSDevOps.GitHubWorkflow.psdevops.ps1 +++ b/PSDevOps.GitHubWorkflow.psdevops.ps1 @@ -1,10 +1,10 @@ #requires -Module PSDevOps + Push-Location $PSScriptRoot 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 +} -OutputPath .\.github\workflows\TestAndPublish.yml Pop-Location \ No newline at end of file diff --git a/PSDevOps.PSSVG.ps1 b/PSDevOps.PSSVG.ps1 index d945cbf4..dce48e10 100644 --- a/PSDevOps.PSSVG.ps1 +++ b/PSDevOps.PSSVG.ps1 @@ -6,7 +6,7 @@ if (-not (Test-path $assetsPath)) { $null = New-Item -ItemType Directory -Path $assetsPath -Force } = -ViewBox 200, 100 -OutputPath (Join-Path $assetsPath "PSDevOps.svg") -Content @( - $commonParameters = @{ + $commonParameters = [Ordered]@{ Fill = '#4488FF' Stroke = 'black' StrokeWidth = '0.05' diff --git a/PSDevOps.format.ps1xml b/PSDevOps.format.ps1xml index c9d49e4b..8fcead27 100644 --- a/PSDevOps.format.ps1xml +++ b/PSDevOps.format.ps1xml @@ -1,5 +1,5 @@ - + @@ -9,6 +9,9 @@ + + -not @($_.geographies.Health -ne 'Healthy') + $moduleName = 'PSDevOps' do { @@ -47,9 +50,15 @@ + + -not @($_.geographies.Health -ne 'Healthy') + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' + + @($_.geographies.Health -ne 'Healthy') + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' @@ -61,6 +70,9 @@ + + @($_.geographies.Health -ne 'Healthy') + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' @@ -84,6 +96,9 @@ + + $_.Health -eq 'Healthy' + $moduleName = 'PSDevOps' do { @@ -122,9 +137,15 @@ + + $_.Health -eq 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' + + $_.Health -ne 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' @@ -136,6 +157,9 @@ + + $_.Health -ne 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' @@ -165,7 +189,7 @@ .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)) + * 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({ @@ -174,12 +198,13 @@ if (-not ($canUseANSI -or $canUseHTML)) { return $false} return $true })] + [OutputType([string])] param( # The input object [Parameter(ValueFromPipeline)] [PSObject] $InputObject, - + # The foreground color [string]$ForegroundColor, @@ -214,8 +239,23 @@ # If set, will invert text [switch]$Invert, + + # If provided, will create a hyperlink to a given uri + [Alias('Hyperlink', 'Href')] + [uri] + $Link, + # If set, will not clear formatting - [switch]$NoClear + [switch]$NoClear, + + # The alignment. Defaulting to Left. + # Setting an alignment will pad the remaining space on each line. + [ValidateSet('Left','Right','Center')] + [string] + $Alignment, + + # The length of a line. By default, the buffer width + [int]$LineLength = $($host.UI.RawUI.BufferSize.Width) ) begin { @@ -225,12 +265,27 @@ Output='';Error='BrightRed';Warning='BrightYellow'; Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; Success='BrightGreen';Failure='Red';Default=''} + + $ansiCode = [Regex]::new(@' + (?<ANSI_Code> + (?-i)\e # An Escape + \[ # Followed by a bracket + (?<ParameterBytes>[\d\:\;\<\=\>\?]{0,}) # Followed by zero or more parameter + bytes + (?<IntermediateBytes>[\s\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/]{0,}) # Followed by zero or more + intermediate bytes + (?<FinalByte>[\@ABCDEFGHIJKLMNOPQRSTUVWXYZ\[\\\]\^_\`abcdefghijklmnopqrstuvwxyz\{\|\}\~]) # Followed by a final byte + + ) +'@) $esc = [char]0x1b $standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' $brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' + $allOutput = @() + $n =0 - $cssClasses = @() + $cssClasses = @() $colorAttributes = @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { $n++ @@ -407,6 +462,21 @@ if ($canUseHTML) { "border-bottom: 3px double;"} elseif ($canUseANSI) {'' +$esc + "[21m" } } + + if ($Alignment -and $canUseHTML) { + "display:block;text-align:$($Alignment.ToLower())" + } + + if ($Link) { + if ($canUseHTML) { + # Hyperlinks need to be a nested element + # so we will not add it to style attributes for HTML + } + elseif ($canUseANSI) { + # For ANSI, + '' + $esc + ']8;;' + $Link + $esc + '\' + } + } ) @@ -416,61 +486,102 @@ if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} )$( if ($cssClasses) { " class='$($cssClasses -join ' ')'"} - )>" + )>" + $( + if ($Link) { + "<a href='$link'>" + } + ) } elseif ($canUseANSI) { $styleAttributes -join '' } } process { - if ($header) { - "$header" + "$(if ($inputObject) { $inputObject | Out-String})".Trim() - } - elseif ($inputObject) { - ($inputObject | Out-String).Trim() - } + $inputObjectAsString = + "$(if ($inputObject) { $inputObject | Out-String})".Trim() + + $inputObjectAsString = + if ($Alignment -and -not $canUseHTML) { + (@(foreach ($inputObjectLine in ($inputObjectAsString -split '(?>\r\n|\n)')) { + $inputObjectLength = $ansiCode.Replace($inputObjectLine, '').Length + if ($inputObjectLength -lt $LineLength) { + if ($Alignment -eq 'Left') { + $inputObjectLine + } elseif ($Alignment -eq 'Right') { + (' ' * ($LineLength - $inputObjectLength)) + $inputObjectLine + } else { + $half = ($LineLength - $inputObjectLength)/2 + (' ' * [Math]::Floor($half)) + $inputObjectLine + + (' ' * [Math]::Ceiling($half)) + } + } + else { + $inputObjectLine + } + }) -join [Environment]::NewLine) + [Environment]::newline + } else { + $inputObjectAsString + } + + $allOutput += + if ($header) { + "$header" + $inputObjectAsString + } + elseif ($inputObject) { + $inputObjectAsString + } } end { if (-not $NoClear) { - if ($canUseHTML) { - "</span>" - } - elseif ($canUseANSI) { - if ($Bold -or $Faint -or $colorAttributes -match '\[1;') { - "$esc[22m" - } - if ($Italic) { - "$esc[23m" - } - if ($Underline -or $doubleUnderline) { - "$esc[24m" - } - if ($Blink) { - "$esc[25m" - } - if ($Invert) { - "$esc[27m" - } - if ($hide) { - "$esc[28m" - } - if ($Strikethru) { - "$esc[29m" - } - if ($ForegroundColor) { - "$esc[39m" - } - if ($BackgroundColor) { - "$esc[49m" + $allOutput += + if ($canUseHTML) { + if ($Link) { + "</a>" + } + "</span>" } - - if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { - '' + $esc + '[0m' + elseif ($canUseANSI) { + if ($Bold -or $Faint -or $colorAttributes -match '\[1;') { + "$esc[22m" + } + if ($Italic) { + "$esc[23m" + } + if ($Underline -or $doubleUnderline) { + "$esc[24m" + } + 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 ($Link) { + "$esc]8;;$esc\" + } + + if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { + '' + $esc + '[0m' + } } - } } + + $allOutput -join '' } @@ -799,6 +910,9 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + $_.Status.Health -eq 'Healthy' + $moduleName = 'PSDevOps' do { @@ -837,9 +951,15 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + $_.Status.Health -eq 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Success' ) -join '' + + $_.Status.Health -ne 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' -NoClear) -join '' @@ -851,6 +971,9 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + $_.Status.Health -ne 'Healthy' + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'Warning' ) -join '' @@ -975,6 +1098,11 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) $_.Definition.Name + ' ' + $_.BuildNumber + ' [' + + + $_.Result -eq 'Succeeded' + + $moduleName = 'PSDevOps' do { @@ -1015,9 +1143,19 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + + $_.Result -eq 'Succeeded' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Succeeded' ) -join '' + + + $_.Result -eq 'Failed' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' -NoClear) -join '' @@ -1031,9 +1169,19 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + + $_.Result -eq 'Failed' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.Failed' ) -join '' + + + $_.Status -eq 'notStarted' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' -NoClear) -join '' @@ -1047,9 +1195,19 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + + $_.Status -eq 'notStarted' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.NotStarted' ) -join '' + + + $_.Status -eq 'inProgress' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' -NoClear) -join '' @@ -1067,6 +1225,11 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) + + + $_.Status -eq 'inProgress' + + @(& ${PSDevOps_Format-RichText} -ForegroundColor 'PSDevOps.Build.InProgress' ) -join '' @@ -1282,18 +1445,18 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) } while ($false) - - $__ = $_ - $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 "" - + + $CellColorValue = $($Script:_LastCellStyle = $($__ = $_;. {"Success"};$_ = $__);$Script:_LastCellStyle) + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'Name'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + ScriptType @@ -1404,58 +1567,50 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) } while ($false) - - $__ = $_ - $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 = . {$_.'Number'} - @($ci; $output; & ${PSDevOps_Format-RichText}) -join "" - - - - - $__ = $_ - $ci = . { + + $CellColorValue = $($Script:_LastCellStyle = $($__ = $_;. { 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. - } -} - $_ = $__ - 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 "" - +};$_ = $__);$Script:_LastCellStyle) + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'Number'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + + + + + $CellColorValue = $Script:_LastCellStyle + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'State'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + + + + + $CellColorValue = $Script:_LastCellStyle + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'Title'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + @@ -2161,33 +2316,8 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) } while ($false) - - $__ = $_ - $ci = . { - if ($_.PassedTests -lt $_.TotalTests) { - if ($_.PassedTests -lt ($_.TotalTests / 2)) { - 'Red' - } else { - 'Yellow' - } - } 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 = . { + + $CellColorValue = $($Script:_LastCellStyle = $($__ = $_;. { if ($_.PassedTests -lt $_.TotalTests) { if ($_.PassedTests -lt ($_.TotalTests / 2)) { 'Red' @@ -2197,64 +2327,59 @@ return (([string]$Character) * ($Host.UI.RawUI.BufferSize.Width - 1)) } 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' - } - } 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' - } - } else { - 'Green' - } -} - $_ = $__ - 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 "" - +};$_ = $__);$Script:_LastCellStyle) + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'Name'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + + + + + $CellColorValue = $Script:_LastCellStyle + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'IsAutomated'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + + + + + $CellColorValue = $Script:_LastCellStyle + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'TotalTests'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + + + + + $CellColorValue = $Script:_LastCellStyle + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${PSDevOps_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'PassedTests'} + @($CellColorValue; $output; & ${PSDevOps_Format-RichText}) -join '' + diff --git a/PSDevOps.types.ps1xml b/PSDevOps.types.ps1xml index 324ec937..76938ee9 100644 --- a/PSDevOps.types.ps1xml +++ b/PSDevOps.types.ps1xml @@ -1,5 +1,5 @@ - + PSDevOps.Agent diff --git a/docs/Add-ADOAreaPath.md b/docs/Add-ADOAreaPath.md index 572358ed..3be2f440 100644 --- a/docs/Add-ADOAreaPath.md +++ b/docs/Add-ADOAreaPath.md @@ -1,147 +1,96 @@ Add-ADOAreaPath --------------- + ### Synopsis Adds an Azure DevOps AreaPath --- + ### Description Adds an Azure DevOps AreaPath. AreaPaths are used to logically group work items within a project. --- + ### Related Links * [Get-ADOAreaPath](Get-ADOAreaPath.md) - - * [Remove-ADOAreaPath](Remove-ADOAreaPath.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-ADOAreaPath -Organization MyOrg -Project MyProject -AreaPath MyAreaPath ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Add-ADOAreaPath -Organization MyOrg -Project MyProject -AreaPath MyAreaPath\MyNestedPath ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AreaPath** - The AreaPath. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.AreaPath - - - --- + ### Syntax ```PowerShell Add-ADOAreaPath [-Organization] [-Project] [-AreaPath] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Add-ADOAttachment.md b/docs/Add-ADOAttachment.md index 7cb0c972..0ff3894f 100644 --- a/docs/Add-ADOAttachment.md +++ b/docs/Add-ADOAttachment.md @@ -1,164 +1,98 @@ Add-ADOAttachment ----------------- + ### Synopsis Adds an ADO Attachment --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Add-ADOAttachment -Path .\a.zip ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Add-ADOAttachment -Path .\summary.md -IsSummary ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Add-ADOAttachment -Path .\log.txt -IsLog ``` --- + ### Parameters #### **Path** - The attachment path. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|true |named |true (ByPropertyName)|Fullname| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The Attachment name. This is used to upload information for an Azure DevOps extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Type** - The Attachment type. This is used to upload information for an Azure DevOps extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ContainerFolder** - The Container Folder. This is required when uploading artifacts. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ArtifactName** - The Artifact Name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsSummary** - If set, the upload will be treated as a summary. Summary uploads must be markdown. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Summary| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsLog** - If set, the upload will be treated as a log file. - - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Log | --- + ### Outputs * [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) - - - --- + ### Syntax ```PowerShell Add-ADOAttachment -Path [] @@ -175,4 +109,3 @@ Add-ADOAttachment -Path -IsSummary [] ```PowerShell Add-ADOAttachment -Path [-Name] [-Type] [] ``` ---- diff --git a/docs/Add-ADODashboard.md b/docs/Add-ADODashboard.md index 18dd3b6d..31811cb6 100644 --- a/docs/Add-ADODashboard.md +++ b/docs/Add-ADODashboard.md @@ -1,27 +1,30 @@ Add-ADODashboard ---------------- + ### Synopsis Creates Dashboards and Widgets --- + ### Description Creates Dashboards from Azure DevOps, or Creates Widgets in a Dashboard in Azure Devops. --- + ### Related Links * [Get-ADODashboard](Get-ADODashboard.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-ADODashboard -Organization MyOrg -Project MyProject -Team MyTeam -Name MyDashboard ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADODashboard -Organization MyOrg -Project MyProject -Team MyTeam | Select-Object -First 1 | @@ -29,288 +32,136 @@ Get-ADODashboard -Organization MyOrg -Project MyProject -Team MyTeam | ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Team** - The Team. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the dashboard or widget. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - A description of the dashboard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Widget** - Widgets created with the dashboard. +|Type |Required|Position|PipelineInput | +|--------------|--------|--------|---------------------| +|`[PSObject[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[PSObject[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DashboardID** - The DashboardID. This dashboard will contain the new widgets. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ContributionID** - The ContributionID. This describes the exact extension contribution the widget will use. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Row** - The row of the widget. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Column** - The column of the widget. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RowSpan** - The number of rows the widget should occupy. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ColumnSpan** - The number of columns the widget should occupy. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Setting** - The widget settings. Settings are specific to each widget. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------| +|`[PSObject]`|false |named |true (ByPropertyName)|Settings| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Dashboard - * PSDevOps.Widget - - - --- + ### Syntax ```PowerShell Add-ADODashboard -Organization -Project [-Team ] -Name [-Description ] [-Widget ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -318,4 +169,3 @@ Add-ADODashboard -Organization -Project [-Team ] -Name ```PowerShell 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 f22a914c..de08999a 100644 --- a/docs/Add-ADOIterationPath.md +++ b/docs/Add-ADOIterationPath.md @@ -1,181 +1,110 @@ Add-ADOIterationPath -------------------- + ### Synopsis Adds an Azure DevOps IterationPath --- + ### Description Adds an Azure DevOps IterationPath. IterationPaths are used to logically group work items within a project. --- + ### Related Links * [Get-ADOIterationPath](Get-ADOIterationPath.md) - - * [Remove-ADOIterationPath](Remove-ADOIterationPath.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-ADOIterationPath -Organization MyOrg -Project MyProject -IterationPath MyIterationPath ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Add-ADOIterationPath -Organization MyOrg -Project MyProject -IterationPath MyIterationPath\MyNestedPath ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IterationPath** - The IterationPath. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **StartDate** - The start date of the iteration. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[DateTime]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EndDate** - The end date of the iteration. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[DateTime]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.IterationPath - - - --- + ### Syntax ```PowerShell Add-ADOIterationPath [-Organization] [-Project] [-IterationPath] [[-StartDate] ] [[-EndDate] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Add-ADOPicklist.md b/docs/Add-ADOPicklist.md index 6d5bf962..43fefecc 100644 --- a/docs/Add-ADOPicklist.md +++ b/docs/Add-ADOPicklist.md @@ -1,200 +1,117 @@ Add-ADOPicklist --------------- + ### Synopsis Creates Picklists --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Add-ADOPicklist -Organization MyOrg -PicklistName TShirtSize -Item S, M, L, XL ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PicklistName** - The name of the picklist +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |named |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DateType** - The data type of the picklist. By default, String. - - - Valid Values: * Double * Integer * String +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IsSuggested** - If set, will make the items in the picklist "suggested", and allow user input. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Item** - A list of items. By default, these are the initial contents of the picklist. If a PicklistID is provided, or -PicklistName already exists, will add these items to the picklist. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------------------------| +|`[String[]]`|true |named |true (ByPropertyName)|Value
Items
Values| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PicklistID** - The PicklistID of an existing picklist. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Picklist.Detail - - - --- + ### Syntax ```PowerShell Add-ADOPicklist -Organization -PicklistName [-DateType ] [-IsSuggested] -Item [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -202,4 +119,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 65ce1b8e..aa3974ae 100644 --- a/docs/Add-ADOTeam.md +++ b/docs/Add-ADOTeam.md @@ -1,191 +1,111 @@ Add-ADOTeam ----------- + ### Synopsis Gets Azure DevOps Teams --- + ### Description Gets teams from Azure DevOps or TFS --- + ### Related Links * [Get-ADOTeam](Get-ADOTeam.md) - - * [Get-ADOProject](Get-ADOProject.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-ADOTeam -Organization StartAutomating -Project PSDevOps -Team MyNewTeam -WhatIf ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Team** - The Team Name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - The Team Description. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UserDescriptor** - The Security Descriptor of the User. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------| +|`[String]`|true |named |false |SubjectDescriptor| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TeamDescriptor** - The Security Descriptor of the Team. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------------------------------------| +|`[String]`|true |named |false |ContainerDescriptor
GroupDescriptor| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Team - - - --- + ### Syntax ```PowerShell Add-ADOTeam -Organization -Project -Team [-Description ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -193,4 +113,3 @@ Add-ADOTeam -Organization -Project -Team [-Descriptio ```PowerShell Add-ADOTeam -Organization -UserDescriptor -TeamDescriptor [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Add-ADOWiki.md b/docs/Add-ADOWiki.md index 8a3f92ce..95b9afd6 100644 --- a/docs/Add-ADOWiki.md +++ b/docs/Add-ADOWiki.md @@ -1,207 +1,123 @@ Add-ADOWiki ----------- + ### Synopsis Creates Azure DevOps Wikis --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Add-ADOWiki -Organization MyOrg -Project MyProject -Name MyWiki ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADORepository -Organization MyOrg -Project MyProject | Add-ADOWiki -Name BuildHistory ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the wiki. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RepositoryID** - The ID of the repository used for the wiki. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WikiType** - The type of the wiki. This can be either 'ProjectWiki' or 'CodeWiki'. If a -RepositoryID is provided, this will be ignored as it must be a CodeWiki. - - - Valid Values: * ProjectWiki * CodeWiki +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RootPath** - The root path of the wiki within the repository. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[String]`|false |6 |true (ByPropertyName)|MappedPath| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Wiki - - - --- + ### Syntax ```PowerShell 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 a2eecc6c..c6211b66 100644 --- a/docs/Add-Git.md +++ b/docs/Add-Git.md @@ -1,259 +1,151 @@ Add-Git ------- + ### Synopsis PowerShell wrapper around git add --- + ### Description Adds changes to a git changelist --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-Git AddGit.ps1 ``` --- + ### Parameters #### **Path** - The path to add to git. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------| +|`[String[]]`|false |named |true (ByPropertyName)|Fullname| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DryRun** - Don't actually add the file(s), just show if they exist and/or will be ignored. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|false |named |true (ByPropertyName)|--dry-run
N| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Force** - Allow adding otherwise ignored files. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|false |named |true (ByPropertyName)|--force
F| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Interactive** - Add modified contents in the working tree interactively to the index. Optional path arguments may be supplied to limit operation to a subset of the working tree. See Interactive mode for details. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------| +|`[Switch]`|false |named |true (ByPropertyName)|--interactive
I| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Patch** - Interactively choose hunks of patch between the index and the work tree and add them to the index. This gives the user a chance to review the difference before adding modified contents to the index. - This effectively runs add --interactive, but bypasses the initial command menu and directly jumps to the patch subcommand. See 'Interactive mode' for details. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|false |named |true (ByPropertyName)|--patch
P| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Edit** - Open the diff vs. the index in an editor and let the user edit it. After the editor was closed, adjust the hunk headers and apply the patch to the index. - The intent of this option is to pick and choose lines of the patch to apply, or even to modify the contents of lines to be staged. This can be quicker and more flexible than using the interactive hunk selector. However, it is easy to confuse oneself and create a patch that does not apply to the index. See EDITING PATCHES below. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|false |named |true (ByPropertyName)|--edit
E| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IntentToAdd** - Record only the fact that the path will be added later. An entry for the path is placed in the index with no content. This is useful for, among other things, showing the unstaged content of such files with git diff and committing them with git commit -a. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|false |named |true (ByPropertyName)|--intent-to-add| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Refresh** - Don't add the file(s), but only refresh their stat() information in the index. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|false |named |true (ByPropertyName)|--refresh| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IgnoreErrors** - If some files could not be added because of errors indexing them, do not abort the operation, but continue adding the others. The command shall still exit with non-zero status. The configuration variable add.ignoreErrors can be set to true to make this the default behaviour. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|false |named |true (ByPropertyName)|--ignore-errors| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IgnoreMissing** - This option can only be used together with --dry-run. By using this option the user can check if any of the given files would be ignored, no matter if they are already present in the work tree or not. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[Switch]`|false |named |true (ByPropertyName)|--ignore-missing| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Renormalize** - Apply the "clean" process freshly to all tracked files to forcibly add them again to the index. This is useful after changing core.autocrlf configuration or the text attribute in order to correct files added with wrong CRLF/LF line endings. This option implies -u. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|false |named |true (ByPropertyName)|--renormalize| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Syntax ```PowerShell 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 index c86ebc95..eb6f12f2 100644 --- a/docs/Assets/PSDevOps.svg +++ b/docs/Assets/PSDevOps.svg @@ -1,4 +1,5 @@ - + + @@ -11,4 +12,4 @@ ∞ - \ No newline at end of file + diff --git a/docs/Clear-ADODashboard.md b/docs/Clear-ADODashboard.md index d82550b0..4bb1bdcf 100644 --- a/docs/Clear-ADODashboard.md +++ b/docs/Clear-ADODashboard.md @@ -1,26 +1,27 @@ Clear-ADODashboard ------------------ + ### Synopsis Clears Azure DevOps Dashboards --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOTeam -Organization MyOrganization -PersonalAccessToken $pat | Get-ADODashboard | @@ -28,152 +29,80 @@ Get-ADOTeam -Organization MyOrganization -PersonalAccessToken $pat | ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Team** - The Team. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DashboardID** - The DashboardID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WidgetID** - The WidgetID. If provided, will get details about a given Azure DevOps Widget. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Dashboard - * PSDevOps.Widget - - - --- + ### Syntax ```PowerShell Clear-ADODashboard -Organization -Project [-Team ] -DashboardID -WidgetID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -181,4 +110,3 @@ Clear-ADODashboard -Organization -Project [-Team ] -Da ```PowerShell Clear-ADODashboard -Organization -Project [-Team ] -DashboardID [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Connect-ADO.md b/docs/Connect-ADO.md index 8dcee624..7424941b 100644 --- a/docs/Connect-ADO.md +++ b/docs/Connect-ADO.md @@ -1,9 +1,11 @@ Connect-ADO ----------- + ### Synopsis Connects to Azure DeVOps --- + ### Description Connects the current PowerShell session to Azure DeVOps or a Team Foundation Server. @@ -13,133 +15,74 @@ Information passed to Connect-ADO will be used as the default parameters to all PersonalAccessTokens will be cached separately to improve security. --- + ### Related Links * [Disconnect-ADO](Disconnect-ADO.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Connect-ADO -Organization StartAutomating -PersonalAccessToken $myPat ``` --- + ### Parameters #### **Organization** - The organization. When connecting to TFS, this is the Project Collection. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PersonalAccessToken** - The Personal Access Token. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|false |2 |true (ByPropertyName)|PAT | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UseDefaultCredentials** - If set, will use default credentials when connecting. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Credential** - The credential used to connect. +|Type |Required|Position|PipelineInput | +|----------------|--------|--------|---------------------| +|`[PSCredential]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[PSCredential]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The Server. If this points to a TFS server, it should be the root TFS url, i.e. http://localhost:8080/tfs +|Type |Required|Position|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 - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * PSDevOps.Connection - - - --- + ### Syntax ```PowerShell Connect-ADO [-Organization] [[-PersonalAccessToken] ] [-UseDefaultCredentials] [[-Credential] ] [[-Server] ] [-NoCache] [] ``` ---- diff --git a/docs/Connect-GitHub.md b/docs/Connect-GitHub.md index 4cab2477..51b47ccc 100644 --- a/docs/Connect-GitHub.md +++ b/docs/Connect-GitHub.md @@ -1,149 +1,84 @@ Connect-GitHub -------------- + ### Synopsis Connects to GitHub --- + ### Description Connects to GitHub, automatically creating smart aliases for all GitHub URLs. --- + ### Related Links * [Invoke-GitHubRESTAPI](Invoke-GitHubRESTAPI.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Connect-GitHub ``` --- + ### Parameters #### **GitHubOpenAPIUrl** - A URL that contains the GitHub OpenAPI definition +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the dynamically imported module. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Force** - If set, will force a reload of the module. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PersonalAccessToken** - The personal access token used to connect to GitHub. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Owner** - If provided, will default the [owner] in GitHub API requests +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |3 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **UserName** - If provided, will default the [username] in GitHub API requests +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |4 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Repo** - If provided, will default the [repo] in GitHub API requests - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |5 |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 3bf46cbd..94f3d054 100644 --- a/docs/Convert-ADOPipeline.md +++ b/docs/Convert-ADOPipeline.md @@ -1,26 +1,27 @@ Convert-ADOPipeline ------------------- + ### Synopsis Converts builds to Azure DevOps Pipelines --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell $taskList = (Get-ADOTask -Server $tfsRootUrl -Org $projectCollectionName) Get-ADOBuild -Definition -Server $tfsRootUrl -Org $projectCollection | @@ -28,107 +29,56 @@ Get-ADOBuild -Definition -Server $tfsRootUrl -Org $projectCollection | ``` --- + ### Parameters #### **BuildStep** - A list of build steps. This will be automatically populated when piping in a TFS Build definition. +|Type |Required|Position|PipelineInput |Aliases| +|--------------|--------|--------|---------------------|-------| +|`[PSObject[]]`|true |1 |true (ByPropertyName)|Build | - -> **Type**: ```[PSObject[]]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildVariable** - An object containing build variables. This will be automatically populated when piping in a TFS build definition. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------------| +|`[PSObject]`|false |2 |true (ByPropertyName)|Variable
Variables| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TaskList** - A list of task definitions. This will normally be the output from Get-ADOTask. +|Type |Required|Position|PipelineInput| +|--------------|--------|--------|-------------| +|`[PSObject[]]`|true |3 |false | - -> **Type**: ```[PSObject[]]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **WhereFore** - A dictionary of conditional transformations. +|Type |Required|Position|PipelineInput|Aliases | +|---------------|--------|--------|-------------|-------------------------| +|`[IDictionary]`|false |4 |false |WhereForeach
WhereFor| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Passthru** - If set, will output the dictionary used to create each pipeline. If not set, will output the pipeline YAML. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Convert-ADOPipeline [-BuildStep] [[-BuildVariable] ] [-TaskList] [[-WhereFore] ] [-Passthru] [] ``` ---- diff --git a/docs/Convert-BuildStep.md b/docs/Convert-BuildStep.md index 212b0ed9..e1dc5e3a 100644 --- a/docs/Convert-BuildStep.md +++ b/docs/Convert-BuildStep.md @@ -1,230 +1,118 @@ Convert-BuildStep ----------------- + ### Synopsis Converts Build Steps into build system input --- + ### Description Converts Build Steps defined in a PowerShell script into build steps in a build system --- + ### Related Links * [Import-BuildStep](Import-BuildStep.md) - - * [Expand-BuildStep](Expand-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-Command Convert-BuildStep | Convert-BuildStep ``` --- + ### Parameters #### **Name** - The name of the build step +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ScriptBlock** - The Script Block that will be converted into a build step +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|------------------------------| +|`[ScriptBlock]`|false |named |true (ByValue, ByPropertyName)| - -> **Type**: ```[ScriptBlock]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByValue, ByPropertyName) - - - ---- #### **Module** - The module that -ScriptBlock is declared in. If piping in a command, this will be bound automatically +|Type |Required|Position|PipelineInput | +|----------------|--------|--------|---------------------| +|`[PSModuleInfo]`|false |named |true (ByPropertyName)| - -> **Type**: ```[PSModuleInfo]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Path** - The path to the file +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |named |true (ByPropertyName)|Fullname| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Extension** - The extension of the file +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **InputParameter** - The name of parameters that should be supplied from event input. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|InputParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VariableParameter** - The name of parameters that should be supplied from build variables. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|------------------| +|`[String[]]`|false |named |true (ByPropertyName)|VariableParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EnvironmentParameter** - The name of parameters that should be supplied from the environment. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)|EnvironmentParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueParameter** - 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. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------| +|`[String[]]`|false |named |true (ByPropertyName)|UniqueParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeParameter** - The name of parameters that should be excluded. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------| +|`[String[]]`|false |named |true (ByPropertyName)|ExcludeParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefaultParameter** - Default parameters for a build step +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildSystem** - The build system. Currently supported options, ADO and GitHub. Defaulting to ADO. - - - Valid Values: * ADOPipeline @@ -232,43 +120,24 @@ Valid Values: * GitHubWorkflow * GitHubAction +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildOption** - Options for the build system. The can contain any additional parameters passed to the build system. - - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[PSObject]`|false |named |false | --- + ### Outputs * [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) - - - --- + ### Syntax ```PowerShell Convert-BuildStep -Name [-ScriptBlock ] [-Module ] [-Path ] [-InputParameter ] [-VariableParameter ] [-EnvironmentParameter ] [-UniqueParameter ] [-ExcludeParameter ] [-DefaultParameter ] [-BuildSystem ] [-BuildOption ] [] @@ -276,4 +145,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 0da72268..b9fb524d 100644 --- a/docs/Disable-ADOExtension.md +++ b/docs/Disable-ADOExtension.md @@ -1,142 +1,91 @@ Disable-ADOExtension -------------------- + ### Synopsis Disables Azure DevOps Extensions. --- + ### Description Disables one or more Azure DevOps Extensions. --- + ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) - - * [Enable-ADOExtension](Enable-ADOExtension.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disable-ADOExtension -Organization StartAutomating -PublisherID ms-samples -ExtensionID samples-contributions-guide ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PublisherID** - The Publisher of an Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExtensionID** - The name of the Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.InstalledExtension - - - --- + ### Syntax ```PowerShell Disable-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Disconnect-ADO.md b/docs/Disconnect-ADO.md index 2a206600..e22406b4 100644 --- a/docs/Disconnect-ADO.md +++ b/docs/Disconnect-ADO.md @@ -1,27 +1,31 @@ Disconnect-ADO -------------- + ### Synopsis Disconnects from Azure DevOps --- + ### Description Disconnects from Azure DevOps, clearing parameter value defaults and cached access tokens. --- + ### Related Links * [Connect-ADO](Connect-ADO.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-ADO ``` --- + ### Parameters #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -29,25 +33,21 @@ Disconnect-ADO #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Disconnect-ADO [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Disconnect-GitHub.md b/docs/Disconnect-GitHub.md index ae73f7aa..48f59329 100644 --- a/docs/Disconnect-GitHub.md +++ b/docs/Disconnect-GitHub.md @@ -1,9 +1,11 @@ Disconnect-GitHub ----------------- + ### Synopsis Disconnects from GitHub --- + ### Description Disconnects from GitHub. @@ -11,21 +13,22 @@ Disconnects from GitHub. This unloads any dynamically imported commands and clears the cached PersonalAccessToken. --- + ### Related Links * [Connect-GitHub](Connect-GitHub.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-GitHub ``` --- + ### Syntax ```PowerShell Disconnect-GitHub [] ``` ---- diff --git a/docs/Enable-ADOExtension.md b/docs/Enable-ADOExtension.md index 2277086d..d8918620 100644 --- a/docs/Enable-ADOExtension.md +++ b/docs/Enable-ADOExtension.md @@ -1,142 +1,91 @@ Enable-ADOExtension ------------------- + ### Synopsis Enables Azure DevOps Extensions. --- + ### Description Enables one or more Azure DevOps Extensions. --- + ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) - - * [Disable-ADOExtension](Disable-ADOExtension.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Enable-ADOExtension -Organization StartAutomating -PublisherID ms-samples -ExtensionID samples-contributions-guide ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PublisherID** - The Publisher of an Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExtensionID** - The name of the Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.InstalledExtension - - - --- + ### Syntax ```PowerShell Enable-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Expand-BuildStep.md b/docs/Expand-BuildStep.md index 382ace74..d0d45a13 100644 --- a/docs/Expand-BuildStep.md +++ b/docs/Expand-BuildStep.md @@ -1,159 +1,87 @@ Expand-BuildStep ---------------- + ### Synopsis Expands Build Steps in a single build object --- + ### Description Component Files are .ps1 or datafiles within a directory that tells you what type they are. --- + ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) - - * [Import-BuildStep](Import-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Expand-BuildStep -StepMap @{Steps='InstallPester','RunPester'} ``` --- + ### Parameters #### **StepMap** - A map of step properties to underlying data. Each key is the name of a property the output. Each value may contain the name of another Step or StepMap +|Type |Required|Position|PipelineInput| +|---------------|--------|--------|-------------| +|`[IDictionary]`|true |1 |false | - -> **Type**: ```[IDictionary]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **Parent** - The immediate parent object +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[PSObject]`|false |2 |false | - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **Root** - The absolute root object +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[PSObject]`|false |3 |false | - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **Singleton** - If set, the component will be expanded as a singleton (single object) +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **SingleItemName** - A list of item names that automatically become singletons +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |4 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **PluralItemName** - A list of item names that automatically become plurals +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |5 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:false - - - ---- #### **DictionaryItemName** - A list of item names that automatically become dictionaries. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |6 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:false - - - ---- #### **BuildSystem** - The build system, either ADO or GitHub. - - - Valid Values: * ADOPipeline @@ -161,152 +89,72 @@ Valid Values: * GitHubWorkflow * GitHubAction +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |7 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:false - - - ---- #### **VariableParameter** - The name of parameters that should be supplied from build variables. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|------------------| +|`[String[]]`|false |8 |true (ByPropertyName)|VariableParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **InputParameter** - The name of parameters that should be supplied from webhook events. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------| +|`[IDictionary]`|false |9 |true (ByPropertyName)|InputParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EnvironmentParameter** - The name of parameters that should be supplied from the environment. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------------------| +|`[String[]]`|false |10 |true (ByPropertyName)|EnvironmentParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueParameter** - 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. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------| +|`[String[]]`|false |11 |true (ByPropertyName)|UniqueParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeParameter** - The name of parameters that should be excluded. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------| +|`[String[]]`|false |12 |true (ByPropertyName)|ExcludeParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefaultParameter** - A collection of default parameters. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |13 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildOption** - Options for the build system. The can contain any additional parameters passed to the build system. - - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[PSObject]`|false |14 |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell 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 7b78987e..ca84a592 100644 --- a/docs/Get-ADOAgentPool.md +++ b/docs/Get-ADOAgentPool.md @@ -1,9 +1,11 @@ Get-ADOAgentPool ---------------- + ### Synopsis Gets Azure DevOps Agent Pools --- + ### Description Gets Agent Pools and their associated queues from Azure DevOps. @@ -15,191 +17,99 @@ Thus providing a project will return the queues associated with the project, 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 +> EXAMPLE 1 + ```PowerShell Get-ADOAgentPool -Organization MyOrganization -PersonalAccessToken $pat ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PoolID** - The Pool ID. When this is provided, will return agents associated with a given pool ID. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AgentName** - If provided, will return agents of a given name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeCapability** - If set, will return the capabilities of each returned agent. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|Capability
Capabilities
Environment| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeLastCompletedRequest** - If set, will return the last completed request of each returned agent. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|IncludeLastCompleted
LastCompleted
Completed| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeAssignedRequest** - If set, will return the requests queued for an agent. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|IncludeAssigned
IncludeQueue
Queued| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier. When this is provided, will return queues associated with the project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevops.Pool - - - --- + ### Syntax ```PowerShell Get-ADOAgentPool -Organization -PoolID [-AgentName ] [-IncludeCapability] [-IncludeLastCompletedRequest] [-IncludeAssignedRequest] [-Server ] [-ApiVersion ] [] @@ -210,4 +120,3 @@ Get-ADOAgentPool -Organization -Project [-Server ] [-ApiV ```PowerShell Get-ADOAgentPool -Organization [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOAreaPath.md b/docs/Get-ADOAreaPath.md index 93ff6358..7f2d6cb4 100644 --- a/docs/Get-ADOAreaPath.md +++ b/docs/Get-ADOAreaPath.md @@ -1,150 +1,89 @@ Get-ADOAreaPath --------------- + ### Synopsis Gets area paths --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOAreaPath -Organization StartAutomating -Project PSDevOps ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|true |2 |true (ByPropertyName)|ProjectID| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AreaPath** - The AreaPath +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 2.0. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |5 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:false - - - ---- #### **Depth** - The depth of items to get. By default, one. - - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |6 |false | --- + ### Outputs * PSDevOps.AreaPath - - - --- + ### Syntax ```PowerShell Get-ADOAreaPath [-Organization] [-Project] [[-AreaPath] ] [[-Server] ] [[-ApiVersion] ] [[-Depth] ] [] ``` ---- diff --git a/docs/Get-ADOArtifactFeed.md b/docs/Get-ADOArtifactFeed.md index 618d09bc..c860ea7b 100644 --- a/docs/Get-ADOArtifactFeed.md +++ b/docs/Get-ADOArtifactFeed.md @@ -1,357 +1,167 @@ Get-ADOArtifactFeed ------------------- + ### Synopsis Gets artifact feeds from Azure DevOps --- + ### Description Gets artifact feeds from Azure DevOps. Artifact feeds can be used to publish packages. --- + ### 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 +> EXAMPLE 1 + ```PowerShell Get-ADOArtifactFeed -Organization myOrganization -Project MyProject ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FeedID** - The name or ID of the feed. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[String]`|false |named |true (ByPropertyName)|fullyQualifiedId| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **View** - If set, will Get Artifact Feed Views +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Views | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Permission** - If set, will get artifact permissions +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------| +|`[Switch]`|true |named |true (ByPropertyName)|Permissions| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RetentionPolicy** - If set, will get artifact retention policies +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[Switch]`|true |named |true (ByPropertyName)|RetentionPolicies| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PackageVersionList** - If set, will list versions of a particular package. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|ListVersions
ListVersion
PackageVersions| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Provenance** - If set, will get provenance for a package version +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VersionID** - A package version ID. Only required when getting version provenance. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PackageList** - If set, will list packages within a feed. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|ListPackages
ListPackage
Packages| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeAllVersion** - If set, will include all versions of packages within a feed. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------| +|`[Switch]`|false |named |true (ByPropertyName)|IncludeAllVersions| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeDescription** - If set, will include descriptions of a package. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProtocolType** - If provided, will return packages of a given protocol. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NPM** - If set, will get information about a Node Package Manager module. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------| +|`[Switch]`|true |named |true (ByPropertyName)|NodePackageManager| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NuGet** - If set, will get information about a Nuget module. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Python** - If set, will get information about a Python module. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|PyPi | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Universal** - If set, will get information about a Universal package module. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|UPack | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PackageName** - The Package Name. Must be used with -NPM, -NuGet, -Python, or -Universal. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PackageVersion** - The Package Version. Must be used with -NPM, -NuGet, -Python, or -Universal. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FeedRole** - The Feed Role - - - Valid Values: * Administrator @@ -359,134 +169,63 @@ Valid Values: * Contributor * Reader +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PackageID** - A -PackageID. This can be used to get Packages -Metrics, -ListPackageVersion, or get -Provenance of a particular version. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Metric** - If set, will get package metrics. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Metrics| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeDeleted** - If set, will include deleted feeds. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Change** - If set, will get changes in artifact feeds. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|false |named |false |Changes| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://feeds.dev.azure.com/. +|Type |Required|Position|PipelineInput| +|-------|--------|--------|-------------| +|`[Uri]`|false |named |false | - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.ArtfiactFeed - * PSDevOps.ArtfiactFeed.View - * PSDevOps.ArtfiactFeed.Change - - - --- + ### Syntax ```PowerShell Get-ADOArtifactFeed -Organization [-Project ] [-FeedID ] [-IncludeDeleted] [-Change] [-Server ] [-ApiVersion ] [] @@ -527,4 +266,3 @@ Get-ADOArtifactFeed -Organization [-Project ] [-FeedID ```PowerShell Get-ADOArtifactFeed -Organization [-Project ] [-FeedID ] -PackageID -Metric [-IncludeDeleted] [-Change] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOAuditLog.md b/docs/Get-ADOAuditLog.md index 4c9d4be1..913f6e27 100644 --- a/docs/Get-ADOAuditLog.md +++ b/docs/Get-ADOAuditLog.md @@ -1,115 +1,70 @@ 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 +> EXAMPLE 1 + ```PowerShell Get-ADOAuditLog ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BatchSize** - The size of the batch of audit log entries. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **StartTime** - The start time. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[DateTime]`|false |named |true (ByPropertyName)| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EndTime** - The end time. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[DateTime]`|false |named |true (ByPropertyName)| - -> **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) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| --- + ### Syntax ```PowerShell Get-ADOAuditLog -Organization [-BatchSize ] [-StartTime ] [-EndTime ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOBuild.md b/docs/Get-ADOBuild.md index d8ad2ab9..a4389ef1 100644 --- a/docs/Get-ADOBuild.md +++ b/docs/Get-ADOBuild.md @@ -1,9 +1,11 @@ Get-ADOBuild ------------ + ### Synopsis Gets Azure DevOps Builds, Definitions, and associated information. --- + ### Description Gets Azure DevOps Builds or Definitions and associated information. @@ -31,501 +33,225 @@ Given a -Definition ID, we can get associated information: |-DefinitionMetadata| Gets metadata about a build definition | --- + ### 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 +> EXAMPLE 1 + ```PowerShell Get-ADOBuild -Organization StartAutomating -Project PSDevOps ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOBuild -Organization StartAutomating -Project PSDevOps -Definition ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://feeds.dev.azure.com/. +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildID** - Build ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detail** - If set +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|false |named |false |Details| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildMetadata** - If set, returns system metadata about the -BuildID. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Artifact** - If set, will get artifacts from -BuildID. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|true |named |true (ByPropertyName)|Artifacts| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Log** - If set, will get a list of logs associated with -BuildID +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Logs | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **LogID** - If provided, will retreive the specific log content of -BuildID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ChangeSet** - If set, will return the changeset associated with the build -BuildID. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Report** - If set, will return the build report associated with -BuildID. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Timeline** - If set, will return the timeline for build -BuildID +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **CodeCoverage** - If set, will return the code coverage associated with -BuildID +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Definition** - If set, will get build definitions. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DefinitionID** - If set, will get a specific build by definition ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Status** - If set, will get the status of a defined build. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------------| +|`[Switch]`|true |named |false |DefinitionStatus| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DefinitionMetadata** - If set, will get definition properties +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Revision** - If set, will get revisions to a build definition. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------------------------------------------------------| +|`[Switch]`|true |named |false |DefinitionRevisions
DefinitionRevision
Revisions| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Resource** - If set, will get authorized resources for a build definition. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Metric** - If set, will get metrics about a build definition. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------------------------------------------------| +|`[Switch]`|true |named |false |DefinitionMetric
DefinitionMetrics
Metrics| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **First** - If provided, will get the first N builds or build definitions +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[UInt32]`|false |named |false |Top | - -> **Type**: ```[UInt32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BranchName** - If provided, will only return builds for a given branch. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Tag** - If provided, will only return builds one of these tags. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |named |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **After** - If provided, will only return builds queued after this point in time. +|Type |Required|Position|PipelineInput|Aliases| +|------------|--------|--------|-------------|-------| +|`[DateTime]`|false |named |false |MinTime| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Before** - If provided, will only return builds queued before this point in time. +|Type |Required|Position|PipelineInput|Aliases| +|------------|--------|--------|-------------|-------| +|`[DateTime]`|false |named |false |MaxTime| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildResult** - If provided, will only return builds with this result. - - - Valid Values: * Canceled @@ -534,146 +260,71 @@ Valid Values: * Succeeded * PartiallySucceeded +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DefinitionName** - Will only return build definitions with the specified name. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuiltAfter** - If provided, will only return build definitions that have been built after this date. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[DateTime]`|false |named |false | - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **NotBuiltSince** - If provided, will only return build definitions that have not been built since this date. +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|-------------| +|`[DateTime]`|false |named |false |NotBuiltAfter| - -> **Type**: ```[DateTime]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeAllProperty** - If set, will return extended properities of a build definition. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------------------| +|`[Switch]`|false |named |false |IncludeAllProperties| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeLatestBuild** - If set, will include the latest build and latest completed build in a given build definition. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------------| +|`[Switch]`|false |named |false |IncludeLatestBuilds| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DefinitionYAML** - If provided, will return build definition YAML. No other information will be returned. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * PSDevOps.Build - * PSDevOps.Build.Definition - * PSDevOps.Build.Timeline - * PSDevOps.Build.Change - * PSDevOps.Build.Report - * PSDevOps.Build.Artifact - * PSDevOps.Build.CodeCoverage - - - --- + ### Syntax ```PowerShell Get-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] [-First ] [-BranchName ] [-Tag ] [-After ] [-Before ] [-BuildResult ] [] @@ -726,4 +377,3 @@ Get-ADOBuild -Organization -Project [-Server ] [-ApiVersi ```PowerShell Get-ADOBuild -Organization -Project [-Server ] [-ApiVersion ] -DefinitionID [-DefinitionYAML] [] ``` ---- diff --git a/docs/Get-ADODashboard.md b/docs/Get-ADODashboard.md index 9f69f8d3..ade75bd5 100644 --- a/docs/Get-ADODashboard.md +++ b/docs/Get-ADODashboard.md @@ -1,178 +1,101 @@ Get-ADODashboard ---------------- + ### Synopsis Gets Azure DevOps Dashboards --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOTeam -Organization MyOrganization -PersonalAccessToken $pat | Get-ADODashboard ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Team** - The Team. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DashboardID** - The DashboardID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Widget** - If set, will widgets within a dashboard. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Widgets| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WidgetID** - The WidgetID. If provided, will get details about a given Azure DevOps Widget. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Dashboard - * PSDevOps.Widget - - - --- + ### Syntax ```PowerShell Get-ADODashboard -Organization -Project [-Team ] [-Server ] [-ApiVersion ] [] @@ -186,4 +109,3 @@ Get-ADODashboard -Organization -Project [-Team ] -Dash ```PowerShell Get-ADODashboard -Organization -Project [-Team ] -DashboardID [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOExtension.md b/docs/Get-ADOExtension.md index f2eedf73..0d7ab12b 100644 --- a/docs/Get-ADOExtension.md +++ b/docs/Get-ADOExtension.md @@ -1,367 +1,181 @@ Get-ADOExtension ---------------- + ### Synopsis Gets Azure DevOps Extensions --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOExtension -Organization StartAutomating ``` --- + ### Parameters #### **Organization** - The organization. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExtensionNameLike** - A wildcard of the extension name. Only extensions where the Extension Name or ID matches the wildcard will be returned. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ExtensionNameMatch** - A regular expression of the extension name. Only extensions where the Extension Name or ID matches the wildcard will be returned. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PublisherNameLike** - A wildcard of the publisher name. Only extensions where the Publisher Name or ID matches the wildcard will be returned. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PublisherNameMatch** - A regular expression of the publisher name. Only extensions where the Publisher Name or ID matches the wildcard will be returned. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PublisherID** - The Publisher of the Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExtensionID** - The Extension Identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DataCollection** - The data collection +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------------------| +|`[String]`|true |named |true (ByPropertyName)|TableName
Table_Name
DocumentCollection| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DataID** - The data identifier +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------| +|`[String]`|false |named |true (ByPropertyName)|RowKey
DocumentID| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ScopeType** - The scope type. By default, the value "default" (which maps to Project Collection) - - - Valid Values: * Default * Project * User +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ScopeModifier** - The scope modifier. By default, the value "current" (which maps to the current project collection or project) - - - Valid Values: * Current * Me +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AssetType** - A list of asset types +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|----------| +|`[String[]]`|false |named |false |AssetTypes| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeDisabled** - If set, will include disabled extensions +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------| +|`[Switch]`|false |named |false |Disabled| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **InstallationIssue** - If set, will include extension installation issues +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------------------------------------------| +|`[Switch]`|false |named |false |IncludeInstallationIssue
IncludeInstallationIssues| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeError** - If set, will include errors +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------| +|`[Switch]`|false |named |false |IncludeErrors| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Contribution** - If set, will expand contributions. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------| +|`[Switch]`|false |named |false |Contributions| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.InstalledExtension - - - --- + ### Syntax ```PowerShell Get-ADOExtension -Organization [-Server ] [-ApiVersion ] [] @@ -375,4 +189,3 @@ Get-ADOExtension -Organization [-ExtensionNameLike ] [-Extensio ```PowerShell Get-ADOExtension -Organization -PublisherID -ExtensionID -DataCollection [-DataID ] [-ScopeType ] [-ScopeModifier ] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOField.md b/docs/Get-ADOField.md index d79aacd2..63187e24 100644 --- a/docs/Get-ADOField.md +++ b/docs/Get-ADOField.md @@ -1,182 +1,102 @@ Get-ADOField ------------ + ### Synopsis Gets fields from Azure DevOps --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOField -Organization StartAutomating -Project PSDevOps ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FieldName** - The name of the field. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProcessID** - The processs identifier. This is used to get field information related to a particular work process template. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|TypeID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WorkItemTypeName** - The name of the work item type. This is used to get field information related to a particular work process template. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Force** - If set, will force a refresh of the cached results. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|false |named |false |Refresh| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Field - - - --- + ### Syntax ```PowerShell Get-ADOField -Organization [-Project ] [-FieldName ] [-Server ] [-Force] [-ApiVersion ] [] @@ -184,4 +104,3 @@ Get-ADOField -Organization [-Project ] [-FieldName ] [- ```PowerShell Get-ADOField -Organization [-Project ] [-FieldName ] -ProcessID -WorkItemTypeName [-Server ] [-Force] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOIdentity.md b/docs/Get-ADOIdentity.md index a6268791..20e717c2 100644 --- a/docs/Get-ADOIdentity.md +++ b/docs/Get-ADOIdentity.md @@ -1,161 +1,87 @@ Get-ADOIdentity --------------- + ### Synopsis Gets Azure DevOps Identities --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOIdentity -Organization StartAutomating -Filter 'GitHub' ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AceDictionary** - A dictionary of Access Control Entries +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------------| +|`[PSObject]`|false |2 |true (ByPropertyName)|AcesDictionary| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Descriptors** - A list of descriptors +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[String[]]`|false |3 |true (ByPropertyName)|Members| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DescriptorBatchSize** - The maximum number of specific descriptors to request in one batch. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |4 |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Membership** - If set, will get membership information. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Recurse** - If set, will recursively expand any group memberships discovered. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Filter** - The filter used for a query +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |5 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:false - - - ---- #### **SearchType** - The search type. Can be: AccountName, DisplayName, MailAddress, General, LocalGroupName - - - Valid Values: * AccountName @@ -164,49 +90,28 @@ Valid Values: * General * LocalGroupName +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |6 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:false - - - ---- #### **ApiVersion** - The api version. By default, 6.0. This API does not exist in TFS. - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |7 |false | --- + ### Outputs * PSDevOps.Team - * PSDevOps.TeamMember - - - --- + ### Syntax ```PowerShell Get-ADOIdentity [-Organization] [[-AceDictionary] ] [[-Descriptors] ] [[-DescriptorBatchSize] ] [-Membership] [-Recurse] [[-Filter] ] [[-SearchType] ] [[-ApiVersion] ] [] ``` ---- diff --git a/docs/Get-ADOIterationPath.md b/docs/Get-ADOIterationPath.md index f18683a9..7204a955 100644 --- a/docs/Get-ADOIterationPath.md +++ b/docs/Get-ADOIterationPath.md @@ -1,146 +1,87 @@ Get-ADOIterationPath -------------------- + ### Synopsis Gets iteration paths --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOIterationPath -Organization StartAutomating -Project PSDevOps ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|true |2 |true (ByPropertyName)|ProjectID| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IterationPath** - The IterationPath +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 2.0. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |5 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:false - - - ---- #### **Depth** - The depth of items to get. By default, one. - - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |6 |false | --- + ### Outputs * PSDevOps.IterationPath - - - --- + ### Syntax ```PowerShell Get-ADOIterationPath [-Organization] [-Project] [[-IterationPath] ] [[-Server] ] [[-ApiVersion] ] [[-Depth] ] [] ``` ---- diff --git a/docs/Get-ADOPermission.md b/docs/Get-ADOPermission.md index 917b0459..c3531f7f 100644 --- a/docs/Get-ADOPermission.md +++ b/docs/Get-ADOPermission.md @@ -1,35 +1,34 @@ Get-ADOPermission ----------------- + ### Synopsis Gets Azure DevOps Permissions --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOPermission -Organization MyOrganization -Project MyProject -PersonalAccessToken $pat ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOProject -Organization MyOrganization -Project MyProject | # Get the project Get-ADOTeam | # get the teams within the project @@ -37,148 +36,68 @@ Get-ADOProject -Organization MyOrganization -Project MyProject | # Get the proje ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PermissionType** - If set, will list the type of permisssions. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------------------------------------------------------| +|`[Switch]`|false |named |false |SecurityNamespace
ListPermissionType
ListSecurityNamespace| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **NamespaceID** - The Security Namespace ID. For details about each namespace, see: https://docs.microsoft.com/en-us/azure/devops/organizations/security/namespace-reference +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SecurityToken** - The Security Token. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProjectID** - The Project ID. If this is provided without anything else, will get permissions for the projectID +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Project| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TeamID** - If provided, will get permissions related to a given teamID. ( see Get-ADOTeam) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AreaPath** - If provided, will get permissions related to an Area Path. ( see Get-ADOAreaPath ) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IterationPath** - If provided, will get permissions related to an Iteration Path. ( see Get-ADOIterationPath ) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Overview** - If set, will get common permissions related to a project. These are: * Builds @@ -190,372 +109,162 @@ These are: * Service Endpoints * ServiceHooks +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|true |named |true (ByPropertyName)|ProjectOverview| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Tagging** - If set, will get permissions for tagging related to the current project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Analytics** - If set, will get permissions for analytics related to the current project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ManageTFVC** - If set, will get permissions for Team Foundation Version Control related to the current project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Plan** - If set, will get permissions for Delivery Plans. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Dashboard** - If set, will get dashboard permissions related to the current project. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[Switch]`|true |named |true (ByPropertyName)|Dashboards| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ServiceEndpoint** - If set, will get all service endpoints permissions. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[Switch]`|true |named |true (ByPropertyName)|ServiceEndpoints| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EndpointID** - If set, will get endpoint permissions related to a particular endpoint. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefinitionID** - The Build Definition ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildPath** - The path to the build. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildPermission** - If set, will get build and release permissions for a given project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RepositoryID** - If provided, will get build and release permissions for a given project's repositoryID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BranchName** - If provided, will get permissions for a given branch within a repository +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProjectRepository** - If set, will get permissions for repositories within a project +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------| +|`[Switch]`|true |named |true (ByPropertyName)|ProjectRepositories| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AllRepository** - If set, will get permissions for repositories within a project +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|true |named |true (ByPropertyName)|AllRepositories| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Descriptor** - The Descriptor +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Recurse** - If set and this is a hierarchical namespace, return child ACLs of the specified token. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeExtendedInfo** - If set, populate the extended information properties for the access control entries in the returned lists. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExpandACL** - If set, will expand the ACE dictionary returned +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|false |named |false |ACL | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.SecurityNamespace - * PSDevOps.AccessControlList - - - --- + ### Syntax ```PowerShell Get-ADOPermission -Organization [-PermissionType] [-Descriptor ] [-Recurse] [-IncludeExtendedInfo] [-ExpandACL] [-Server ] [-ApiVersion ] [] @@ -611,4 +320,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 599403de..1cb84a6b 100644 --- a/docs/Get-ADOPicklist.md +++ b/docs/Get-ADOPicklist.md @@ -1,9 +1,11 @@ Get-ADOPicklist --------------- + ### Synopsis Gets picklists from Azure DevOps. --- + ### Description Gets picklists from Azure DevOps. @@ -11,144 +13,83 @@ Gets picklists from Azure DevOps. Picklists are lists of values that can be associated with a field, for example, a list of T-shirt sizes. --- + ### 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 +> EXAMPLE 1 + ```PowerShell Get-ADOPicklist -Organization StartAutomating -PersonalAccessToken $pat ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOPicklist -Organization StartAutomating ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PickListID** - The Picklist Identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PicklistName** - The name of the picklist +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Orphan** - If set, will return orphan picklists. These picklists are not associated with any field. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Project - * PSDevOps.Property - - - --- + ### Syntax ```PowerShell Get-ADOPicklist -Organization [-PicklistName ] [-Server ] [-ApiVersion ] [] @@ -159,4 +100,3 @@ Get-ADOPicklist -Organization [-PicklistName ] -Orphan [-Server ```PowerShell Get-ADOPicklist -Organization -PickListID [-PicklistName ] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOProject.md b/docs/Get-ADOProject.md index ad3a17a7..c978d474 100644 --- a/docs/Get-ADOProject.md +++ b/docs/Get-ADOProject.md @@ -1,396 +1,197 @@ Get-ADOProject -------------- + ### Synopsis Gets projects from Azure DevOps. --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOProject -Organization StartAutomating -PersonalAccessToken $pat ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOProject -Organization StartAutomating -Project PSDevOps ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Get-ADOProject -Organization StartAutomating -Project PSDevOps | Get-ADOProject -Metadata ``` --- + ### Parameters #### **Project** - The project name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProjectID** - The project identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Metadata** - If set, will get project metadta +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------------| +|`[Switch]`|true |named |false |Property
Properties| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ProcessConfiguration** - If set, will return the process configuration of a project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PolicyConfiguration** - If set, will return the policy configuration of a project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PolicyType** - If set, will return the policy types available in a given project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------| +|`[Switch]`|true |named |false |PolicyTypes| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Plan** - If set, will return the plans related to a project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestRun** - If set, will return the test runs associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------| +|`[Switch]`|true |named |false |TestRuns| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestPlan** - If set, will return the test plans associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------| +|`[Switch]`|true |named |false |TestPlans| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestVariable** - If set, will return the test variables associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------| +|`[Switch]`|true |named |false |TestVariables| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestConfiguration** - If set, will return the test variables associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------| +|`[Switch]`|true |named |false |TestConfigurations| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PlanID** - If set, will a specific project plan. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |named |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DeliveryTimeline** - If set, will return the project delivery timeline associated with a given planID. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |named |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Wiki** - If set, will return any wikis associated with the project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Board** - If set, will return any boards associated with the project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Release** - If set, will return releases associated with the project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------| +|`[Switch]`|true |named |false |Releases| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PendingApproval** - If set, will return pending approvals associated with the project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------------| +|`[Switch]`|true |named |false |PendingApprovals| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Project - * PSDevOps.Property - - - --- + ### Syntax ```PowerShell Get-ADOProject -Organization [-Server ] [-ApiVersion ] [] @@ -449,4 +250,3 @@ Get-ADOProject -ProjectID -Organization [-Server ] [-ApiV ```PowerShell Get-ADOProject -PlanID -DeliveryTimeline -Organization [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADORepository.md b/docs/Get-ADORepository.md index 2ffedd0c..76eb0d3b 100644 --- a/docs/Get-ADORepository.md +++ b/docs/Get-ADORepository.md @@ -1,9 +1,11 @@ Get-ADORepository ----------------- + ### Synopsis Gets repositories from Azure DevOps --- + ### Description Gets the repositories from Azure DevOps. @@ -16,7 +18,6 @@ You can get additional details by piping back into Get-ADORepository with a numb * ```Get-ADORepository | Get-ADORepository -FileList # Lists files in a repository``` * ```Get-ADORepository | Get-ADORepository -GitRef # Lists git refs for a repository``` - Azure DevOps repositories can have more than one type of SourceProvider. To list the Source Providers, use -SourceProvider @@ -24,149 +25,75 @@ To list the Source Providers, use -SourceProvider 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 +> EXAMPLE 1 + ```PowerShell Get-ADORepository -Organization StartAutomating -Project PSDevOps ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RepositoryID** - The Repository ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CommitList** - If set, will list commits associated with a given repository. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------------------| +|`[Switch]`|true |named |false |ListCommit
Commit| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Skip** - If provided, will -Skip N items. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |named |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **First** - If provided, will return the -First N items. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |named |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **FileList** - If set, will get the file list from a repository +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Item
Items
Files
ListFile
ListFiles| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RecursionLevel** - When getting a -FileList, the recursion level. By default, full. - - - Valid Values: * full @@ -174,279 +101,120 @@ Valid Values: * oneLevel * oneLevelPlusNestedEmptyFolders +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ScopePath** - When getting a -FileList, the path scope. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |named |true (ByPropertyName)|PathScope| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VersionDescriptor** - The version string identifier (name of tag/branch, SHA1 of commit) +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|false |named |true (ByPropertyName)|Version| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VersionOption** - The version options (e.g. firstParent, previousChange) - - - Valid Values: * none * firstParent * previousChange +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VersionType** - The version type (e.g. branch, commit, or tag) - - - Valid Values: * branch * commit * tag +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeMetadata** - If -IncludeContentMetadata is set a -FileList will include content metadata. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------| +|`[Switch]`|false |named |true (ByPropertyName)|IncludeContentMetadata| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Download** - If set, will include the parent repository +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PullRequest** - If set, will list pull requests related to a git repository. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|PR | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **GitRef** - If set, will list git references related to a repository. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Refs | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BranchStatistic** - If set, will list git branch statistics related to a repository. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Branches
BranchStats
BranchStatistics| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TreeId** - If provided, will output a tree of commits. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CreatorIdentity** - Filters pull requests, returning requests created by the -CreatorIdentity. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |named |true (ByPropertyName)|CreatorID| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReviewerIdentity** - Filters pull requests where the -ReviewerIdentity is a reviewer. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[String]`|false |named |true (ByPropertyName)|ReviewerID| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SourceReference** - Filters pull requests where the source branch is the -SourceReference. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------| +|`[String]`|false |named |true (ByPropertyName)|SourceRef
SourceRefName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TargetReference** - Filters pull requests where the target branch is the -TargetReference. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------| +|`[String]`|false |named |true (ByPropertyName)|TargetRef
TargetRefName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PullRequestStatus** - Filters pull requests with a paricular status. If not specified, will default to Active. - - - Valid Values: * abandoned @@ -455,296 +223,134 @@ Valid Values: * completed * notset +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |named |true (ByPropertyName)|PRStatus| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PullRequestID** - Get pull request with a specific id +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|PRID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PushList** - If set, will list pushes associated with a repository +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|ListPush
ListPushes
PushesList| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeParent** - If set, will include the parent repository +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Recycled** - If set, will get repositories from the recycle bin +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[Switch]`|true |named |true (ByPropertyName)|RecycleBin| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeHidden** - If set, will include hidden repositories. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------------------------------------------| +|`[Switch]`|false |named |false |IncludeHiddenRepository
IncludeHiddenRepositories| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeLink** - If set, will include all related links to a repository. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------| +|`[Switch]`|false |named |false |IncludeLinks| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IncludeRemoteUrl** - If set, will return all GitHub remote URLs associated with a repository. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------| +|`[Switch]`|false |named |false |IncludeRemoteURLs| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **SourceProvider** - If set, will list repository source providers +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|true |named |true (ByPropertyName)|SourceProviders| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProviderName** - The name of the Source Provider. This will get all repositories associated with the project. If the -ProviderName is not TFVC or TFGit, an -EndpointID is also required +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[String]`|true |named |true (ByPropertyName)|EndpointType| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EndpointID** - The name of the Source Provider. This will get all repositories associated with the project. If the -ProviderName is not TFVC or TFGit, an -EndpointID is also required +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RepositoryName** - The name of the repository +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Path** - The path within the repository. To use this parameter, -ProviderName is also required, and -EndpointID will be required if the -ProviderName is not TFVC or TFGit +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CommitOrBranch** - The commit or branch. By default, Master. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Repository - * PSDevOps.Repository.SourceProvider - * PSDevOps.Repository.File - * PSDevOps.Repoistory.Recycled - - - --- + ### Syntax ```PowerShell Get-ADORepository -Organization -Project [-IncludeHidden] [-IncludeLink] [-IncludeRemoteUrl] [-Server ] [-ApiVersion ] [] @@ -788,4 +394,3 @@ Get-ADORepository -Organization -Project -ProviderName -Project -ProviderName [-EndpointID ] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOServiceEndpoint.md b/docs/Get-ADOServiceEndpoint.md index 13a25c92..7543b6f2 100644 --- a/docs/Get-ADOServiceEndpoint.md +++ b/docs/Get-ADOServiceEndpoint.md @@ -1,9 +1,11 @@ Get-ADOServiceEndpoint ---------------------- + ### Synopsis Gets Azure DevOps Service Endpoints --- + ### Description Gets Service Endpoints from Azure DevOps. @@ -13,164 +15,92 @@ Service Endpoints are used to connect an Azure DevOps project to one or more web To see the types of service endpoints, use Get-ADOServiceEndpoint -GetEndpointType --- + ### 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 +> EXAMPLE 1 + ```PowerShell Get-ADOServiceEndpoint -Organization MyOrg -Project MyProject -PersonalAccessToken $myPersonalAccessToken ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOServiceEndpoint -Organization MyOrg -GetEndpointType -PersonalAccessToken $myPersonalAccessToken ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EndpointID** - The Endpoint ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **History** - If set, will get the execution history of the endpoint. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[Switch]`|true |named |true (ByPropertyName)|ExecutionHistory| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **GetEndpointType** - If set, will get the types of endpoints. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[Switch]`|true |named |true (ByPropertyName)|GetEndpointTypes| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.ServiceEndpoint - * StartAutomating.PSDevOps.ServiceEndpoint.History - * StartAutomating.PSDevOps.ServiceEndpoint.Type - - - --- + ### Syntax ```PowerShell Get-ADOServiceEndpoint -Organization -Project [-Server ] [-ApiVersion ] [] @@ -184,4 +114,3 @@ Get-ADOServiceEndpoint -Organization -Project -EndpointID -Project -EndpointID [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOServiceHealth.md b/docs/Get-ADOServiceHealth.md index 58f99792..5afabcde 100644 --- a/docs/Get-ADOServiceHealth.md +++ b/docs/Get-ADOServiceHealth.md @@ -1,34 +1,34 @@ 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 +> EXAMPLE 1 + ```PowerShell Get-ADOServiceHealth ``` --- + ### Parameters #### **Service** - If provided, will query for health in a given geographic region. - - - Valid Values: * Artifacts @@ -39,25 +39,12 @@ Valid Values: * Repos * Test Plans +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------| +|`[String[]]`|false |1 |true (ByPropertyName)|Services| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Geography** - If provided, will query for health in a given geographic region. - - - Valid Values: * APAC @@ -69,38 +56,20 @@ Valid Values: * UK * US +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------------------------| +|`[String[]]`|false |2 |true (ByPropertyName)|Geographies
Region
Regions| - -> **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) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| --- + ### Syntax ```PowerShell Get-ADOServiceHealth [[-Service] ] [[-Geography] ] [[-ApiVersion] ] [] ``` ---- diff --git a/docs/Get-ADOServiceHook.md b/docs/Get-ADOServiceHook.md index 41a7c0c4..7ee1d819 100644 --- a/docs/Get-ADOServiceHook.md +++ b/docs/Get-ADOServiceHook.md @@ -1,9 +1,11 @@ Get-ADOServiceHook ------------------ + ### Synopsis Gets Azure DevOps Service Hooks --- + ### Description Gets Azure DevOps Service Hook Subscriptions, Consumers, and Publishers. @@ -11,238 +13,133 @@ Gets Azure DevOps Service Hook Subscriptions, Consumers, and Publishers. 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 +Gets subscriptions. If none exist, nothing is returned. + ```PowerShell -# Gets subscriptions. If none exist, nothing is returned. Get-ADOServiceHook -Organization MyOrganization -PersonalAccessToken $pat ``` +Gets potential consumers -#### EXAMPLE 2 ```PowerShell -# Gets potential consumers Get-ADOServiceHook -Organization MyOrganization -PersonalAccessToken $pat -Consumer ``` +Gets the actions of all consumers -#### EXAMPLE 3 ```PowerShell -# Gets the actions of all consumers Get-ADOServiceHook -Organization MyOrganization -PersonalAccessToken $pat -Consumer | Get-ADOServiceHook -Action ``` +Gets potential publishers -#### EXAMPLE 4 ```PowerShell -# Gets potential publishers Get-ADOServiceHook -Organization MyOrganization -PersonalAccessToken $pat -Publisher ``` +Gets the event types of all publishers -#### EXAMPLE 5 ```PowerShell -# Gets the event types of all publishers Get-ADOServiceHook -Organization MyOrganization -PersonalAccessToken $pat -Publisher| Get-ADOServiceHook -EventType ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Consumer** - If set, will list consumers. Consumers can receive events from a publisher. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|true |named |true (ByPropertyName)|Consumers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ConsumerID** - The Consumer ID. This can be provided to get details of an event consumer, or to list actions related to the event consumer. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Action** - If set, will list actions available in a given event consumer. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Actions| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Publisher** - If set, will list publishers. Publishers can provide events to a consumer. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[Switch]`|true |named |true (ByPropertyName)|Publishers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PublisherID** - The Publisher ID. This can be provided to get details of an event publisher, or to list actions related to the event publisher. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EventType** - If set, will list event types available from a given event publisher. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[Switch]`|true |named |true (ByPropertyName)|EventTypes| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevops.Subscription - * PSDevops.Consumer - * PSDevops.Publisher - * PSDevops.EventType - * PSDevops.Action - - - --- + ### Syntax ```PowerShell Get-ADOServiceHook -Organization [-Server ] [-ApiVersion ] [] @@ -265,4 +162,3 @@ Get-ADOServiceHook -Organization -PublisherID -EventType [-Ser ```PowerShell Get-ADOServiceHook -Organization -PublisherID [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOTask.md b/docs/Get-ADOTask.md index e7b27a9d..71dedecf 100644 --- a/docs/Get-ADOTask.md +++ b/docs/Get-ADOTask.md @@ -1,126 +1,80 @@ Get-ADOTask ----------- + ### Synopsis Gets Azure DevOps Tasks --- + ### Description Gets Tasks and Task Groups from Azure DevOps --- + ### Related Links * [Convert-ADOPipeline](Convert-ADOPipeline.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-ADOTask -Organization StartAutomating ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOTask -Organization StartAutomating -YAMLSchema ``` --- + ### Parameters #### **Organization** - The organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project. Required to get task groups. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TaskGroup** - If set, will get task groups related to a project. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[Switch]`|true |named |true (ByPropertyName)|TaskGroups
TG| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **YAMLSchema** - If set, will get the schema for YAML tasks within an organization. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schema
YS| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). - - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| --- + ### Outputs * PSDevOps.Task - - - --- + ### Syntax ```PowerShell Get-ADOTask -Organization [-Server ] [] @@ -131,4 +85,3 @@ Get-ADOTask -Organization -Project -TaskGroup [-Server ] ```PowerShell Get-ADOTask -Organization -YAMLSchema [-Server ] [] ``` ---- diff --git a/docs/Get-ADOTeam.md b/docs/Get-ADOTeam.md index b2af6cc4..7d2c4843 100644 --- a/docs/Get-ADOTeam.md +++ b/docs/Get-ADOTeam.md @@ -1,279 +1,142 @@ Get-ADOTeam ----------- + ### Synopsis Gets Azure DevOps Teams --- + ### Description Gets teams from Azure DevOps or TFS --- + ### Related Links * [Get-ADOProject](Get-ADOProject.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-ADOTeam -Organization StartAutomating ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Mine** - If set, will return teams in which the current user is a member. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|My | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TeamID** - The Team Identifier +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Member** - If set, will return members of a team. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------------------| +|`[Switch]`|true |named |false |Members
Membership| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **SecurityDescriptor** - The Security Descriptor. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------------------------| +|`[String]`|true |named |true (ByPropertyName)|SD
UserDescriptor
TeamDescriptor
SubjectDescriptor| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Identity** - If set, will return the team identity. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Setting** - If set, will return the team settings. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------| +|`[Switch]`|true |named |false |Settings| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **FieldValue** - If set, will return the team field values. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------------| +|`[Switch]`|true |named |false |FieldValues
AreaPath| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Iteration** - If set, will return iterations for the team. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------| +|`[Switch]`|true |named |false |Iterations| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Board** - If set, will list team workboards. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Boards | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **SecurityGroup** - If set, will list the security groups. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Team - * PSDevOps.TeamMember - - - --- + ### Syntax ```PowerShell Get-ADOTeam -Organization [-Mine] [-Server ] [-ApiVersion ] [] @@ -308,4 +171,3 @@ Get-ADOTeam -Organization -Member -SecurityDescriptor [-Server ```PowerShell Get-ADOTeam -Organization -SecurityGroup [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOTest.md b/docs/Get-ADOTest.md index 1d874adb..5f474d7b 100644 --- a/docs/Get-ADOTest.md +++ b/docs/Get-ADOTest.md @@ -1,289 +1,141 @@ Get-ADOTest ----------- + ### Synopsis Gets tests from Azure DevOps. --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOProject -Organization StartAutomating -Project PSDevOps | Get-ADOTest -Run ``` --- + ### Parameters #### **ProjectID** - The project identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TestRun** - If set, will return the test runs associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------| +|`[Switch]`|false |named |false |TestRuns| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestRunID** - If set, will return results related to a specific test run. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TestPlan** - If set, will return the test plans associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------| +|`[Switch]`|true |named |false |TestPlans| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestPlanID** - If set, will return results related to a specific test plan. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TestVariable** - If set, will return the test variables associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------| +|`[Switch]`|true |named |false |TestVariables| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestConfiguration** - If set, will return the test variables associated with a project. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------| +|`[Switch]`|true |named |false |TestConfigurations| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestSuite** - If set, will list test suites related to a plan. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------| +|`[Switch]`|true |named |false |TestSuites| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestSuiteID** - If set, will return results related to a particular test suite. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TestPoint** - If set, will return test points within a suite. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|----------| +|`[Switch]`|true |named |false |TestPoints| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TestResult** - If set, will return test results within a run. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------| +|`[Switch]`|true |named |false |TestResults| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **First** - If set, will return the first N results within a test run. +|Type |Required|Position|PipelineInput |Aliases| +|---------|--------|--------|---------------------|-------| +|`[Int32]`|false |named |true (ByPropertyName)|Top | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Total** - If provided, will return the continue to return results of the maximum batch size until the total is reached. +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|------------------------| +|`[Int32]`|false |named |true (ByPropertyName)|TotalTests
TestCount| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Skip** - If set, will return the skip N results within a test run. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Outcome** - If provided, will only return test results with one of the provided outcomes. - - - Valid Values: * Unspecified @@ -302,143 +154,70 @@ Valid Values: * InProgress * NotImpacted +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ResultDetail** - Details to include with the test results. - - - Valid Values: * None * Iterations * WorkItems +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-------------| +|`[String[]]`|false |named |true (ByPropertyName)|ResultDetails| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TestAttachment** - If set, will return test attachments to a run. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------------| +|`[Switch]`|true |named |false |TestAttachments| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Force** - If set, will always retrieve fresh data. By default, cached data will be returned. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Project - * PSDevOps.Property - - - --- + ### Syntax ```PowerShell Get-ADOTest -ProjectID [-TestRun] -Organization [-Force] [-Server ] [-ApiVersion ] [] @@ -473,4 +252,3 @@ Get-ADOTest -ProjectID -TestConfiguration -Organization [-Forc ```PowerShell Get-ADOTest -ProjectID -TestSuiteID -Organization [-Force] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOUser.md b/docs/Get-ADOUser.md index d2c0d76b..c9f3e7f8 100644 --- a/docs/Get-ADOUser.md +++ b/docs/Get-ADOUser.md @@ -1,253 +1,132 @@ Get-ADOUser ----------- + ### Synopsis Gets Azure DevOps Users --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOUser -Organization StartAutomating ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **StorageKey** - If set, will get details about a particular user storage key +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MemberURL** - If set, will get details about a particular member URL. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project name or identifier. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **TeamID** - The Team Identifier +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Entitlement** - If set, will get user entitlement data. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Filter** - If provided, will filter user entitlement data. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **OrderBy** - If provided, will order user entitlement data. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Select** - If provided, will select given properties of user entitlement data. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SubjectType** - If provided, will get graph users of one or more subject types. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Team - * PSDevOps.TeamMember - - - --- + ### Syntax ```PowerShell Get-ADOUser -Organization [-SubjectType ] [-Server ] [-ApiVersion ] [] @@ -267,4 +146,3 @@ Get-ADOUser -Organization -Project -TeamID [-Server < ```PowerShell Get-ADOUser -Organization -Entitlement [-Filter ] [-OrderBy ] [-Select ] [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOWiki.md b/docs/Get-ADOWiki.md index 812970b9..55a27915 100644 --- a/docs/Get-ADOWiki.md +++ b/docs/Get-ADOWiki.md @@ -1,123 +1,77 @@ Get-ADOWiki ----------- + ### Synopsis Gets Azure DevOps Wikis --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOWiki -Organization MyOrganization -Project MyProject -PersonalAccessToken $pat ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WikiID** - The Wiki Identifier. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.Wiki - - - --- + ### Syntax ```PowerShell Get-ADOWiki -Organization -Project [-Server ] [-ApiVersion ] [] @@ -125,4 +79,3 @@ Get-ADOWiki -Organization -Project [-Server ] [-ApiVersio ```PowerShell Get-ADOWiki -Organization -Project -WikiID [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOWorkItem.md b/docs/Get-ADOWorkItem.md index 6696869f..023e3946 100644 --- a/docs/Get-ADOWorkItem.md +++ b/docs/Get-ADOWorkItem.md @@ -1,354 +1,170 @@ Get-ADOWorkItem --------------- + ### Synopsis Gets work items from Azure DevOps --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOWorkItem -Organization StartAutomating -Project PSDevOps -ID 1 ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOWorkItem -Organization StartAutomating -Project PSDevOps -Query 'Select [System.ID] from WorkItems' ``` --- + ### Parameters #### **Title** - The Work Item Title +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Query** - A query. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Mine** - Gets work items assigned to me. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|false |named |true (ByPropertyName)|Me
My| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CurrentIteration** - Gets work items in the current iteration. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|CurrentSprint
ThisSprint| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NoDetail** - If set, queries will output the IDs of matching work items. If not provided, details will be retreived for all work items. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputID| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - The Work Item ID +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Comment** - If set, will get comments related to a work item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[Switch]`|true |named |true (ByPropertyName)|Comments| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Revision** - If set, will get revisions of a work item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|true |named |true (ByPropertyName)|Revisions| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Update** - If set, will get updates of a work item. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Updates| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Team** - The Team. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **First** - If provided, will only return the first N results from a query. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[UInt32]`|false |named |true (ByPropertyName)|Top | - -> **Type**: ```[UInt32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WorkItemType** - If set, will return work item types. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|WorkItemTypes
Type
Types| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SharedQuery** - If set, will return work item shared queries +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeDeleted** - If set, will return shared queries that have been deleted. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Depth** - If provided, will return shared queries up to a given depth. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SharedQueryFilter** - If provided, will filter the shared queries returned +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExpandSharedQuery** - Determines how data from shared queries will be expanded. By default, expands all data. - - - Valid Values: * All @@ -357,97 +173,48 @@ Valid Values: * None * Wiql +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Field** - One or more fields. +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|-----------------| +|`[String[]]`|false |named |false |Fields
Select| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Related** - If set, will get related items +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.WorkItem - - - --- + ### Syntax ```PowerShell Get-ADOWorkItem [-Title ] [-Mine] [-CurrentIteration] -ID -Organization [-Project ] [-Field ] [-Related] [-Server ] [-ApiVersion ] [] @@ -473,4 +240,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 4b0ed2b4..3297dc6c 100644 --- a/docs/Get-ADOWorkItemType.md +++ b/docs/Get-ADOWorkItemType.md @@ -1,285 +1,154 @@ Get-ADOWorkItemType ------------------- + ### Synopsis Gets work item types --- + ### Description Gets work item types from Azure DevOps --- + ### Related Links * [Get-ADOWorkProcess](Get-ADOWorkProcess.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-ADOWorkProcess -Organization StartAutomating -Project PSDevOps | Get-ADOWorkItemType ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOWorkItemType -Organization StartAutomating -Icon ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Get-ADOWorkItemType -Organization StartAutomating -Project PSDevOps ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProcessID** - The ProcessID. This is returned from Get-ADOWorkProcess. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|TypeID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReferenceName** - The Reference Name of the Work Item Type. This can be provided by piping Get-ADOWorkItemType to itself. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Layout** - If set, will get the layout associated with a given work item type. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Page** - If set, will get the pages within a given work item type layout. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|Pages | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **State** - If set, will get the states associated with a given work item type. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |States | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Rule** - If set, will get the rules associated with a given work item type. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Rules | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Behavior** - If set, will get the behaviors associated with a given work item type. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|---------| +|`[Switch]`|true |named |false |Behaviors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Field** - If set, will get the fields associated with a given work item type. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Fields | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Project** - The name of the project. If provided, will get work item type information related to the project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Icon** - If set, will get work item icons available to the organization. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Icons | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.WorkItemType - * PSDevOps.State - * PSDevOps.Rule - * PSDevOps.Behavior - * PSDevOps.Layout - * PSDevOps.ProcessField - - - --- + ### Syntax ```PowerShell Get-ADOWorkItemType -Organization -ProcessID -ReferenceName -Behavior [-Server ] [-ApiVersion ] [] @@ -308,4 +177,3 @@ Get-ADOWorkItemType -Organization -Project [-Server ] [-A ```PowerShell Get-ADOWorkItemType -Organization -Icon [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-ADOWorkProcess.md b/docs/Get-ADOWorkProcess.md index f4eedaf8..01df31fb 100644 --- a/docs/Get-ADOWorkProcess.md +++ b/docs/Get-ADOWorkProcess.md @@ -1,162 +1,96 @@ Get-ADOWorkProcess ------------------ + ### Synopsis Gets work processes from ADO. --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-ADOWorkProcess -Organization StartAutomating -PersonalAccessToken $pat ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOProject -Organization StartAutomating -PersonalAccessToken $pat | Get-ADOWorkProcess ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProjectID** - The Project Identifier. If this is provided, will get the work process associated with that project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProcessID** - The process identifier +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|TypeID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WorkItemType** - If set, will list work item types in a given Work process. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|true |named |true (ByPropertyName)|WorkItemTypes| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Behavior** - If set, will list behaviors associated with a given work process. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|true |named |true (ByPropertyName)|Behaviors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * PSDevOps.WorkProcess - - - --- + ### Syntax ```PowerShell Get-ADOWorkProcess -Organization [-Server ] [-ApiVersion ] [] @@ -173,4 +107,3 @@ Get-ADOWorkProcess -Organization -ProcessID -WorkItemType [-Se ```PowerShell Get-ADOWorkProcess -Organization -ProcessID [-Server ] [-ApiVersion ] [] ``` ---- diff --git a/docs/Get-BuildStep.md b/docs/Get-BuildStep.md index 1f36cd22..56666eef 100644 --- a/docs/Get-BuildStep.md +++ b/docs/Get-BuildStep.md @@ -1,9 +1,11 @@ Get-BuildStep ------------- + ### Synopsis Gets BuildSteps --- + ### Description Gets Build Steps. @@ -11,97 +13,58 @@ Gets Build Steps. Build Steps are scripts or data fragments used to compose a build. --- + ### Related Links * [Import-BuildStep](Import-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-BuildStep ``` --- + ### Parameters #### **Name** - If provided, only return build steps that are like this name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Extension** - If provided, only return build steps matching this extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Type** - If provided, only return build steps of a given type. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildSystem** - If provided, only return build steps for a given build system. - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| --- + ### Outputs * PSDevOps.BuildStep - - - --- + ### Syntax ```PowerShell Get-BuildStep [[-Name] ] [[-Extension] ] [[-Type] ] [[-BuildSystem] ] [] ``` ---- diff --git a/docs/Get-PSDevOps.md b/docs/Get-PSDevOps.md index 47914edd..2e2b6f6b 100644 --- a/docs/Get-PSDevOps.md +++ b/docs/Get-PSDevOps.md @@ -1,9 +1,11 @@ Get-PSDevOps ------------ + ### Synopsis Gets PSDevOps commands. --- + ### Description Gets PSDevOps commands. @@ -23,75 +25,47 @@ To name a few examples of where the technique is used. Using Get-PSDevOps will return extended command information and addtional methods. --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-PSDevOps # Get *.*.ps1 commands in the current directory ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-Module PSDevops | Get-PSDevOps # Gets related commands ``` --- + ### Parameters #### **Name** - The name of the script. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ScriptPath** - One or more paths to scripts. If these paths resolve to directories, all files that match \.(?.+)\.ps1$ If the paths resolve to scripts or commands +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------| +|`[String[]]`|false |2 |true (ByPropertyName)|Fullname| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ModuleInfo** - One or more modules. This can be passed via the pipeline, for example: Get-Module PSDevOps | Get-PSDevOps +|Type |Required|Position|PipelineInput | +|------------------|--------|--------|------------------------------| +|`[PSModuleInfo[]]`|false |3 |true (ByValue, ByPropertyName)| - -> **Type**: ```[PSModuleInfo[]]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByValue, ByPropertyName) - - - ---- #### **Pattern** - The Regular Expression Pattern used to search for files. If a -Pattern is provided, named capture groups in that pattern will become noteproperties of the output object. By default: @@ -101,38 +75,20 @@ By default: The Named Capture 'Type' the type of .ps1 The Optional Named Capture, Subtype, will match an additional '.Something' +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |4 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Recurse** - If set, will search directories recursively. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Syntax ```PowerShell Get-PSDevOps [[-Name] ] [[-ScriptPath] ] [[-ModuleInfo] ] [[-Pattern] ] [-Recurse] [] ``` ---- diff --git a/docs/Hide-GitHubOutput.md b/docs/Hide-GitHubOutput.md index 096ee2c7..f587337b 100644 --- a/docs/Hide-GitHubOutput.md +++ b/docs/Hide-GitHubOutput.md @@ -1,59 +1,50 @@ Hide-GitHubOutput ----------------- + ### Synopsis Masks output --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Hide-GitHubOutput 'IsItSecret?' 'IsItSecret?' | Out-Host ``` --- + ### Parameters #### **Message** - The message to hide. Any time this string would appear in logs, it will be replaced by asteriks. - - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| --- + ### Outputs * [String](https://learn.microsoft.com/en-us/dotnet/api/System.String) - - - --- + ### Syntax ```PowerShell Hide-GitHubOutput [-Message] [] ``` ---- diff --git a/docs/Import-ADOProxy.md b/docs/Import-ADOProxy.md index fa11aed2..62bbc42a 100644 --- a/docs/Import-ADOProxy.md +++ b/docs/Import-ADOProxy.md @@ -1,9 +1,11 @@ Import-ADOProxy --------------- + ### Synopsis Imports an Azure DevOps Proxy --- + ### Description Imports a Proxy Module for Azure DevOps or TFS. @@ -11,183 +13,101 @@ Imports a Proxy Module for Azure DevOps or TFS. A Proxy module will wrap all commands, but will always provide one or more default parameters. --- + ### Related Links * [Connect-ADO](Connect-ADO.md) - - * [Disconnect-ADO](Disconnect-ADO.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Import-ADOProxy -Organization StartAutomating ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Import-ADOProxy -Organization StartAutomating -Prefix SA ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Import-ADOProxy -Organization StartAutomating -Project PSDevOps -IncludeCommand *Build* -Prefix SADO ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. This can be used to provide a TFS instance +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Prefix** - The prefix for all commands in the proxy module. If not provided, this will be the -Server + -Organization + -Project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeCommand** - A list of command wildcards to include. By default, all applicable commands. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeCommand** - A list of commands to exclude. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will return the imported module. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Force** - If set, will unload a previously loaded copy of the module. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Import-ADOProxy [-Organization] [[-Project] ] [[-Server] ] [[-Prefix] ] [[-IncludeCommand] ] [[-ExcludeCommand] ] [-PassThru] [-Force] [] ``` ---- diff --git a/docs/Import-BuildStep.md b/docs/Import-BuildStep.md index dfc1fb47..65a2f1f8 100644 --- a/docs/Import-BuildStep.md +++ b/docs/Import-BuildStep.md @@ -1,158 +1,86 @@ Import-BuildStep ---------------- + ### Synopsis Imports Build Steps --- + ### Description Imports Build Steps defined in a module. --- + ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) - - * [Expand-BuildStep](Expand-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Import-BuildStep -ModuleName PSDevOps ``` --- + ### Parameters #### **ModuleName** - The name of the module containing build steps. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Name | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SourcePath** - The source path. This path contains definitions for a given single build system. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|true |named |true (ByPropertyName)|Fullname| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SourceFile** - The source path to a single item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------------| +|`[String]`|true |named |true (ByPropertyName)|ScriptFile
ScriptPath
Source| - -> **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 |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **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 |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IncludeCommand** - A list of commands to include. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeCommand** - A list of commands to exclude +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildSystem** - The different build systems supported. Each buildsystem is the name of a subdirectory that can contain steps or other components. - - - Valid Values: * ADOPipeline @@ -160,71 +88,38 @@ Valid Values: * GitHubAction * GitHubWorkflow +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |named |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildSystemAlias** - A list of valid directory aliases for a given build system. By default, ADOPipelines can exist within a directory named ADOPipeline, ADO, AzDO, or AzureDevOps. By default, GitHubWorkflows can exist within a directory named GitHubWorkflow, GitHubWorkflows, or GitHub. +|Type |Required|Position|PipelineInput|Aliases | +|---------------|--------|--------|-------------|------------------| +|`[IDictionary]`|false |named |false |BuildSystemAliases| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildSystemInclude** -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - +|Type |Required|Position|PipelineInput|Aliases | +|---------------|--------|--------|-------------|-------------------| +|`[IDictionary]`|false |named |false |BuildSystemIncludes| - ---- #### **BuildCommandType** -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput|Aliases | +|---------------|--------|--------|-------------|-----------------| +|`[IDictionary]`|false |named |false |BuildCommandTypes| --- + ### Outputs * [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) - - - --- + ### Syntax ```PowerShell Import-BuildStep -ModuleName [-IncludeCommand ] [-ExcludeCommand ] [-BuildSystem ] [-BuildSystemAlias ] [-BuildSystemInclude ] [-BuildCommandType ] [] @@ -235,4 +130,3 @@ Import-BuildStep -SourcePath [-BuildSystem ] [-BuildSystemAli ```PowerShell Import-BuildStep -SourceFile [-BuildStepType ] [-BuildStepName ] [-BuildSystem ] [-BuildSystemAlias ] [-BuildSystemInclude ] [-BuildCommandType ] [] ``` ---- diff --git a/docs/Install-ADOExtension.md b/docs/Install-ADOExtension.md index 0f636985..4d48c93e 100644 --- a/docs/Install-ADOExtension.md +++ b/docs/Install-ADOExtension.md @@ -1,159 +1,98 @@ Install-ADOExtension -------------------- + ### Synopsis Installs Azure DevOps Extensions --- + ### Description Installs Azure DevOps Extensions from the Marketplace --- + ### Related Links * [Get-ADOExtension](Get-ADOExtension.md) - - * [Uninstall-ADOExtension](Uninstall-ADOExtension.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Install-ADOExtension -PublisherID YodLabs -ExtensionID yodlabs-githubstats -Organization MyOrg ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PublisherID** - The Publisher of an Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExtensionID** - The name of the Extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Version** - The version of the extension. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Extension - - - --- + ### Syntax ```PowerShell Install-ADOExtension [-Organization] [-PublisherID] [-ExtensionID] [[-Version] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/Invoke-ADORestAPI.md b/docs/Invoke-ADORestAPI.md index 2613ee51..c106c76d 100644 --- a/docs/Invoke-ADORestAPI.md +++ b/docs/Invoke-ADORestAPI.md @@ -1,50 +1,42 @@ Invoke-ADORestAPI ----------------- + ### Synopsis Invokes the ADO Rest API --- + ### Description Invokes the Azure DevOps REST API --- -### Related Links -* [Invoke-RestMethod](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) - +### Related Links +* [Invoke-RestMethod](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) --- + ### Examples -#### EXAMPLE 1 +Uses the Azure DevOps REST api to get builds from a project + ```PowerShell -# Uses the Azure DevOps REST api to get builds from a project $org = 'StartAutomating' $project = 'PSDevOps' Invoke-ADORestAPI "https://dev.azure.com/$org/$project/_apis/build/builds/?api-version=5.1" ``` --- + ### Parameters #### **Uri** - The REST API Url +|Type |Required|Position|PipelineInput |Aliases| +|-------|--------|--------|---------------------|-------| +|`[Uri]`|true |1 |true (ByPropertyName)|Url | - -> **Type**: ```[Uri]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Method** - Specifies the method used for the web request. The acceptable values for this parameter are: - Default - Delete @@ -56,9 +48,6 @@ Specifies the method used for the web request. The acceptable values for this pa - Post - Put - Trace - - - Valid Values: * GET @@ -71,358 +60,159 @@ Valid Values: * PUT * TRACE +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Body** - Specifies the body of the request. If this value is a string, it will be passed as-is Otherwise, this value will be converted into JSON. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Object]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Object]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UrlParameter** - Parameters provided as part of the URL (in segments or a query string). +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|UrlParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryParameter** - Additional parameters provided after the URL. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|QueryParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ContentType** - Specifies the content type of the web request. If this parameter is omitted and the request method is POST, Invoke-RestMethod sets the content type to application/x-www-form-urlencoded. Otherwise, the content type is not specified in the call. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Headers** - Specifies the headers of the web request. Enter a hash table or dictionary. +|Type |Required|Position|PipelineInput |Aliases| +|---------------|--------|--------|---------------------|-------| +|`[IDictionary]`|false |named |true (ByPropertyName)|Header | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PersonalAccessToken** - A Personal Access Token +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[String]`|false |named |false |PAT | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Credential** - Specifies a user account that has permission to send the request. The default is the current user. Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. +|Type |Required|Position|PipelineInput| +|----------------|--------|--------|-------------| +|`[PSCredential]`|false |named |false | - -> **Type**: ```[PSCredential]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **UseDefaultCredentials** - Indicates that the cmdlet uses the credentials of the current user to send the web request. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|--------------------| +|`[Switch]`|false |named |false |UseDefaultCredential| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ContinuationToken** - A continuation token. This is appended as a query parameter, and can be used to continue a request. Invoke-ADORestAPI will call recursively invoke itself until a response does not have a ContinuationToken +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PSTypeName** - The typename of the results. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------------| +|`[String[]]`|false |named |true (ByPropertyName)|Decorate
Decoration| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Property** - A set of additional properties to add to an object +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RemoveProperty** - A list of property names to remove from an object +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExpandProperty** - If provided, will expand a given property returned from the REST api. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DecorateProperty** - If provided, will decorate the values within a property in the return object. This allows nested REST properties to work with the PowerShell Extended Type System. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|TypeNameOfProperty| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Cache** - If set, will cache results from a request. Only HTTP GET results will be cached. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **AsByte** - If set, will return results as a byte array. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------| +|`[Switch]`|false |named |true (ByPropertyName)|Binary
AsByteArray| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AsJob** - If set, will run as a background job. This parameter will be ignored if the caller is piping the results of Invoke-ADORestAPI. This parameter will also be ignore when calling with -DynamicParameter or -MapParameter. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DynamicParameter** - If set, will get the dynamic parameters that should be provided to any function that wraps Invoke-ADORestApi +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[Switch]`|true |named |true (ByPropertyName)|DynamicParameters| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MapParameter** - If set, will return the parameters for any function that can be passed to Invoke-ADORestApi. Unmapped parameters will be added as a noteproperty of the returned dictionary. - - -> **Type**: ```[IDictionary]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-------------| +|`[IDictionary]`|true |named |true (ByPropertyName)|MapParameters| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Invoke-ADORestAPI [-Uri] [-Method ] [-Body ] [-UrlParameter ] [-QueryParameter ] [-ContentType ] [-Headers ] [-PersonalAccessToken ] [-Credential ] [-UseDefaultCredentials] [-ContinuationToken ] [-PSTypeName ] [-Property ] [-RemoveProperty ] [-ExpandProperty ] [-DecorateProperty ] [-Cache] [-AsByte] [-AsJob] [] @@ -433,4 +223,3 @@ Invoke-ADORestAPI [-PersonalAccessToken ] [-Credential ] [ ```PowerShell Invoke-ADORestAPI [-PersonalAccessToken ] [-Credential ] [-UseDefaultCredentials] [-Cache] [-AsByte] [-AsJob] -MapParameter [] ``` ---- diff --git a/docs/Invoke-GitHubRestAPI.md b/docs/Invoke-GitHubRestAPI.md index d09218ce..2593f342 100644 --- a/docs/Invoke-GitHubRestAPI.md +++ b/docs/Invoke-GitHubRestAPI.md @@ -1,50 +1,42 @@ Invoke-GitHubRestAPI -------------------- + ### Synopsis Invokes the Git Rest API --- + ### Description Invokes the GitHub REST API --- -### Related Links -* [Invoke-RestMethod](https://docs.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) - +### Related Links +* [Invoke-RestMethod](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Invoke-RestMethod) --- + ### Examples -#### EXAMPLE 1 +Uses the Azure DevOps REST api to get builds from a project + ```PowerShell -# Uses the Azure DevOps REST api to get builds from a project $org = 'StartAutomating' $repo = 'PSDevOps' Invoke-GitRestAPI "https://api.github.com/repos/StartAutomating/PSDevOps" ``` --- + ### Parameters #### **Uri** - The REST API Url +|Type |Required|Position|PipelineInput |Aliases| +|-------|--------|--------|---------------------|-------| +|`[Uri]`|false |named |true (ByPropertyName)|Url | - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Method** - Specifies the method used for the web request. The acceptable values for this parameter are: - Default - Delete @@ -56,9 +48,6 @@ Specifies the method used for the web request. The acceptable values for this pa - Post - Put - Trace - - - Valid Values: * GET @@ -71,358 +60,162 @@ Valid Values: * PUT * TRACE +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Body** - Specifies the body of the request. If this value is a string, it will be passed as-is Otherwise, this value will be converted into JSON. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Object]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Object]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UrlParameter** -> **Type**: ```[IDictionary]``` - -> **Required**: false +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|UrlParameters| -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryParameter** - Additional parameters provided in the query string. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|QueryParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PersonalAccessToken** - A Personal Access Token +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|false |named |true (ByPropertyName)|PAT | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Page** - The page number. If provided, will only get one page of results. If this is not provided, additional results will be fetched until they are exhausted. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |named |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PerPage** - The number of items to retreive on a single page. +|Type |Required|Position|PipelineInput|Aliases | +|---------|--------|--------|-------------|--------| +|`[Int32]`|false |named |false |Per_Page| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PSTypeName** - The typename of the results. If not set, will be the depluralized last non-variable segment of a URL. (i.e. "https://api.github.com/user/repos" would use a typename of 'repos' so would: "https://api.github.com/users/{UserName}/repos") +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------------| +|`[String[]]`|false |named |true (ByPropertyName)|Decorate
Decoration| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Property** - A set of additional properties to add to an object +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RemoveProperty** - A list of property names to remove from an object +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExpandProperty** - If provided, will expand a given property returned from the REST api. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DecorateProperty** - If provided, will decorate the values within a property in the return object. This allows nested REST properties to work with the PowerShell Extended Type System. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|TypeNameOfProperty| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Cache** - If set, will cache results from a request. Only HTTP GET results will be cached. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AsJob** - If set, will run as a background job. This parameter will be ignored if the caller is piping the results of Invoke-ADORestAPI. This parameter will also be ignore when calling with -DynamicParameter or -MapParameter. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DynamicParameter** - If set, will get the dynamic parameters that should be provided to any function that wraps Invoke-ADORestApi +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------| +|`[Switch]`|true |named |true (ByPropertyName)|DynamicParameters| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MapParameter** - If set, will return the parameters for any function that can be passed to Invoke-ADORestApi. Unmapped parameters will be added as a noteproperty of the returned dictionary. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-------------| +|`[IDictionary]`|true |named |true (ByPropertyName)|MapParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **GitApiUrl** - The GitAPIUrl This will used if -Uri does not contain a hostname. It will default to $env:GIT_API_URL if it is set, otherwise 'https://api.github.com/' +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ContentType** - Specifies the content type of the web request. If this parameter is omitted and the request method is POST, Invoke-RestMethod sets the content type to application/x-www-form-urlencoded. Otherwise, the content type is not specified in the call. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Headers** - Specifies the headers of the web request. Enter a hash table or dictionary. +|Type |Required|Position|PipelineInput |Aliases| +|---------------|--------|--------|---------------------|-------| +|`[IDictionary]`|false |named |true (ByPropertyName)|Header | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UserAgent** - Provides a custom user agent. GitHub API requests require a User Agent. - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Invoke-GitHubRestAPI [-Uri ] [-Method ] [-Body ] [-UrlParameter ] [-QueryParameter ] [-PersonalAccessToken ] [-Page ] [-PerPage ] [-PSTypeName ] [-Property ] [-RemoveProperty ] [-ExpandProperty ] [-DecorateProperty ] [-Cache] [-AsJob] [-GitApiUrl ] [-ContentType ] [-Headers ] [-UserAgent ] [] @@ -433,4 +226,3 @@ Invoke-GitHubRestAPI [-PersonalAccessToken ] [-Cache] [-AsJob] -DynamicP ```PowerShell Invoke-GitHubRestAPI [-PersonalAccessToken ] [-Cache] [-AsJob] -MapParameter [] ``` ---- diff --git a/docs/New-ADOArtifactFeed.md b/docs/New-ADOArtifactFeed.md index a58d6198..7d079a0f 100644 --- a/docs/New-ADOArtifactFeed.md +++ b/docs/New-ADOArtifactFeed.md @@ -1,9 +1,11 @@ New-ADOArtifactFeed ------------------- + ### Synopsis Creates artifact feeds and views in Azure DevOps --- + ### Description Creates artifact feeds and feed views in Azure DevOps. @@ -11,118 +13,64 @@ Creates artifact feeds and feed views in Azure DevOps. 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 +> EXAMPLE 1 + ```PowerShell New-ADOArtifactFeed -Organization MyOrg -Project MyProject -Name Builds -Description "Builds of MyProject" ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The Feed Name ?<> -LiteralCharacter '|?/\:&$*"[]>' -CharacterClass Whitespace -Not -Repeat -StartAnchor StringStart -EndAnchor StringEnd +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - The feed description. ?<> -CharacterClass Any -Min 1 -Max 255 -StartAnchor StringStart -EndAnchor StringEnd +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NoBadge** - If set, this feed will not support the generation of package badges. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|NoBadges
DisabledBadges| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PublicUpstream** - If provided, will allow upstream sources from public repositories. Upstream sources allow your packages to depend on packages in public repositories or private feeds. - - - Valid Values: * NPM @@ -131,111 +79,48 @@ Valid Values: * Maven * PowerShellGallery +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UpstreamSource** - A property bag describing upstream sources +|Type |Required|Position|PipelineInput | +|--------------|--------|--------|---------------------| +|`[PSObject[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[PSObject[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AllowConflictUpstream** - If set, will allow package names to conflict with the names of packages upstream. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsReadOnly** - If set, all packages in the feed are immutable. It is important to note that feed views are immutable; therefore, this flag will always be set for views. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FeedID** - The feed id. This can be supplied to create a veiw for a particular feed. +|Type |Required|Position|PipelineInput |Aliases | +|--------|--------|--------|---------------------|----------------| +|`[Guid]`|false |named |true (ByPropertyName)|FullyQualifiedID| - -> **Type**: ```[Guid]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ShowDeletedPackageVersions** - If set, the feed will not hide all deleted/unpublished versions +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FeedRole** - The Feed Role - - - Valid Values: * Administrator @@ -243,118 +128,63 @@ Valid Values: * Contributor * Reader +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **View** - If set, will create a new view for an artifact feed. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ViewVisibility** - The visibility of the view. By default, the view will be visible to the entire organization. - - - Valid Values: * Collection * Organization * Private +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://feeds.dev.azure.com/. +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.ArtifactFeed - * PSDevOps.ArtifactFeed.View - - - --- + ### Syntax ```PowerShell New-ADOArtifactFeed -Organization [-Project ] -Name [-Description ] [-NoBadge] [-PublicUpstream ] [-UpstreamSource ] [-AllowConflictUpstream] [-IsReadOnly] [-FeedID ] [-ShowDeletedPackageVersions] [-FeedRole ] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -362,4 +192,3 @@ New-ADOArtifactFeed -Organization [-Project ] -Name [- ```PowerShell 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 1b3e0df6..f6984bb9 100644 --- a/docs/New-ADOBuild.md +++ b/docs/New-ADOBuild.md @@ -1,22 +1,25 @@ New-ADOBuild ------------ + ### Synopsis Creates Azure DevOps Build Definitions --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell New-ADOBuild -Organization StartAutomating -Project PSDevops -Name PSDevOps_CI -Repository @{ id = 'StartAutomating/PSDevOps' @@ -31,321 +34,149 @@ New-ADOBuild -Organization StartAutomating -Project PSDevops -Name PSDevOps_CI - ``` --- + ### Parameters #### **Organization** - The Organization. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the build. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Path** - The folder path of the definition. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **YAMLFileName** - The path to a YAML file containing the build definition +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Comment** - A comment about the build defintion revision. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - A description of the build definition. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DropLocation** - The drop location for the build +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildNumberFormat** - The build number format +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Repository** - The repository used by the build definition. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |10 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: true - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Queue** - The queue used by the build definition. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |11 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Demand** - A collection of demands for the build definition. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |12 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Variable** - A collection of variables for the build definition. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |13 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Secret** - A collection of secrets for the build definition. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |14 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Tag** - A list of tags for the build definition. +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[String[]]`|false |15 |true (ByPropertyName)|Tags | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 15 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |16 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 16 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Build.Definition - - - --- + ### Syntax ```PowerShell 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 9ce1eaf2..ec61e74d 100644 --- a/docs/New-ADOField.md +++ b/docs/New-ADOField.md @@ -1,72 +1,54 @@ New-ADOField ------------ + ### Synopsis Creates new fields in Azure DevOps --- + ### Description Creates new work item fields in Azure DevOps or Team Foundation Server. --- + ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell New-ADOField -Name Verb -ReferenceName Cmdlet.Verb -Description "The PowerShell Verb" -ValidValue (Get-Verb | Select-Object -ExpandProperty Verb | Sort-Object) -Organization MyOrganization ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell New-ADOField -Name IsDCR -Type Boolean -Description "Is this a direct custom request?" -Organization MyOrganization ``` --- + ### Parameters #### **Name** - The friendly name of the field +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------------| +|`[String]`|true |1 |true (ByPropertyName)|FriendlyName
DisplayName| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReferenceName** - The reference name of the field. This is the name used in queries. If not provided, the ReferenceName will Custom. + -Name (stripped of whitespace) +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[String]`|false |2 |true (ByPropertyName)|SystemName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Type** - The type of the field. - This can be any of the following: * boolean * dateTime @@ -79,9 +61,6 @@ This can be any of the following: * plainText * string * treePath - - - Valid Values: * boolean @@ -99,216 +78,104 @@ Valid Values: * string * treePath +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[String]`|false |3 |true (ByPropertyName)|FieldType| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - A description for the field. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ValidValue** - A list of valid values. If provided, an associated picklist will be created with these values. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|------------------------| +|`[String[]]`|false |5 |true (ByPropertyName)|ValidValues
Picklist| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CanSortBy** - If set, the field can be used to sort. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsQueryable** - If set, the field can be used in queries. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReadOnly** - If set, the field will be read only. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AllowCustomValue** - If set, custom values can be provided into the field. This is ignored if not used with -ValidValue. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|IsPickListSuggestable
OpenEnded| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |6 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Field - - - --- + ### Syntax ```PowerShell 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 dc6a1743..a920d7a8 100644 --- a/docs/New-ADOPipeline.md +++ b/docs/New-ADOPipeline.md @@ -1,296 +1,155 @@ New-ADOPipeline --------------- + ### Synopsis Creates a new ADO Pipeline --- + ### Description Create a new Azure DevOps Pipeline. --- + ### Related Links * [Convert-BuildStep](Convert-BuildStep.md) - - * [Import-BuildStep](Import-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell New-ADOPipeline -Trigger SourceChanged -Stage PowerShellStaticAnalysis,TestPowerShellCrossPlatForm, UpdatePowerShellGallery ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell New-ADOPipeline -Trigger SourceChanged -Stage PowerShellStaticAnalysis,TestPowerShellCrossPlatForm, UpdatePowerShellGallery -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessToken)'}}} ``` --- + ### Parameters #### **InputObject** - The InputObject +|Type |Required|Position|PipelineInput | +|------------|--------|--------|--------------| +|`[PSObject]`|false |1 |true (ByValue)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByValue) - - - ---- #### **UseSystemAccessToken** - If set, will use map the system access token to an environment variable in each script step. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Option** - Optional changes to a part. A table of additional settings to apply wherever a part is used. For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessToken)'}} +|Type |Required|Position|PipelineInput| +|---------------|--------|--------|-------------| +|`[IDictionary]`|false |2 |false | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **VariableParameter** - The name of parameters that should be supplied from build variables. Wildcards accepted. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EnvironmentParameter** - The name of parameters that should be supplied from the environment. Wildcards accepted. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeParameter** - The name of parameters that should be excluded. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueParameter** - 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. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefaultParameter** - A collection of default parameters. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BuildScript** - A list of build scripts. Each build script will run as a step in the same job. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |8 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:false - - - ---- #### **PassThru** - If set, will output the created objects instead of creating YAML. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PowerShellCore** - If set, will run scripts using PowerShell core, even if on Windows. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **WindowsPowerShell** - If set will run script using WindowsPowerShell if available. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **RootDirectory** - If provided, will directly reference build steps beneath this directory. +|Type |Required|Position|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 - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |10 |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell 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 4bdfc85a..b066bf38 100644 --- a/docs/New-ADOProject.md +++ b/docs/New-ADOProject.md @@ -1,190 +1,111 @@ New-ADOProject -------------- + ### Synopsis Creates new projects in Azure DevOps. --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell New-ADOProject -Organization StartAutomating -Project Formulaic -PersonalAccessToken $pat ``` --- + ### Parameters #### **Name** - The name of the project. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - The project description. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Process** - The process template used by the project. By default, 'Agile' +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[String]`|false |3 |true (ByPropertyName)|ProcessTemplate| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Public** - If set, the project will be created as a public project. If not set, the project will be created as a private project. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Abbreviation** - The project abbreviation +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |4 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |5 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Project - - - --- + ### Syntax ```PowerShell 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 7d5b4c51..f5574dbc 100644 --- a/docs/New-ADORepository.md +++ b/docs/New-ADORepository.md @@ -1,179 +1,107 @@ New-ADORepository ----------------- + ### Synopsis Creates repositories in Azure DevOps --- + ### Description Creates a new repository in Azure DevOps. --- + ### Related Links * [Get-ADORepository](Get-ADORepository.md) - - * [Remove-ADORepository](Remove-ADORepository.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell New-ADORepository -Organization StartAutomating -Project PSDevOps -RepositoryName NewRepo -WhatIf ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RepositoryName** - The name of the repository +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UpstreamName** - The name of the upstream repository (this creates a forked repository from the same project) +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |4 |true (ByPropertyName)|ForkName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UpstreamID** - The ID of an upstream repository (this creates a forked repository) +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|false |5 |true (ByPropertyName)|ForkID | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.Repository - * [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) - - - --- + ### Syntax ```PowerShell New-ADORepository [-Organization] [-Project] [-RepositoryName] [[-UpstreamName] ] [[-UpstreamID] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/New-ADOServiceEndpoint.md b/docs/New-ADOServiceEndpoint.md index 6b2739b0..13e44135 100644 --- a/docs/New-ADOServiceEndpoint.md +++ b/docs/New-ADOServiceEndpoint.md @@ -1,9 +1,11 @@ New-ADOServiceEndpoint ---------------------- + ### Synopsis Creates Azure DevOps Service Endpoints --- + ### Description Creates Service Endpoints in Azure DevOps. @@ -13,14 +15,15 @@ Service Endpoints are used to connect an Azure DevOps project to one or more web To see the types of service endpoints, use Get-ADOServiceEndpoint -GetEndpointType --- + ### 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 +> EXAMPLE 1 + ```PowerShell New-ADOServiceEndpoint -Organization MyOrg -Project MyProject -Name MyGitHubConnection -Url https://github.com -Type GitHub -Authorization @{ scheme = 'PersonalAccessToken' @@ -31,256 +34,123 @@ New-ADOServiceEndpoint -Organization MyOrg -Project MyProject -Name MyGitHubConn ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the endpoint +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AdministratorsGroup** - Initial administrators of the endpoint +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Authorization** - Endpoint authorization data +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Data** - General endpoint data +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReadersGroup** - Initial readers of the endpoint +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Type** - The endpoint type. To see available endpoint types, use Get-ADOServiceEndpoint -GetEndpointType +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - The endpoint description. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Url** - The endpoint service URL. +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |10 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsShared** - If set, the endpoint will be shared across projects +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |11 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1-preview. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.ServiceEndpoint - * [Collections.Hashtable](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.Hashtable) - - - --- + ### Syntax ```PowerShell 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 278a9303..143030b7 100644 --- a/docs/New-ADOWorkItem.md +++ b/docs/New-ADOWorkItem.md @@ -1,390 +1,196 @@ New-ADOWorkItem --------------- + ### Synopsis Creates new work items in Azure DevOps --- + ### Description Creates new work items in Azure DevOps or Team Foundation Server. --- + ### Related Links * [Invoke-ADORestAPI](Invoke-ADORestAPI.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell @{ Title='New Work Item'; Description='A Description of the New Work Item' } | New-ADOWorkItem -Organization StartAutomating -Project PSDevOps -Type Issue ``` --- + ### Parameters #### **InputObject** - The InputObject +|Type |Required|Position|PipelineInput | +|------------|--------|--------|------------------------------| +|`[PSObject]`|true |named |true (ByValue, ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByValue, ByPropertyName) - - - ---- #### **Type** - The type of the work item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[String]`|true |named |true (ByPropertyName)|WorkItemType| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryName** - If set, will create a shared query for work items. The -InputObject will be passed to the body. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryPath** - If provided, will create shared queries beneath a given folder. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WIQL** - If provided, create a shared query with a given WIQL. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryType** - If provided, the shared query created may be hierchical - - - Valid Values: * Flat * OneHop * Tree +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **QueryRecursiveOption** - The recursion option for use in a tree query. - - - Valid Values: * childFirst * parentFirst +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FolderName** - If provided, create a shared query folder. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ParentID** - The work item ParentID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Project** - The Project +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Relationship** - A collection of relationships for the work item. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-------------| +|`[IDictionary]`|false |named |true (ByPropertyName)|Relationships| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Comment** - A list of comments to be added to the work item. +|Type |Required|Position|PipelineInput | +|--------------|--------|--------|---------------------| +|`[PSObject[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[PSObject[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Tag** - A list of tags to assign to the work item. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BypassRule** - If set, will not validate rules. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|BypassRules
NoRules
NoRule| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ValidateOnly** - If set, will only validate rules, but will not update the work item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|ValidateRules
ValidateRule
CheckRule
CheckRules| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SupressNotification** - If set, will only validate rules, but will not update the work item. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|SuppressNotifications
SkipNotification
SkipNotifications
NoNotify| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.WorkItem - - - --- + ### Syntax ```PowerShell New-ADOWorkItem -InputObject -Type [-ParentID ] -Organization -Project [-Relationship ] [-Comment ] [-Tag ] [-BypassRule] [-ValidateOnly] [-SupressNotification] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -395,4 +201,3 @@ New-ADOWorkItem -QueryName [-QueryPath ] -WIQL [-Query ```PowerShell 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 83c19554..eb86acaa 100644 --- a/docs/New-ADOWorkItemType.md +++ b/docs/New-ADOWorkItemType.md @@ -1,9 +1,11 @@ New-ADOWorkItemType ------------------- + ### Synopsis Creates custom work item types --- + ### Description Creates custom work item types in Azure DevOps. @@ -11,25 +13,24 @@ Creates custom work item types in Azure DevOps. 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 +> EXAMPLE 1 + ```PowerShell Get-ADOProject -Organization StartAutomating -Project PSDevOps | Get-ADOWorkProcess | New-ADOWorkItemType -Name ServiceRequest -Color 'ddee00' -Icon icon_flame ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOProject -Organization StartAutomating -Project PSDevOps | # Get a project Get-ADOWorkProcess | # Get it's process @@ -39,252 +40,109 @@ Get-ADOProject -Organization StartAutomating -Project PSDevOps | # Get a project ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ProcessID** - The process identifier. This can be piped in from Get-ADOWorkProcess. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |named |true (ByPropertyName)|TypeID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the custom work item type, custom work item type state, custom work item type rule, or custom work item type behavior. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Icon** - The name of the icon used for the custom work item. To list available icons, use Get-ADOWorkItemType -Icon +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Color** - The color of the work item type or state. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - The description for the custom work item type. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **InheritsFrom** - The work item type the custom work item should inherit, or the backlog behavior that should be inherited. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |named |true (ByPropertyName)|Inherits| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsDisabled** - If set, will create the work item type disabled. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[Switch]`|false |named |true (ByPropertyName)|Disabled| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BehaviorID** - If set, will associate a given work item type with a behavior (for instance, adding a type of work item to be displayed in a backlog) +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IsDefault** - If set, will make the given work item type the default within a particular behavior (for instance, making the work item type the default type of a backlog). +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Behavior** - If set, will create a new state for a custom work item instead of a custom work item. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ReferenceName** - The Reference Name of a WorkItemType. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **State** - If set, will create a new state for a custom work item instead of a custom work item. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Order** - The order of the a custom state for a custom work item. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |named |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **StateCategory** - The state category of a custom state for a custom work item. - - - Valid Values: * Proposed @@ -293,25 +151,12 @@ Valid Values: * Completed * Removed +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |named |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **RuleConditionType** - The type of work item rule to create. - - - Valid Values: * when @@ -325,59 +170,26 @@ Valid Values: * whenWas * whenWorkItemIsCreated +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------| +|`[String[]]`|true |named |true (ByPropertyName)|Condition| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Field** - The field for a given rule condition. +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[String[]]`|false |named |true (ByPropertyName)|Key | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Value** - The value of a given rule condition. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RuleActionType** - The type of action run when the work item rule is triggered. - - - Valid Values: * copyFromClock @@ -394,119 +206,65 @@ Valid Values: * setDefaultValue * setValueToEmpty +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TargetField** - The target field for a given rule action. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TargetValue** - The target value for a given rule action. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.WorkItemType - * PSDevOps.Rule - * PSDevOps.State - * PSDevOps.Behavior - - - --- + ### Syntax ```PowerShell New-ADOWorkItemType -Organization -ProcessID [-Name] [-Icon ] -Color [-Description ] [-InheritsFrom ] [-IsDisabled] [-Server ] [-ApiVersion ] [-WhatIf] [-Confirm] [] @@ -523,4 +281,3 @@ New-ADOWorkItemType -Organization -ProcessID [-Name] ```PowerShell 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 5d62dd12..55678014 100644 --- a/docs/New-ADOWorkProcess.md +++ b/docs/New-ADOWorkProcess.md @@ -1,9 +1,11 @@ New-ADOWorkProcess ------------------ + ### Synopsis Creates work processes in ADO. --- + ### Description Creates work processes in Azure DevOps. @@ -16,21 +18,22 @@ Can Provide: * -ReferenceName --- + ### 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 +> EXAMPLE 1 + ```PowerShell Get-ADOWorkProcess -Organization StartAutomating -PersonalAccessToken $pat | Where-Object Name -Ne TheNameOfTheCurrentProcess | Set-ADOWorkProcess -Disable ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-ADOProject -Organization StartAutomating -PersonalAccessToken $pat | Get-ADOWorkProcess | @@ -38,151 +41,79 @@ Get-ADOProject -Organization StartAutomating -PersonalAccessToken $pat | ``` --- + ### Parameters #### **Organization** - The Organization +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|Org | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - The name of the work process +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - A description of the work process. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ParentProcessID** - The parent process identifier. If not provided, will default to the process ID for 'Agile'. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[String]`|false |4 |true (ByPropertyName)|TypeID
ParentProcessTypeID| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReferenceName** - A reference name for the work process. If one is not provided, Azure Devops will automatically generate one. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Server** - The server. By default https://dev.azure.com/. To use against TFS, provide the tfs server URL (e.g. http://tfsserver:8080/tfs). +|Type |Required|Position|PipelineInput | +|-------|--------|--------|---------------------| +|`[Uri]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Uri]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiVersion** - The api version. By default, 5.1. If targeting TFS, this will need to change to match your server version. See: https://docs.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning?view=azure-devops +|Type |Required|Position|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)]```. -WhatIf is used to see what would happen, or return operations without executing them #### **Confirm** -Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. -Confirm is used to -Confirm each operation. - + If you pass ```-Confirm:$false``` you will not be prompted. - - + If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. --- + ### Outputs * PSDevOps.WorkProcess - - - --- + ### Syntax ```PowerShell New-ADOWorkProcess [-Organization] [-Name] [[-Description] ] [[-ParentProcessID] ] [[-ReferenceName] ] [[-Server] ] [[-ApiVersion] ] [-WhatIf] [-Confirm] [] ``` ---- diff --git a/docs/New-GitHubAction.md b/docs/New-GitHubAction.md index 617b85fb..1095103e 100644 --- a/docs/New-GitHubAction.md +++ b/docs/New-GitHubAction.md @@ -1,286 +1,141 @@ New-GitHubAction ---------------- + ### Synopsis Creates a new GitHub action --- + ### Description + --- + ### 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 +> EXAMPLE 1 + ```PowerShell New-GitHubAction -Job TestPowerShellOnLinux ``` --- + ### Parameters #### **Name** - The name of the action. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |1 |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **Description** - A description of the action. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |1 |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **Action** - The git hub action steps. While we don't want to restrict the steps here, we _do_ want to be able to suggest steps that are built-in. +|Type |Required|Position|PipelineInput | +|--------------|--------|--------|---------------------| +|`[PSObject[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[PSObject[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DockerImage** - The DockerImage used for a GitHub Action. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NodeJSScript** - The NodeJS main script used for a GitHub Action. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ActionInput** - The git hub action inputs. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ActionOutput** - The git hub action outputs. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Option** - Optional changes to a component. A table of additional settings to apply wherever a part is used. For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessToken)'}} +|Type |Required|Position|PipelineInput| +|---------------|--------|--------|-------------| +|`[IDictionary]`|false |named |false | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ExcludeParameter** - The name of parameters that should be excluded. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------| +|`[String[]]`|false |named |true (ByPropertyName)|ExcludeParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueParameter** - 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. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------| +|`[String[]]`|false |named |true (ByPropertyName)|UniqueParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefaultParameter** - A collection of default parameters. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |named |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the created objects instead of creating YAML. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildScript** - A list of build scripts. Each build script will run as a step in the action. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |named |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Icon** - The icon used for branding. By default, a terminal icon. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Color** - The color used for branding. By default, blue. - - - Valid Values: * white @@ -292,45 +147,25 @@ Valid Values: * purple * gray-dark +|Type |Required|Position|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 - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | --- + ### Outputs * [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 ] [-OutputPath ] [] ``` ---- diff --git a/docs/New-GitHubWorkflow.md b/docs/New-GitHubWorkflow.md index 58b3b9f3..9be49039 100644 --- a/docs/New-GitHubWorkflow.md +++ b/docs/New-GitHubWorkflow.md @@ -1,261 +1,135 @@ New-GitHubWorkflow ------------------ + ### Synopsis Creates a new GitHub Workflow --- + ### Description + --- + ### Related Links * [Import-BuildStep](Import-BuildStep.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell New-GitHubWorkflow -Job TestPowerShellOnLinux ``` --- + ### Parameters #### **InputObject** - The input object. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|--------------| +|`[PSObject]`|false |1 |true (ByValue)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByValue) - - - ---- #### **Name** - The name of the workflow. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |2 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **Option** - Optional changes to a component. A table of additional settings to apply wherever a part is used. For example -Option @{RunPester=@{env=@{"SYSTEM_ACCESSTOKEN"='$(System.AccessToken)'}} +|Type |Required|Position|PipelineInput| +|---------------|--------|--------|-------------| +|`[IDictionary]`|false |3 |false | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **Environment** - A collection of environment variables used throughout the build. +|Type |Required|Position|PipelineInput |Aliases| +|---------------|--------|--------|---------------------|-------| +|`[IDictionary]`|false |4 |true (ByPropertyName)|Env | - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **InputParameter** - The name of parameters that should be supplied from an event. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------| +|`[IDictionary]`|false |5 |true (ByPropertyName)|InputParameters| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **VariableParameter** - The name of parameters that should be supplied from build variables. Wildcards accepted. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|------------------| +|`[String[]]`|false |6 |true (ByPropertyName)|VariableParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExcludeParameter** - The name of parameters that should be excluded. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------| +|`[String[]]`|false |7 |true (ByPropertyName)|ExcludeParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueParameter** - 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. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------| +|`[String[]]`|false |8 |true (ByPropertyName)|UniqueParameters| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DefaultParameter** - A collection of default parameters. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the created objects instead of creating YAML. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **BuildScript** - A list of build scripts. Each build script will run as a step in the same job. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |10 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:false - - - ---- #### **RootDirectory** - If provided, will directly reference build steps beneath this directory. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |11 |false | - -> **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 - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |12 |false | --- + ### Outputs * [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] ] [[-OutputPath] ] [] ``` ---- diff --git a/docs/Push-Git.md b/docs/Push-Git.md index 8dd72c9f..53cd089c 100644 --- a/docs/Push-Git.md +++ b/docs/Push-Git.md @@ -1,60 +1,49 @@ Push-Git -------- + ### Synopsis PowerShell Wrapper around git push --- + ### Description Pushes changes to a git repository. --- + ### Related Links * [Add-Git](Add-Git.md) - - * [Submit-Git](Submit-Git.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Push-Git ``` --- + ### Parameters #### **Repository** - The argument. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------| +|`[String]`|false |1 |true (ByPropertyName)|
Repo| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ReferenceSpec** - Specify what destination ref to update with what source object. The format of a parameter is an optional plus +, followed by the source object , followed by a colon :, followed by the destination ref . - The is often the name of the branch you would want to push, but it can be any arbitrary "SHA-1 expression", such as master~4 or HEAD (see gitrevisions(7)). - The tells which ref on the remote side is updated with this push. Arbitrary expressions cannot be used here, an actual ref must be named. If git push [] without any argument is set to update @@ -62,267 +51,133 @@ some ref at the destination with with remote..push configurati : part can be omitted—​such a push will update a ref that normally updates without any on the command line. Otherwise, missing : means to update the same ref as the . - The object referenced by is used to update the reference on the remote side. By default this is only allowed if is not a tag (annotated or lightweight), and then only if it can fast-forward . - By having the optional leading +, you can tell Git to update the ref even if it is not allowed by default (e.g., it is not a fast-forward.) This does not attempt to merge into . - tag means the same as refs/tags/:refs/tags/. - Pushing an empty allows you to delete the ref from the remote repository. - The special refspec : (or +: to allow non-fast-forward updates) directs Git to push "matching" branches: for every branch that exists on the local side, the remote side is updated if a branch of the same name already exists on the remote side. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------------------| +|`[String[]]`|false |2 |true (ByPropertyName)|
RefSpec| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **All** - Push all branches (i.e. refs under refs/heads/); cannot be used with other . +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|--all | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Prune** - Remove remote branches that don’t have a local counterpart. For example a remote branch tmp will be removed if a local branch with the same name doesn’t exist any more. - This also respects refspecs, e.g. git push --prune remote refs/heads/*:refs/tmp/* would make sure that remote refs/tmp/foo will be removed if refs/heads/foo doesn’t exist. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|--prune| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Mirror** - Instead of naming each ref to push, specifies that all refs under refs/ (which includes but is not limited to refs/heads/, refs/remotes/, and refs/tags/) be mirrored to the remote repository. - Newly created local refs will be pushed to the remote end, locally updated refs will be force updated on the remote end, and deleted refs will be removed from the remote end. - This is the default if the configuration option remote..mirror is set. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[Switch]`|false |named |true (ByPropertyName)|--mirror| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DryRun** - Do everything except actually send the updates. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|false |named |true (ByPropertyName)|--dry-run
n| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Porcelain** - Produce machine-readable output. The output status line for each ref will be tab-separated and sent to stdout instead of stderr. The full symbolic names of the refs will be given. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------| +|`[Switch]`|false |named |true (ByPropertyName)|--porcelain| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Delete** - All listed refs are deleted from the remote repository. This is the same as prefixing all refs with a colon. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|--delete
Remove
d| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Tag** - All refs under refs/tags are pushed, in addition to refspecs explicitly listed on the command line. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------| +|`[Switch]`|false |named |true (ByPropertyName)|--tags
Tags| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FollowTag** - Push all the refs that would be pushed without this option, and also push annotated tags in refs/tags that are missing from the remote but are pointing at commit-ish that are reachable from the refs being pushed. - This can also be specified with configuration variable push.followTags. - For more information, see push.followTags in git-config(1). +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|--follow-tags
FollowTags| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Atomic** - Use an atomic transaction on the remote side if available. Either all refs are updated, or on error, no refs are updated. If the server does not support atomic pushes the push will fail. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[Switch]`|false |named |true (ByPropertyName)|--atomic| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PushOption** - Transmit the given string to the server, which passes them to the pre-receive as well as the post-receive hook. - The given string must not contain a NUL or LF character. When multiple --push-option=