From 0cd58c235cd1e7ae278e1e7e4b30322855bc9906 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Wed, 22 Jul 2026 13:38:22 -0700 Subject: [PATCH 01/16] revert 790 --- scripts/GenerateMarkDown.ps1 | 177 +++++++---------------------------- 1 file changed, 33 insertions(+), 144 deletions(-) diff --git a/scripts/GenerateMarkDown.ps1 b/scripts/GenerateMarkDown.ps1 index 52498f065e01d..d7fd5d244a5ea 100644 --- a/scripts/GenerateMarkDown.ps1 +++ b/scripts/GenerateMarkDown.ps1 @@ -13,36 +13,6 @@ function Get-GraphMapping { $graphMapping.Add("beta", "graph-powershell-beta") return $graphMapping } - -function Get-NormalizedContent { - param ( - [ValidateNotNullOrEmpty()] - [string] $FilePath - ) - $content = Get-Content $FilePath -Raw - # Normalize line endings to LF and trim trailing whitespace - $content = $content -replace "`r`n", "`n" - $content = $content.TrimEnd() - # Strip ms.date line so date-only changes are ignored during comparison - $content = $content -replace '(?m)^ms\.date: .+$', '' - return $content -} - -function Get-DeterministicGuid { - param ( - [ValidateNotNullOrEmpty()] - [string] $InputString - ) - $bytes = [System.Text.Encoding]::UTF8.GetBytes($InputString) - $sha256 = [System.Security.Cryptography.SHA256]::Create() - try { - $hash = $sha256.ComputeHash($bytes) - return [guid]::new([byte[]]$hash[0..15]).ToString() - } finally { - $sha256.Dispose() - } -} - function Set-Help { param ( [ValidateNotNullOrEmpty()] @@ -86,11 +56,10 @@ function Start-GraphHelp { $ModulePrefix = "Microsoft.Graph" $AuthPath = "$ModulePrefix.Authentication" $AuthDestination = Join-Path $WorkLoadDocsPath "graph-powershell-1.0" $AuthPath + Get-ChildItem -Path $AuthDestination * -File -Recurse | foreach { $_.Delete() } Import-Module Microsoft.Graph.Authentication -Global $GraphMapping = Get-GraphMapping - $TempAuthDir = Join-Path ([System.IO.Path]::GetTempPath()) "GraphDocsTempAuth_$([guid]::NewGuid().ToString('N'))" - New-Item -Path $TempAuthDir -ItemType Directory -Force | Out-Null $GraphMapping.Keys | ForEach-Object { $graphProfile = $_ $profilePath = "graph-powershell-1.0" @@ -98,34 +67,10 @@ function Start-GraphHelp { $profilePath = "graph-powershell-beta" } - # Generate all auth module docs to temp directory using module-level generation - Set-Help -ModuleDocsPath $TempAuthDir -Command "Connect-MgGraph" -Module "Microsoft.Graph.Authentication" - - # Compare and copy all generated auth files - $TempAuthModuleDir = Join-Path $TempAuthDir $AuthPath - if (Test-Path $TempAuthModuleDir) { - if (-not (Test-Path $AuthDestination)) { - New-Item -Path $AuthDestination -ItemType Directory -Force | Out-Null - } - Get-ChildItem -Path $TempAuthModuleDir -Filter "*.md" -File | ForEach-Object { - $tempFile = $_.FullName - $existingFile = Join-Path $AuthDestination $_.Name - if (Test-Path $existingFile) { - $existingContent = Get-NormalizedContent -FilePath $existingFile - $newContent = Get-NormalizedContent -FilePath $tempFile - if ($existingContent -ne $newContent) { - Copy-Item -Path $tempFile -Destination $existingFile -Force - Write-Host "Updated auth doc: $($_.BaseName)" - } - } else { - Copy-Item -Path $tempFile -Destination $existingFile -Force - Write-Host "Added auth doc: $($_.BaseName)" - } - } - } + $AuthenticationDocsPath = Join-Path $PSScriptRoot "..\microsoftgraph\graph-powershell-1.0" + Set-Help -ModuleDocsPath $AuthenticationDocsPath -Command "Connect-MgGraph" -Module "Microsoft.Graph.Authentication" Get-FolderByProfile -GraphProfile $graphProfile -GraphProfilePath $profilePath -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate } - Remove-Item -Path $TempAuthDir -Recurse -Force -ErrorAction SilentlyContinue git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . @@ -144,11 +89,7 @@ function Get-FolderByProfile { $ModulesToGenerate = @() ) $CommandMetadataContent = Get-Content $CmdletMetadataPath | ConvertFrom-Json - - # Create a single temp directory for this profile's generation - $TempOutputDir = Join-Path ([System.IO.Path]::GetTempPath()) "GraphDocsTemp_$([guid]::NewGuid().ToString('N'))" - New-Item -Path $TempOutputDir -ItemType Directory -Force | Out-Null - + $ModulesToGenerate | ForEach-Object { $ModuleName = $_ Write-Host $ModuleName @@ -163,104 +104,52 @@ function Get-FolderByProfile { if (-not(Test-Path $Destination)) { New-Item -Path $Destination -ItemType Directory } - + + Get-ChildItem -Path $Destination * -File -Recurse | foreach { $_.Delete() } $CmdletCount = 0 - $MetadataCommands = @{} - - # Generate table of contents for each module using a deterministic GUID + # Generate table of contents for each module $TocFileName = "$Path.md" - $ModuleGuid = Get-DeterministicGuid -InputString $Path + $ModuleGuid = [guid]::NewGuid().ToString() $LinkProfile = $GraphProfile.Replace("v", "") $LinkModuleName = $Path.ToLower() $HelpVersion = "1.0.0.0" $HelpLocale = "en-US" - $DownloadLink = "https://learn.microsoft.com/en-us/powershell/module/$LinkModuleName/?view=graph-powershell-$LinkProfile" - - # Build TOC content in memory to compare before writing - $TocContent = @() - $TocContent += "---" - $TocContent += "Module Name: $Path" - $TocContent += "Module Guid: $ModuleGuid" - $TocContent += "Download Help Link: $DownloadLink" - $TocContent += "Help Version: $HelpVersion" - $TocContent += "Locale: $HelpLocale" - $TocContent += "---" - $TocContent += "" - $TocContent += "# $Path Module" - $TocContent += "## Description" - $TocContent += "Microsoft Graph PowerShell Cmdlets" - $TocContent += "" - $TocContent += "## $Path Cmdlets" - + $DownloadLink = "https://learn.microsoft.com/en-us/powershell/module/$LinkModuleName/?view=graph-powershell-$LinkProfile" + New-Item -Path $Destination -Name $TocFileName -ItemType File -Force + Add-Content -Path $Destination\$TocFileName -Value "---" + Add-Content -Path $Destination\$TocFileName -Value "Module Name: $Path" + Add-Content -Path $Destination\$TocFileName -Value "Module Guid: $ModuleGuid" + Add-Content -Path $Destination\$TocFileName -Value "Download Help Link: $DownloadLink" + Add-Content -Path $Destination\$TocFileName -Value "Help Version: $HelpVersion" + Add-Content -Path $Destination\$TocFileName -Value "Locale: $HelpLocale" + Add-Content -Path $Destination\$TocFileName -Value "---" + Add-Content -Path $Destination\$TocFileName -Value "" + Add-Content -Path $Destination\$TocFileName -Value "# $Path Module" + Add-Content -Path $Destination\$TocFileName -Value "## Description" + Add-Content -Path $Destination\$TocFileName -Value "Microsoft Graph PowerShell Cmdlets" + Add-Content -Path $Destination\$TocFileName -Value "" + Add-Content -Path $Destination\$TocFileName -Value "## $Path Cmdlets" $CommandMetadataContent | Where-Object { $_.Module -eq $ModName -and $_.ApiVersion -eq $GraphProfile } | ForEach-Object { $Command = $_.Command - $MetadataCommands[$Command] = $true $CmdletDocsPath = Join-Path $WorkLoadDocsPath $GraphProfilePath $Path "$Command.md" - - # Generate to temp directory and compare with existing - if (Get-Command -Name $Command -ErrorAction SilentlyContinue) { - Set-Help -ModuleDocsPath $TempOutputDir -Command $Command -Module $Path - $TempFilePath = Join-Path $TempOutputDir $Path "$Command.md" - if (Test-Path $TempFilePath) { - if (Test-Path $CmdletDocsPath) { - $existingContent = Get-NormalizedContent -FilePath $CmdletDocsPath - $newContent = Get-NormalizedContent -FilePath $TempFilePath - if ($existingContent -ne $newContent) { - Copy-Item -Path $TempFilePath -Destination $CmdletDocsPath -Force - Write-Host "Updated: $Command" - } - } else { - Copy-Item -Path $TempFilePath -Destination $CmdletDocsPath -Force - Write-Host "Added: $Command" - } + if (-not(Test-Path $CmdletDocsPath)) { + if (Get-Command -Name $Command -ErrorAction SilentlyContinue) { + Set-Help -ModuleDocsPath $DocsDestination -Command $Command -Module $Path + } else { + Write-Warning "Cmdlet $Command is not available." } - } elseif (-not (Test-Path $CmdletDocsPath)) { - Write-Warning "Cmdlet $Command is not available." + } - - $TocContent += "### [$Command]($Command.md)" - $TocContent += "" + Add-Content -Path $Destination\$TocFileName -Value "### [$Command]($Command.md)" + Add-Content -Path $Destination\$TocFileName -Value "" $CmdletCount++ } - - if ($CmdletCount -eq 0) { + if($CmdletCount -eq 0){ Remove-Item -LiteralPath $Destination -Force -Recurse - } else { - # Only write TOC if content has changed - $TocFilePath = Join-Path $Destination $TocFileName - $newTocText = ($TocContent -join "`r`n") + "`r`n" - if (Test-Path $TocFilePath) { - $existingTocText = Get-Content $TocFilePath -Raw - # Normalize both to LF for comparison - $existingNormalized = $existingTocText -replace "`r`n", "`n" - $newNormalized = $newTocText -replace "`r`n", "`n" - if ($existingNormalized.TrimEnd() -ne $newNormalized.TrimEnd()) { - $newTocText | Out-File $TocFilePath -Encoding UTF8 -NoNewline - Write-Host "Updated TOC: $TocFileName" - } - } else { - $newTocText | Out-File $TocFilePath -Encoding UTF8 -NoNewline - Write-Host "Added TOC: $TocFileName" - } - - # Remove orphaned docs — files for commands no longer in metadata - Get-ChildItem -Path $Destination -Filter "*.md" -File | Where-Object { - $cmdName = $_.BaseName - -not $MetadataCommands.ContainsKey($cmdName) -and $_.Name -ne $TocFileName - } | ForEach-Object { - Write-Host "Removing orphaned doc: $($_.Name)" - Remove-Item $_.FullName -Force - } } - # Clean up temp module folder for this iteration - $TempModuleDir = Join-Path $TempOutputDir $Path - if (Test-Path $TempModuleDir) { - Remove-Item -Path $TempModuleDir -Recurse -Force -ErrorAction SilentlyContinue - } } - - Remove-Item -Path $TempOutputDir -Recurse -Force -ErrorAction SilentlyContinue + } # Install PlatyPS Install-Module -Name Microsoft.PowerShell.PlatyPS -Force From e6db7aca807cfefd0501cd38834b6fa3f6728b39 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Wed, 22 Jul 2026 13:43:12 -0700 Subject: [PATCH 02/16] remove stabilize msdate from pipeline --- azure-pipelines/powershell-docs.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/azure-pipelines/powershell-docs.yml b/azure-pipelines/powershell-docs.yml index c0304ad79ada1..603004858ab45 100644 --- a/azure-pipelines/powershell-docs.yml +++ b/azure-pipelines/powershell-docs.yml @@ -158,14 +158,6 @@ extends: targetType: 'filePath' pwsh: true filePath: scripts/CorrectRelatedLinks-AllFiles.ps1 - - task: PowerShell@2 - displayName: 'Stabilize ms.date values' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/StabilizeMsDate.ps1 - errorActionPreference: 'stop' - task: AzureKeyVault@2 displayName: "Azure Key Vault: Get GitHub App secrets" inputs: From 73a8c601468325d6a6906f1c357449e9cc7d5eba Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 24 Jul 2026 02:01:17 -0700 Subject: [PATCH 03/16] Prevent mass doc deletion when Graph modules fail to load Guard GenerateMarkDown.ps1 so a module's docs are only deleted when the module is available to regenerate them. Skip-and-preserve per workload module, and abort if Authentication is unavailable, avoiding refresh PRs that delete thousands of docs after a failed module install. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- scripts/GenerateMarkDown.ps1 | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/scripts/GenerateMarkDown.ps1 b/scripts/GenerateMarkDown.ps1 index d7fd5d244a5ea..8c4b03f16ddf8 100644 --- a/scripts/GenerateMarkDown.ps1 +++ b/scripts/GenerateMarkDown.ps1 @@ -56,9 +56,15 @@ function Start-GraphHelp { $ModulePrefix = "Microsoft.Graph" $AuthPath = "$ModulePrefix.Authentication" $AuthDestination = Join-Path $WorkLoadDocsPath "graph-powershell-1.0" $AuthPath + + # Guard against catastrophic deletions: never remove existing docs unless the module + # is available to regenerate them. Authentication is required for every run, so abort + # if it failed to install rather than wiping committed documentation. + if (-not (Get-Module -Name Microsoft.Graph.Authentication -ListAvailable -ErrorAction SilentlyContinue)) { + throw "Microsoft.Graph.Authentication module is not available. Aborting generation to avoid deleting existing documentation." + } + Import-Module Microsoft.Graph.Authentication -Force -Global Get-ChildItem -Path $AuthDestination * -File -Recurse | foreach { $_.Delete() } - - Import-Module Microsoft.Graph.Authentication -Global $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { $graphProfile = $_ @@ -101,6 +107,16 @@ function Get-FolderByProfile { } $Destination = Join-Path $WorkLoadDocsPath $GraphProfilePath $Path $DocsDestination = Join-Path $WorkLoadDocsPath $GraphProfilePath + + # Guard against catastrophic deletions: if the module failed to install/import, + # skip it entirely so its committed docs are preserved instead of being deleted + # and never regenerated (which is what produced the mass-deletion refresh PRs). + if (-not (Get-Module -Name $Path -ListAvailable -ErrorAction SilentlyContinue)) { + Write-Warning "Module $Path is not available; skipping to preserve existing documentation." + return + } + Import-Module $Path -Force -Global -ErrorAction SilentlyContinue + if (-not(Test-Path $Destination)) { New-Item -Path $Destination -ItemType Directory } From 07657def287d803ad342c41d6f0061804d49781b Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 24 Jul 2026 02:09:19 -0700 Subject: [PATCH 04/16] Normalize generated-commit author to Graph DevX Tooling bot EscapeDisallowedHtmlTags.ps1 and RemoveInvalidFullStops.ps1 hardcoded a personal git identity, so their stage commits in the weekly refresh PRs were attributed to an individual instead of the tooling bot. Align both with the other generation scripts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- scripts/EscapeDisallowedHtmlTags.ps1 | 4 ++-- scripts/RemoveInvalidFullStops.ps1 | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scripts/EscapeDisallowedHtmlTags.ps1 b/scripts/EscapeDisallowedHtmlTags.ps1 index 7f2d4079ff9da..597d7a5633f81 100644 --- a/scripts/EscapeDisallowedHtmlTags.ps1 +++ b/scripts/EscapeDisallowedHtmlTags.ps1 @@ -23,8 +23,8 @@ function EscapeDisallowedHtmlTags { Get-FilesByProfile -GraphProfile $graphProfile -GraphProfilePath $GraphMapping[$graphProfile] -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate } - git config --global user.email "timwamalwa@gmail.com" - git config --global user.name "Timothy Wamalwa" + git config --global user.email "GraphTooling@service.microsoft.com" + git config --global user.name "Microsoft Graph DevX Tooling" git add . git commit -m "Escaped disallowed html tags" } diff --git a/scripts/RemoveInvalidFullStops.ps1 b/scripts/RemoveInvalidFullStops.ps1 index 37be47e7c73df..db34789d58025 100644 --- a/scripts/RemoveInvalidFullStops.ps1 +++ b/scripts/RemoveInvalidFullStops.ps1 @@ -23,8 +23,8 @@ function Remove-InvalidFullStops { Get-FilesByProfile -GraphProfile $graphProfile -GraphProfilePath $GraphMapping[$graphProfile] -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate } - git config --global user.email "timwamalwa@gmail.com" - git config --global user.name "Timothy Wamalwa" + git config --global user.email "GraphTooling@service.microsoft.com" + git config --global user.name "Microsoft Graph DevX Tooling" git add . git commit -m "Removed invalid full stops from the beginning of lines" } From 29c4a42a5ee11cabad11dfec978623090f64c623 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Tue, 28 Jul 2026 11:36:40 -0700 Subject: [PATCH 05/16] Fix duplicated doc enrichment blocks and BOM churn in generation - UpdateLinks.ps1: only insert the beta/v1 '[!NOTE]' link when it is not already present, so weekly runs stop stacking duplicate note blocks. - GeneratePermissionsTable.ps1: skip files that already contain a '**Permissions**' table instead of prepending another copy each run. - GenerateMarkDown.ps1: write PlatyPS output as UTF-8 without BOM so every regenerated file no longer diffs on a leading BOM. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- scripts/GenerateMarkDown.ps1 | 4 ++-- scripts/GeneratePermissionsTable.ps1 | 7 ++++++- scripts/UpdateLinks.ps1 | 6 +++++- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/scripts/GenerateMarkDown.ps1 b/scripts/GenerateMarkDown.ps1 index 8c4b03f16ddf8..3aaae05dc9f8d 100644 --- a/scripts/GenerateMarkDown.ps1 +++ b/scripts/GenerateMarkDown.ps1 @@ -27,7 +27,7 @@ function Set-Help { Command = (Get-Command $Command) OutputFolder = $ModuleDocsPath Force = $true - Encoding = [System.Text.Encoding]::UTF8 + Encoding = [System.Text.UTF8Encoding]::new($false) } if ($Module -eq "Microsoft.Graph.Authentication") { @@ -35,7 +35,7 @@ function Set-Help { Module = (Get-Module $Module) OutputFolder = $ModuleDocsPath WithModulePage = $true - Encoding = [System.Text.Encoding]::UTF8 + Encoding = [System.Text.UTF8Encoding]::new($false) } Import-Module $Module -Force -Global } diff --git a/scripts/GeneratePermissionsTable.ps1 b/scripts/GeneratePermissionsTable.ps1 index aeca973f7f228..47e90ae3698f8 100644 --- a/scripts/GeneratePermissionsTable.ps1 +++ b/scripts/GeneratePermissionsTable.ps1 @@ -136,7 +136,12 @@ function New-ReferenceTable { "@; - if ((Get-Content -Raw -Path $File) -match '(## DESCRIPTION)[\s\S]*## EXAMPLES') { + if ((Get-Content -Raw -Path $File) -match '\*\*Permissions\*\*') { + # A permissions table has already been inserted on a previous run. + # Skip to avoid prepending a duplicate '**Permissions**' block. + Write-Host "Skipping $CommandName as it already has a permissions table"; + } + elseif ((Get-Content -Raw -Path $File) -match '(## DESCRIPTION)[\s\S]*## EXAMPLES') { $Link = "**Permissions**`r`n`n$markdownTable`r`n`n## EXAMPLES" (Get-Content $File) | Foreach-Object { $_ -replace '## EXAMPLES', $Link } | diff --git a/scripts/UpdateLinks.ps1 b/scripts/UpdateLinks.ps1 index f7edf3e93bcd6..fcc8d8e2253b2 100644 --- a/scripts/UpdateLinks.ps1 +++ b/scripts/UpdateLinks.ps1 @@ -175,7 +175,11 @@ function Add-Link { $Folder = $View.Split("=")[1] $ConfirmFile = Join-Path $WorkLoadDocsPath "$Folder" "$ModuleName" "$CommandRename.md" $ConfirmCommandAvailability = Find-MgGraphCommand -Command $CommandRename - if ($ConfirmCommandAvailability -and (Test-Path $ConfirmFile)) { + # Only insert the note if it isn't already present, otherwise every run + # prepends another copy of the same '[!NOTE]' block before '## SYNTAX'. + $NoteMarker = "$LinkTitle [$CommandRename]($BaseUrl/$FullModuleName$View)" + $AlreadyLinked = (Get-Content -Raw -Path $File) -match [regex]::Escape($NoteMarker) + if ($ConfirmCommandAvailability -and (Test-Path $ConfirmFile) -and -not $AlreadyLinked) { (Get-Content $File) | Foreach-Object { $_ -replace '## SYNTAX', $Link } | Out-File $File From a94085a9f3a84c441f3ed86dc5714407d8654618 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Tue, 28 Jul 2026 12:15:46 -0700 Subject: [PATCH 06/16] Force LF line endings for generated markdown docs Add '*.md text eol=lf' to .gitattributes so PlatyPS/transform scripts, which run on Windows and emit CRLF, no longer produce line-ending churn in the weekly refresh PRs. Index blobs are already LF, so this only pins the working-tree checkout and future writes to LF. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- .gitattributes | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitattributes b/.gitattributes index 9fb85ec49f011..ff067eed84e37 100644 --- a/.gitattributes +++ b/.gitattributes @@ -9,6 +9,10 @@ # Declare files that will always have CRLF line endings on checkout. *.sln text eol=crlf +# Reference docs are generated by PlatyPS/transform scripts on Windows. +# Force LF so regenerated markdown never churns the diff with CRLF endings. +*.md text eol=lf + # Denote all files that are truly binary and should not be modified. *.png binary *.jpg binary \ No newline at end of file From 19a3a1a450a7ffe97d24ef506837f842c15293e7 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Wed, 29 Jul 2026 11:57:43 -0700 Subject: [PATCH 07/16] Prevent mass doc deletion by overwriting in place and removing only orphans Bulk-deleting a module's docs before regenerating meant any transient import failure (installed but unimportable module, e.g. Authentication version conflict) wiped docs that were never regenerated, producing refresh PRs with thousands of missing files. Now: verify the module truly imports and exposes commands before processing (skip-and-preserve otherwise), overwrite each doc in place, and remove only genuine orphans whose command is no longer in the metadata. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- scripts/GenerateMarkDown.ps1 | 56 +++++++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/scripts/GenerateMarkDown.ps1 b/scripts/GenerateMarkDown.ps1 index 3aaae05dc9f8d..0d5a062bef429 100644 --- a/scripts/GenerateMarkDown.ps1 +++ b/scripts/GenerateMarkDown.ps1 @@ -63,7 +63,7 @@ function Start-GraphHelp { if (-not (Get-Module -Name Microsoft.Graph.Authentication -ListAvailable -ErrorAction SilentlyContinue)) { throw "Microsoft.Graph.Authentication module is not available. Aborting generation to avoid deleting existing documentation." } - Import-Module Microsoft.Graph.Authentication -Force -Global + Import-Module Microsoft.Graph.Authentication -Force -Global -ErrorAction Stop Get-ChildItem -Path $AuthDestination * -File -Recurse | foreach { $_.Delete() } $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { @@ -108,21 +108,37 @@ function Get-FolderByProfile { $Destination = Join-Path $WorkLoadDocsPath $GraphProfilePath $Path $DocsDestination = Join-Path $WorkLoadDocsPath $GraphProfilePath - # Guard against catastrophic deletions: if the module failed to install/import, - # skip it entirely so its committed docs are preserved instead of being deleted + # Guard against catastrophic deletions. A module can be installed yet fail to + # import (e.g. an Authentication version conflict), and ListAvailable alone does + # not catch that. Verify the module actually imports AND exposes commands; if it + # does not, skip it so its committed docs are preserved instead of being wiped # and never regenerated (which is what produced the mass-deletion refresh PRs). - if (-not (Get-Module -Name $Path -ListAvailable -ErrorAction SilentlyContinue)) { - Write-Warning "Module $Path is not available; skipping to preserve existing documentation." + $ModuleUsable = $false + if (Get-Module -Name $Path -ListAvailable -ErrorAction SilentlyContinue) { + try { + Import-Module $Path -Force -Global -ErrorAction Stop + if (Get-Command -Module $Path -ErrorAction SilentlyContinue) { + $ModuleUsable = $true + } + } catch { + Write-Warning "Module $Path failed to import: $($_.Exception.Message)" + } + } + if (-not $ModuleUsable) { + Write-Warning "Module $Path is not usable; skipping to preserve existing documentation." return } - Import-Module $Path -Force -Global -ErrorAction SilentlyContinue if (-not(Test-Path $Destination)) { New-Item -Path $Destination -ItemType Directory } - - Get-ChildItem -Path $Destination * -File -Recurse | foreach { $_.Delete() } + + # NOTE: docs are intentionally NOT bulk-deleted here. Each doc is overwritten in + # place as it is regenerated, and only genuine orphans (commands no longer in the + # metadata) are removed afterwards. This guarantees that a transient generation + # failure can never wipe a module's documentation. $CmdletCount = 0 + $MetadataCommands = @{} # Generate table of contents for each module $TocFileName = "$Path.md" $ModuleGuid = [guid]::NewGuid().ToString() @@ -147,19 +163,27 @@ function Get-FolderByProfile { Add-Content -Path $Destination\$TocFileName -Value "## $Path Cmdlets" $CommandMetadataContent | Where-Object { $_.Module -eq $ModName -and $_.ApiVersion -eq $GraphProfile } | ForEach-Object { $Command = $_.Command - $CmdletDocsPath = Join-Path $WorkLoadDocsPath $GraphProfilePath $Path "$Command.md" - if (-not(Test-Path $CmdletDocsPath)) { - if (Get-Command -Name $Command -ErrorAction SilentlyContinue) { - Set-Help -ModuleDocsPath $DocsDestination -Command $Command -Module $Path - } else { - Write-Warning "Cmdlet $Command is not available." - } - + $MetadataCommands[$Command] = $true + if (Get-Command -Name $Command -ErrorAction SilentlyContinue) { + Set-Help -ModuleDocsPath $DocsDestination -Command $Command -Module $Path + } else { + Write-Warning "Cmdlet $Command is not available." } Add-Content -Path $Destination\$TocFileName -Value "### [$Command]($Command.md)" Add-Content -Path $Destination\$TocFileName -Value "" $CmdletCount++ } + + # Remove only genuine orphans: docs whose command is no longer in the metadata. + # Docs for commands still in metadata are preserved even if this run failed to + # regenerate them, so a bad run cannot delete valid documentation. + Get-ChildItem -Path $Destination -Filter "*.md" -File | Where-Object { + $_.Name -ne $TocFileName -and -not $MetadataCommands.ContainsKey($_.BaseName) + } | ForEach-Object { + Write-Host "Removing orphaned doc: $($_.Name)" + Remove-Item $_.FullName -Force + } + if($CmdletCount -eq 0){ Remove-Item -LiteralPath $Destination -Force -Recurse } From 00db04466cdc97b8fcbf4298c23497504bb7fd81 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Thu, 30 Jul 2026 17:20:46 -0700 Subject: [PATCH 08/16] Refactor weekly docs pipeline into isolated per-module stages Each Graph workload module now generates in its own Azure DevOps stage per SDK profile (~86 independent stages), giving every module a fresh agent and a clean assembly-load context. This structurally eliminates the "assembly with same name is already loaded" collisions that produced mass-deletion / no-op refresh PRs. - GenerateMarkDown.ps1: add -GraphProfileFilter and -ModuleFilter scoping; in scoped runs do a complete delete + full regen of the single module, throw before any deletion on import failure (fail-safe), and emit a ModuleGenerated signal only on success. - 9 post-processing scripts: add matching profile/module scoping and empty-commit guards so each touches only the target module folder. - update-template.yml: parameterized install (InstallProfile/Module) that installs only Authentication + the single workload submodule for isolated runs; install failures warn instead of failing. - New common-templates/generate-module-docs-steps.yml: full single-module sequence (install -> generate -> post-process -> push -> PR). Generate step is continueOnError and every later step is gated on ModuleGenerated, so a failing module deletes nothing, opens no PR, and never fails the overall pipeline. - New common-templates/module-stages.yml: emits one dependsOn:[] stage per module. - powershell-docs.yml: invoke module-stages.yml for v1.0 (incl. Authentication) and beta; each stage opens its own pull request. ms.date changes every run (StabilizeMsDate is intentionally not run) for reviewable PRs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- .../generate-module-docs-steps.yml | 219 ++++++++++++++++ .../common-templates/module-stages.yml | 50 ++++ azure-pipelines/powershell-docs.yml | 248 ++++++++---------- azure-pipelines/update-template.yml | 60 ++++- scripts/CorrectRelatedLinks-AllFiles.ps1 | 10 +- scripts/EscapeDisallowedHtmlTags.ps1 | 16 +- scripts/GenerateAliasedDocs.ps1 | 11 +- scripts/GenerateMarkDown.ps1 | 93 +++++-- scripts/GeneratePermissionsTable.ps1 | 15 +- scripts/MsSubserviceUpdate.ps1 | 7 +- scripts/RemoveBoilerPlateCode.ps1 | 34 ++- scripts/RemoveInvalidFullStops.ps1 | 16 +- .../RepairExamplesDescriptionsAndTitle.ps1 | 14 +- scripts/UpdateLinks.ps1 | 9 +- 14 files changed, 600 insertions(+), 202 deletions(-) create mode 100644 azure-pipelines/common-templates/generate-module-docs-steps.yml create mode 100644 azure-pipelines/common-templates/module-stages.yml diff --git a/azure-pipelines/common-templates/generate-module-docs-steps.yml b/azure-pipelines/common-templates/generate-module-docs-steps.yml new file mode 100644 index 0000000000000..290ee79651d59 --- /dev/null +++ b/azure-pipelines/common-templates/generate-module-docs-steps.yml @@ -0,0 +1,219 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +# +# Reusable steps that generate and post-process documentation for a SINGLE module in a SINGLE +# SDK profile, then open a dedicated pull request for it. Designed to run inside an isolated +# per-module stage so an import/assembly conflict for one module can never affect another. +# +# Failure containment: the generate step runs with continueOnError, and every step after it is +# gated on the ModuleGenerated variable (set only when generation actually succeeds). If the +# module fails to import, nothing is deleted, no PR is opened, and the stage is marked +# partially-succeeded WITHOUT failing the overall pipeline or any other module's stage. + +parameters: + - name: Module + type: string + - name: GraphProfileFilter + type: string + - name: BranchPrefix + type: string + default: WeeklyDocs + - name: BaseBranch + type: string + default: main + +steps: + - template: ../update-template.yml + parameters: + InstallProfile: ${{ parameters.GraphProfileFilter }} + Module: ${{ parameters.Module }} + + - task: PowerShell@2 + name: ComputeBranch + displayName: 'Compute branch name' + inputs: + targetType: 'inline' + pwsh: true + script: | + git submodule update --init --recursive + $branch = "{0}-{1}-{2}_{3}" -f "${{ parameters.BranchPrefix }}", "${{ parameters.GraphProfileFilter }}", "${{ parameters.Module }}", (Get-Date -Format yyyyMMddHHmm) + Write-Host "Compute branch: $branch" + Write-Host "##vso[task.setvariable variable=ModuleBranch;isOutput=true]$branch" + + - task: Bash@3 + displayName: 'Create module refresh branch' + inputs: + targetType: inline + script: | + git status + git branch $(ComputeBranch.ModuleBranch) + git checkout $(ComputeBranch.ModuleBranch) + git status + + - task: PowerShell@2 + displayName: 'Create missing external docs folder' + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/CreateExternalDocsFolder.ps1 + + - task: PowerShell@2 + name: GenerateDocs + displayName: 'Generate markdown (${{ parameters.Module }} / ${{ parameters.GraphProfileFilter }})' + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/GenerateMarkDown.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Escape disallowed html tags' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/EscapeDisallowedHtmlTags.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Update metadata header' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/MsSubserviceUpdate.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Generate permissions table' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/GeneratePermissionsTable.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Update Links' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/UpdateLinks.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Repair Examples and Descriptions and Title' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/RepairExamplesDescriptionsAndTitle.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Remove boiler plate code' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/RemoveBoilerPlateCode.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Remove invalid fullstops' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/RemoveInvalidFullStops.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Generate missing docs for aliased cmdlets' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/GenerateAliasedDocs.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: PowerShell@2 + displayName: 'Correct related links section' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + inputs: + targetType: 'filePath' + pwsh: true + filePath: scripts/CorrectRelatedLinks-AllFiles.ps1 + arguments: -GraphProfileFilter "${{ parameters.GraphProfileFilter }}" -ModuleFilter "${{ parameters.Module }}" + + - task: AzureKeyVault@2 + displayName: "Azure Key Vault: Get GitHub App secrets" + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + inputs: + azureSubscription: "Federated AKV Managed Identity Connection" + KeyVaultName: akv-prod-eastus + SecretsFilter: "microsoft-graph-devx-bot-appid,microsoft-graph-devx-bot-privatekey" + + - task: PowerShell@2 + displayName: 'Push ${{ parameters.Module }} (${{ parameters.GraphProfileFilter }}) branch' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + env: + GhAppId: $(microsoft-graph-devx-bot-appid) + GhAppKey: $(microsoft-graph-devx-bot-privatekey) + inputs: + targetType: inline + pwsh: true + script: | + git config --global user.email "GraphTooling@service.microsoft.com" + git config --global user.name "Microsoft Graph DevX Tooling" + git config --system core.longpaths true + # The microsoft-graph-devx-bot GitHub App must have contents:write on this repo. + $token = & "$(Build.SourcesDirectory)/scripts/Generate-Github-Token.ps1" -AppClientId $env:GhAppId -AppPrivateKeyContents $env:GhAppKey -Repository "MicrosoftDocs/microsoftgraph-docs-powershell" + if ([string]::IsNullOrWhiteSpace($token)) { throw "Failed to generate GitHub App installation token." } + # Mask the token so it is never surfaced in pipeline logs. + Write-Host "##vso[task.setsecret]$token" + git status + git add . + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Updating reference docs for ${{ parameters.Module }} (${{ parameters.GraphProfileFilter }})" + } + else { + $global:LASTEXITCODE = 0 + } + git push --set-upstream "https://x-access-token:$token@github.com/MicrosoftDocs/microsoftgraph-docs-powershell.git" $(ComputeBranch.ModuleBranch) + git status + + - task: PowerShell@2 + displayName: 'Create PR for ${{ parameters.Module }} (${{ parameters.GraphProfileFilter }})' + condition: and(succeeded(), eq(variables['ModuleGenerated'], 'true')) + continueOnError: true + env: + GhAppId: $(microsoft-graph-devx-bot-appid) + GhAppKey: $(microsoft-graph-devx-bot-privatekey) + inputs: + targetType: inline + pwsh: true + script: | + $BaseBranchName = "${{ parameters.BaseBranch }}" + $Head = "MicrosoftDocs:$(ComputeBranch.ModuleBranch)" + $Title = "Weekly Docs Refresh: ${{ parameters.Module }} (${{ parameters.GraphProfileFilter }})" + $Body = "This pull request was automatically created by Azure Pipelines for the ``${{ parameters.Module }}`` module (``${{ parameters.GraphProfileFilter }}`` profile). **Important** Check for unexpected deletions or changes in this PR." + # The microsoft-graph-devx-bot GitHub App must have pull_requests:write on this repo. + $env:GITHUB_TOKEN = & "$(Build.SourcesDirectory)/scripts/Generate-Github-Token.ps1" -AppClientId $env:GhAppId -AppPrivateKeyContents $env:GhAppKey -Repository "MicrosoftDocs/microsoftgraph-docs-powershell" + if ([string]::IsNullOrWhiteSpace($env:GITHUB_TOKEN)) { throw "Failed to generate GitHub App installation token." } + # Mask the token so it is never surfaced in pipeline logs. + Write-Host "##vso[task.setsecret]$env:GITHUB_TOKEN" + gh pr create -t $Title -b $Body -B $BaseBranchName -H $Head diff --git a/azure-pipelines/common-templates/module-stages.yml b/azure-pipelines/common-templates/module-stages.yml new file mode 100644 index 0000000000000..f8a1f19f2cfc1 --- /dev/null +++ b/azure-pipelines/common-templates/module-stages.yml @@ -0,0 +1,50 @@ +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. +# +# Emits one fully independent stage per module for a given SDK profile. Each stage runs on its +# own agent (clean assembly-load context), generates + post-processes docs for that single +# module, and opens its own pull request. All stages have dependsOn: [] so they run in +# parallel and one module can never block or fail another. + +parameters: + - name: GraphProfileFilter + type: string + # Short label used in stage names (stage names cannot contain '.'), e.g. "v1" or "beta". + - name: ProfileLabel + type: string + - name: Modules + type: object + default: [] + - name: BranchPrefix + type: string + default: WeeklyDocs + - name: BaseBranch + type: string + default: main + - name: PipelineTimeout + type: number + default: 120 + +stages: + - ${{ each module in parameters.Modules }}: + - stage: "Gen_${{ parameters.ProfileLabel }}_${{ replace(module, '.', '_') }}" + displayName: '${{ parameters.GraphProfileFilter }} - ${{ module }}' + dependsOn: [] + jobs: + - job: GenerateModuleDocs + timeoutInMinutes: ${{ parameters.PipelineTimeout }} + templateContext: + outputs: + - output: pipelineArtifact + displayName: 'Publish missing external docs' + targetPath: missingexternaldocsurl + artifactName: "MissingExternalDocs-${{ parameters.ProfileLabel }}-${{ replace(module, '.', '-') }}" + publishLocation: 'Container' + condition: succeededOrFailed() + steps: + - template: generate-module-docs-steps.yml + parameters: + Module: ${{ module }} + GraphProfileFilter: ${{ parameters.GraphProfileFilter }} + BranchPrefix: ${{ parameters.BranchPrefix }} + BaseBranch: ${{ parameters.BaseBranch }} diff --git a/azure-pipelines/powershell-docs.yml b/azure-pipelines/powershell-docs.yml index 603004858ab45..b6dc5b22f8b9b 100644 --- a/azure-pipelines/powershell-docs.yml +++ b/azure-pipelines/powershell-docs.yml @@ -47,148 +47,106 @@ extends: customBuildTags: - ES365AIMigrationTooling stages: - - stage: stage - jobs: - - job: PowerShellDocsUpdate - timeoutInMinutes: ${{ parameters.PipelineTimeout }} - templateContext: - outputs: - - output: pipelineArtifact - displayName: 'Publish Examples to be reviewed as artifact' - targetPath: missingexternaldocsurl - artifactName: 'MissingExternalDocs' - publishLocation: 'Container' - steps: - - template: azure-pipelines/update-template.yml@self - - task : PowerShell@2 - name: "ComputeBranch" - displayName: 'Compute Branch Name' - inputs: - targetType: 'inline' - script: | - git submodule update --init --recursive - $branch = "{0}_{1}" -f "WeeklyReferenceDocsUpdate", (Get-Date -Format yyyyMMddHHmm) - Write-Host "Compute branch: $branch" - Write-Host "##vso[task.setvariable variable=WeeklyReferenceDocsBranch;isOutput=true]$branch" - - task: Bash@3 - displayName: "Create weekly refresh branch" - inputs: - targetType: inline - script: | - git status - git branch $(ComputeBranch.WeeklyReferenceDocsBranch) - git checkout $(ComputeBranch.WeeklyReferenceDocsBranch) - git status - - task: PowerShell@2 - displayName: 'Create missing external docs folder' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/CreateExternalDocsFolder.ps1 - - - task: PowerShell@2 - displayName: 'Generate markdown files from PowerShell help files' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/GenerateMarkDown.ps1 - - task: PowerShell@2 - displayName: 'Escape disallowed html tags' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/EscapeDisallowedHtmlTags.ps1 - - task: PowerShell@2 - displayName: 'Update metadata header' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/MsSubserviceUpdate.ps1 - - task: PowerShell@2 - displayName: 'Generate permissions table' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/GeneratePermissionsTable.ps1 - - task: PowerShell@2 - displayName: 'Update Links' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/UpdateLinks.ps1 - errorActionPreference: 'stop' - - task: PowerShell@2 - displayName: 'Repair Examples and Descriptions and Title' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/RepairExamplesDescriptionsAndTitle.ps1 - - task: PowerShell@2 - displayName: 'Remove boiler plate code' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/RemoveBoilerPlateCode.ps1 - - task: PowerShell@2 - displayName: 'Remove invalid fullstops' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/RemoveInvalidFullStops.ps1 - - task: PowerShell@2 - displayName: 'Generate missing docs for aliased cmdlets' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/GenerateAliasedDocs.ps1 - - task: PowerShell@2 - displayName: 'Correct related links section' - continueOnError: false - inputs: - targetType: 'filePath' - pwsh: true - filePath: scripts/CorrectRelatedLinks-AllFiles.ps1 - - task: AzureKeyVault@2 - displayName: "Azure Key Vault: Get GitHub App secrets" - inputs: - azureSubscription: "Federated AKV Managed Identity Connection" - KeyVaultName: akv-prod-eastus - SecretsFilter: "microsoft-graph-devx-bot-appid,microsoft-graph-devx-bot-privatekey" - - task: PowerShell@2 - displayName: Pushing to github - env: - GhAppId: $(microsoft-graph-devx-bot-appid) - GhAppKey: $(microsoft-graph-devx-bot-privatekey) - inputs: - targetType: inline - pwsh: true - script: | - git config --global user.email "GraphTooling@service.microsoft.com" - git config --global user.name "Microsoft Graph DevX Tooling" - git config --system core.longpaths true - # The microsoft-graph-devx-bot GitHub App must have contents:write on this repo. - $token = & "$(Build.SourcesDirectory)/scripts/Generate-Github-Token.ps1" -AppClientId $env:GhAppId -AppPrivateKeyContents $env:GhAppKey -Repository "MicrosoftDocs/microsoftgraph-docs-powershell" - if ([string]::IsNullOrWhiteSpace($token)) { throw "Failed to generate GitHub App installation token." } - # Mask the token so it is never surfaced in pipeline logs. - Write-Host "##vso[task.setsecret]$token" - git status - git add . - git commit -m "Updating reference docs" - git push --set-upstream "https://x-access-token:$token@github.com/MicrosoftDocs/microsoftgraph-docs-powershell.git" $(ComputeBranch.WeeklyReferenceDocsBranch) - git status - - template: azure-pipelines/common-templates/create-pr.yml@self - parameters: - BaseBranch: "main" - TargetBranch: $(ComputeBranch.WeeklyReferenceDocsBranch) - Title: "Weekly PowerShell Microsoft Graph Reference Docs Refresh" - Body: "This pull request was automatically created by Azure Pipelines. **Important** Check for unexpected deletions or changes in this PR." \ No newline at end of file + - template: azure-pipelines/common-templates/module-stages.yml@self + parameters: + GraphProfileFilter: "v1.0" + ProfileLabel: "v1" + BranchPrefix: "WeeklyDocs" + BaseBranch: "main" + PipelineTimeout: ${{ parameters.PipelineTimeout }} + Modules: + - Authentication + - Applications + - Bookings + - BusinessScenario + - BackupRestore + - Calendar + - ChangeNotifications + - CloudCommunications + - Compliance + - CrossDeviceExperiences + - Devices.CloudPrint + - Devices.CorporateManagement + - Devices.ServiceAnnouncement + - DeviceManagement + - DeviceManagement.Administration + - DeviceManagement.Enrollment + - DeviceManagement.Actions + - DeviceManagement.Functions + - DirectoryObjects + - Education + - Files + - Financials + - Groups + - Identity.DirectoryManagement + - Identity.Governance + - Identity.SignIns + - Identity.Partner + - Mail + - ManagedTenants + - NetworkAccess + - Notes + - People + - PersonalContacts + - Planner + - Reports + - SchemaExtensions + - Search + - Security + - Sites + - Teams + - Users + - Users.Actions + - Users.Functions + - WindowsUpdates + - template: azure-pipelines/common-templates/module-stages.yml@self + parameters: + GraphProfileFilter: "beta" + ProfileLabel: "beta" + BranchPrefix: "WeeklyDocs" + BaseBranch: "main" + PipelineTimeout: ${{ parameters.PipelineTimeout }} + Modules: + - Applications + - Bookings + - BusinessScenario + - BackupRestore + - Calendar + - ChangeNotifications + - CloudCommunications + - Compliance + - CrossDeviceExperiences + - Devices.CloudPrint + - Devices.CorporateManagement + - Devices.ServiceAnnouncement + - DeviceManagement + - DeviceManagement.Administration + - DeviceManagement.Enrollment + - DeviceManagement.Actions + - DeviceManagement.Functions + - DirectoryObjects + - Education + - Files + - Financials + - Groups + - Identity.DirectoryManagement + - Identity.Governance + - Identity.SignIns + - Identity.Partner + - Mail + - ManagedTenants + - NetworkAccess + - Notes + - People + - PersonalContacts + - Planner + - Reports + - SchemaExtensions + - Search + - Security + - Sites + - Teams + - Users + - Users.Actions + - Users.Functions + - WindowsUpdates diff --git a/azure-pipelines/update-template.yml b/azure-pipelines/update-template.yml index cd0ec7be60216..8884e887a9aae 100644 --- a/azure-pipelines/update-template.yml +++ b/azure-pipelines/update-template.yml @@ -1,3 +1,16 @@ +parameters: + # Which SDK profile to install for. "both" preserves the original full-run behaviour and + # installs the Microsoft.Graph and Microsoft.Graph.Beta meta modules. + - name: InstallProfile + type: string + default: both + # When set, only the single workload submodule for that module (plus Authentication) is + # installed instead of the whole SDK. This keeps each isolated per-module stage fast and + # guarantees only one workload module is ever present in the session. + - name: Module + type: string + default: "" + steps: - task: PowerShell@2 displayName: Install Required Modules @@ -12,25 +25,44 @@ steps: if (-not (Get-PSRepository -Name PowerShell_V2_Build -ErrorAction SilentlyContinue)) { Register-PSRepository -Name PowerShell_V2_Build -SourceLocation $feedUrl -InstallationPolicy Trusted -Credential $cred } - try{ - # Try to update the V1 module first. - Install-Module Microsoft.Graph.Beta -Repository PowerShell_V2_Build -Credential $cred -Scope AllUsers -AcceptLicense -SkipPublisherCheck -Force -AllowClobber - }catch{ - # If the module is not installed, install it. - echo "Error when installing Beta" + + $installProfile = "${{ parameters.InstallProfile }}" + $module = "${{ parameters.Module }}" + + # Build the list of modules to install. + $toInstall = @() + if ([string]::IsNullOrWhiteSpace($module)) { + # Full-run behaviour: install the meta module(s) for the requested profile(s). + if ($installProfile -ne 'v1.0') { $toInstall += 'Microsoft.Graph.Beta' } + if ($installProfile -ne 'beta') { $toInstall += 'Microsoft.Graph' } } - try{ - # Try to update the beta module first. - Install-Module Microsoft.Graph -Repository PowerShell_V2_Build -Credential $cred -Scope AllUsers -AcceptLicense -SkipPublisherCheck -Force -AllowClobber - }catch{ - # If the module is not installed, install it. - echo "Error when installing V1" + else { + # Isolated per-module run: install only Authentication + the single workload + # submodule for the target profile. + $toInstall += 'Microsoft.Graph.Authentication' + if ($installProfile -eq 'beta') { + $toInstall += "Microsoft.Graph.Beta.$module" + } + else { + $toInstall += "Microsoft.Graph.$module" + } + } + + foreach ($m in $toInstall) { + try { + Install-Module $m -Repository PowerShell_V2_Build -Credential $cred -Scope AllUsers -AcceptLicense -SkipPublisherCheck -Force -AllowClobber + } + catch { + # Do not fail the install step; a missing/failed module surfaces later as a + # fail-safe (no deletion, no PR) in the isolated generation stage. + Write-Host "##vso[task.logissue type=warning]Failed to install $m : $($_.Exception.Message)" + } } - $modules = Get-Module -Name Microsoft.Graph -ListAvailable + $modules = Get-Module -Name Microsoft.Graph* -ListAvailable foreach($r in $modules) { - echo $r.Version + echo "$($r.Name) $($r.Version)" } env: SYSTEM_ACCESSTOKEN: $(System.AccessToken) diff --git a/scripts/CorrectRelatedLinks-AllFiles.ps1 b/scripts/CorrectRelatedLinks-AllFiles.ps1 index 3f6a71383b9e6..be414538528a7 100644 --- a/scripts/CorrectRelatedLinks-AllFiles.ps1 +++ b/scripts/CorrectRelatedLinks-AllFiles.ps1 @@ -19,7 +19,11 @@ param( [Parameter(Mandatory = $false)] [ValidateSet("v1.0", "beta", "both")] - [string]$GraphProfile = "both" + [Alias("GraphProfileFilter")] + [string]$GraphProfile = "both", + + [Parameter(Mandatory = $false)] + [string]$ModuleFilter = "" ) function Get-GraphMapping { @@ -217,6 +221,10 @@ if ($ModulesToGenerate.Count -eq 0) { } } +if (-not [string]::IsNullOrWhiteSpace($ModuleFilter)) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) +} + # Main execution Write-Host "=== Related Links Correction Script ===" -ForegroundColor Blue Write-Host "Working directory: $WorkLoadDocsPath" -ForegroundColor Blue diff --git a/scripts/EscapeDisallowedHtmlTags.ps1 b/scripts/EscapeDisallowedHtmlTags.ps1 index 597d7a5633f81..0039a05b33500 100644 --- a/scripts/EscapeDisallowedHtmlTags.ps1 +++ b/scripts/EscapeDisallowedHtmlTags.ps1 @@ -2,7 +2,10 @@ # Licensed under the MIT License. Param( $ModulesToGenerate = @(), - [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc") + [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Get-GraphMapping { $graphMapping = @{} @@ -20,13 +23,19 @@ function EscapeDisallowedHtmlTags { $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { $graphProfile = $_ + if ($GraphProfileFilter -ne "both" -and $graphProfile -ne $GraphProfileFilter) { return } Get-FilesByProfile -GraphProfile $graphProfile -GraphProfilePath $GraphMapping[$graphProfile] -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate } git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Escaped disallowed html tags" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Escaped disallowed html tags" + } else { + $global:LASTEXITCODE = 0 + } } function Get-FilesByProfile { Param( @@ -322,5 +331,8 @@ function CleanupFile { } Write-Host -ForegroundColor Green "-------------finished checking out to today's branch-------------" +if (-not [string]::IsNullOrWhiteSpace($ModuleFilter)) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) +} EscapeDisallowedHtmlTags -ModulesToGenerate $ModulesToGenerate Write-Host -ForegroundColor Green "-------------Done-------------" \ No newline at end of file diff --git a/scripts/GenerateAliasedDocs.ps1 b/scripts/GenerateAliasedDocs.ps1 index 97eba9685354d..c7ba9bec1d19c 100644 --- a/scripts/GenerateAliasedDocs.ps1 +++ b/scripts/GenerateAliasedDocs.ps1 @@ -6,12 +6,18 @@ See related PR for more information. #> +Param( + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" +) + function Start-GenerateAliasedDocs { $BreakingChangeReportV1Report = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/docs/PowerShellBreakingChanges-V1.0.csv") $BreakingChangeReportBetaReport = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/docs/PowerShellBreakingChanges-beta.csv") $Reports = @() - $Reports += $BreakingChangeReportV1Report - $Reports += $BreakingChangeReportBetaReport + if ($GraphProfileFilter -ne "beta") { $Reports += $BreakingChangeReportV1Report } + if ($GraphProfileFilter -ne "v1.0") { $Reports += $BreakingChangeReportBetaReport } foreach ($BreakingChangeReport in $Reports) { Import-Csv $BreakingChangeReport | ForEach-Object { $Command = $_."NewCmdlet" @@ -39,6 +45,7 @@ function Copy-Files { if($CmdDetails){ $Module = $CmdDetails.Module $Module = $Module.Replace("Beta.", "") + if (-not [string]::IsNullOrWhiteSpace($ModuleFilter) -and $Module -ne $ModuleFilter) { return } $Module = "$ModulePrefix.$Module" $NewDoc = (Join-Path $PSScriptRoot "../microsoftgraph" $GraphProfilePath $Module "$Command.md") if(Test-Path $NewDoc) { diff --git a/scripts/GenerateMarkDown.ps1 b/scripts/GenerateMarkDown.ps1 index 0d5a062bef429..ed6c85dcdb009 100644 --- a/scripts/GenerateMarkDown.ps1 +++ b/scripts/GenerateMarkDown.ps1 @@ -5,7 +5,16 @@ Param( $ModulesToGenerate = @(), [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config\ModulesMapping.jsonc"), [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph"), - [string] $CmdletMetadataPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src/Authentication/Authentication/custom/common/MgCommandMetadata.json") + [string] $CmdletMetadataPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src/Authentication/Authentication/custom/common/MgCommandMetadata.json"), + # Restrict generation to a single SDK profile ("v1.0" or "beta"); "both" keeps the + # original full-run behaviour. + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + # Restrict generation to a single module (e.g. "Applications" or "Authentication"). Empty + # means all modules. When set, the run is "scoped": the module's folder is completely + # cleared and regenerated, and an import failure aborts THIS run (fail-safe, no deletion) + # instead of silently skipping. + [string] $ModuleFilter = "" ) function Get-GraphMapping { $graphMapping = @{} @@ -51,36 +60,55 @@ function Start-GraphHelp { Param( $ModulesToGenerate = @() ) - - #Generate for auth module first + $ModulePrefix = "Microsoft.Graph" $AuthPath = "$ModulePrefix.Authentication" $AuthDestination = Join-Path $WorkLoadDocsPath "graph-powershell-1.0" $AuthPath - # Guard against catastrophic deletions: never remove existing docs unless the module - # is available to regenerate them. Authentication is required for every run, so abort - # if it failed to install rather than wiping committed documentation. - if (-not (Get-Module -Name Microsoft.Graph.Authentication -ListAvailable -ErrorAction SilentlyContinue)) { - throw "Microsoft.Graph.Authentication module is not available. Aborting generation to avoid deleting existing documentation." + # Determine which profiles this run covers. + $GraphMapping = Get-GraphMapping + $profilesToProcess = @($GraphMapping.Keys) + if ($GraphProfileFilter -ne "both") { + $profilesToProcess = @($GraphProfileFilter) } - Import-Module Microsoft.Graph.Authentication -Force -Global -ErrorAction Stop - Get-ChildItem -Path $AuthDestination * -File -Recurse | foreach { $_.Delete() } - $GraphMapping = Get-GraphMapping - $GraphMapping.Keys | ForEach-Object { - $graphProfile = $_ - $profilePath = "graph-powershell-1.0" - if ($graphProfile -eq "beta") { - $profilePath = "graph-powershell-beta" - } + # Authentication docs live under graph-powershell-1.0 and are only generated on a full run + # or when Authentication is the explicitly targeted module. + $generateAuth = ([string]::IsNullOrWhiteSpace($ModuleFilter) -or $ModuleFilter -eq "Authentication") + if ($generateAuth -and ($profilesToProcess -contains "v1.0")) { + # Guard against catastrophic deletions: never remove existing docs unless the module + # is available to regenerate them. Authentication is required for every run, so abort + # if it failed to install rather than wiping committed documentation. + if (-not (Get-Module -Name Microsoft.Graph.Authentication -ListAvailable -ErrorAction SilentlyContinue)) { + throw "Microsoft.Graph.Authentication module is not available. Aborting generation to avoid deleting existing documentation." + } + Import-Module Microsoft.Graph.Authentication -Force -Global -ErrorAction Stop + Get-ChildItem -Path $AuthDestination * -File -Recurse | foreach { $_.Delete() } $AuthenticationDocsPath = Join-Path $PSScriptRoot "..\microsoftgraph\graph-powershell-1.0" - Set-Help -ModuleDocsPath $AuthenticationDocsPath -Command "Connect-MgGraph" -Module "Microsoft.Graph.Authentication" - Get-FolderByProfile -GraphProfile $graphProfile -GraphProfilePath $profilePath -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate + Set-Help -ModuleDocsPath $AuthenticationDocsPath -Command "Connect-MgGraph" -Module "Microsoft.Graph.Authentication" + } + + # Workload modules. Skip entirely when Authentication is the explicit single target. + if ($ModuleFilter -ne "Authentication") { + $profilesToProcess | ForEach-Object { + $graphProfile = $_ + $profilePath = "graph-powershell-1.0" + if ($graphProfile -eq "beta") { + $profilePath = "graph-powershell-beta" + } + Get-FolderByProfile -GraphProfile $graphProfile -GraphProfilePath $profilePath -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate + } } + git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Updated markdown help" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Updated markdown help" + } else { + $global:LASTEXITCODE = 0 + } } function Get-FolderByProfile { @@ -95,6 +123,14 @@ function Get-FolderByProfile { $ModulesToGenerate = @() ) $CommandMetadataContent = Get-Content $CmdletMetadataPath | ConvertFrom-Json + + # In scoped (single-module) runs, restrict to the requested module and enable + # complete-delete + regenerate for it (safe because the module is verified to import + # below before anything is removed). + $Scoped = -not [string]::IsNullOrWhiteSpace($ModuleFilter) + if ($Scoped) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) + } $ModulesToGenerate | ForEach-Object { $ModuleName = $_ @@ -125,6 +161,12 @@ function Get-FolderByProfile { } } if (-not $ModuleUsable) { + if ($Scoped) { + # Isolated single-module run: fail fast WITHOUT deleting anything so the + # module's committed docs are preserved. The pipeline job contains this + # failure (continueOnError) so it never fails the whole run or other modules. + throw "Module $Path is not usable in isolated generation; aborting this module without deleting its documentation." + } Write-Warning "Module $Path is not usable; skipping to preserve existing documentation." return } @@ -132,6 +174,13 @@ function Get-FolderByProfile { if (-not(Test-Path $Destination)) { New-Item -Path $Destination -ItemType Directory } + elseif ($Scoped) { + # Complete deletion + regeneration for this single module. Safe here because the + # module imported successfully above, so regeneration repopulates the folder. + Get-ChildItem -Path $Destination -Filter "*.md" -File | ForEach-Object { + Remove-Item $_.FullName -Force + } + } # NOTE: docs are intentionally NOT bulk-deleted here. Each doc is overwritten in # place as it is regenerated, and only genuine orphans (commands no longer in the @@ -209,4 +258,8 @@ if ($ModulesToGenerate.Count -eq 0) { } Write-Host -ForegroundColor Green "-------------finished checking out to today's branch-------------" Start-GraphHelp -ModulesToGenerate $ModulesToGenerate +# Signal successful generation so downstream pipeline steps (post-processing, push, PR) only +# run when this module actually generated. On an import failure the script throws before this +# line, the variable is never set, and the isolated stage opens no PR and deletes nothing. +Write-Host "##vso[task.setvariable variable=ModuleGenerated]true" Write-Host -ForegroundColor Green "-------------Done-------------" \ No newline at end of file diff --git a/scripts/GeneratePermissionsTable.ps1 b/scripts/GeneratePermissionsTable.ps1 index 47e90ae3698f8..d854d62458c62 100644 --- a/scripts/GeneratePermissionsTable.ps1 +++ b/scripts/GeneratePermissionsTable.ps1 @@ -1,6 +1,9 @@ param( [string]$MgCommandMetadatJsonFile = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src/Authentication/Authentication/custom/common/MgCommandMetadata.json"), - [string[]]$CmdList = @() + [string[]]$CmdList = @(), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Start-Generator { @@ -11,6 +14,9 @@ function Start-Generator { $CommandName = $_.Command; $ApiVersion = $_.ApiVersion $Module = $_.Module; + if ($GraphProfileFilter -ne "both" -and $ApiVersion -ne $GraphProfileFilter) { return } + $normalizedModule = $Module -replace "^Beta\.", "" + if (-not [string]::IsNullOrWhiteSpace($ModuleFilter) -and $normalizedModule -ne $ModuleFilter) { return } #Array for DelegatedWork Permissions $DelegatedWorkPermissions = @(); #Array for Application Permissions @@ -70,7 +76,12 @@ function Start-Generator { git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Inserted permissions Table" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Inserted permissions Table" + } else { + $global:LASTEXITCODE = 0 + } } catch { Write-Host "Error in $_"; diff --git a/scripts/MsSubserviceUpdate.ps1 b/scripts/MsSubserviceUpdate.ps1 index d9bbd826afe67..54ce3c003d8ca 100644 --- a/scripts/MsSubserviceUpdate.ps1 +++ b/scripts/MsSubserviceUpdate.ps1 @@ -5,7 +5,10 @@ Param( [string] $SDKDocsPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src"), [string] $SDKOpenApiPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell"), [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph"), - [string] $MissingMsSubserviceHeaderPath = (Join-Path $PSScriptRoot "../missingexternaldocsurl") + [string] $MissingMsSubserviceHeaderPath = (Join-Path $PSScriptRoot "../missingexternaldocsurl"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Start-Generator { if (Test-Path $CommandMetadataPath) { @@ -22,6 +25,8 @@ function Start-Generator { $ModulePrefix = "Microsoft.Graph.Beta" $ModuleName = $ModuleName.Replace("Beta.", "") } + if ($GraphProfileFilter -ne "both" -and $GraphProfile -ne $GraphProfileFilter) { return } + if (-not [string]::IsNullOrWhiteSpace($ModuleFilter) -and $ModuleName -ne $ModuleFilter) { return } $Path = "$ModulePrefix.$ModuleName" $DestinationFile = Join-Path $WorkLoadDocsPath $GraphProfilePath $Path "$Command.md" try { diff --git a/scripts/RemoveBoilerPlateCode.ps1 b/scripts/RemoveBoilerPlateCode.ps1 index 246e79ba3febe..8158654b106a1 100644 --- a/scripts/RemoveBoilerPlateCode.ps1 +++ b/scripts/RemoveBoilerPlateCode.ps1 @@ -4,7 +4,10 @@ Param( $ModulesToGenerate = @(), [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc"), [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph"), - [string] $AuthLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Authentication") + [string] $AuthLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph/graph-powershell-1.0/Microsoft.Graph.Authentication"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Get-GraphMapping { $graphMapping = @{} @@ -19,19 +22,22 @@ function Start-Repair { $ModulesToGenerate = @() ) - #Cleanup Authentication Module first - $files = Get-ChildItem -Path $AuthLoadDocsPath -Filter *.md -Recurse - foreach ($file in $files) { - $content = Get-Content -Path $file.FullName - # Remove lines that contain '{{ Fill in the Description }}' or '### This' or '### *' or '### have' or '### certain' or '### the' - $cleanedContent = $content | Where-Object { $_ -notmatch '^\s*{{ Fill in the Description }}|^\s*### This|^\s*### \*|^\s*### have|^\s*### certain|^\s*### the' } - # Write the cleaned content back to the file - $cleanedContent | Set-Content -Path $file.FullName + #Cleanup Authentication Module first (only on a full run or the Authentication stage). + if ([string]::IsNullOrWhiteSpace($ModuleFilter) -or $ModuleFilter -eq "Authentication") { + $files = Get-ChildItem -Path $AuthLoadDocsPath -Filter *.md -Recurse + foreach ($file in $files) { + $content = Get-Content -Path $file.FullName + # Remove lines that contain '{{ Fill in the Description }}' or '### This' or '### *' or '### have' or '### certain' or '### the' + $cleanedContent = $content | Where-Object { $_ -notmatch '^\s*{{ Fill in the Description }}|^\s*### This|^\s*### \*|^\s*### have|^\s*### certain|^\s*### the' } + # Write the cleaned content back to the file + $cleanedContent | Set-Content -Path $file.FullName + } } $ModulePrefix = "Microsoft.Graph" $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { $graphProfile = $_ + if ($GraphProfileFilter -ne "both" -and $graphProfile -ne $GraphProfileFilter) { return } $profilePath = "graph-powershell-1.0" if ($graphProfile -eq "beta") { $profilePath = "graph-powershell-beta" @@ -41,7 +47,12 @@ function Start-Repair { git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Remove boiler plate code injected by Autorest" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Remove boiler plate code injected by Autorest" + } else { + $global:LASTEXITCODE = 0 + } } function Get-FilesByProfile { Param( @@ -118,5 +129,8 @@ if ($ModulesToGenerate.Count -eq 0) { } Write-Host -ForegroundColor Green "-------------finished checking out to today's branch-------------" +if (-not [string]::IsNullOrWhiteSpace($ModuleFilter)) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) +} Start-Repair -ModulesToGenerate $ModulesToGenerate Write-Host -ForegroundColor Green "-------------Done-------------" \ No newline at end of file diff --git a/scripts/RemoveInvalidFullStops.ps1 b/scripts/RemoveInvalidFullStops.ps1 index db34789d58025..21cfad73afe51 100644 --- a/scripts/RemoveInvalidFullStops.ps1 +++ b/scripts/RemoveInvalidFullStops.ps1 @@ -2,7 +2,10 @@ # Licensed under the MIT License. Param( $ModulesToGenerate = @(), - [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc") + [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Get-GraphMapping { $graphMapping = @{} @@ -20,13 +23,19 @@ function Remove-InvalidFullStops { $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { $graphProfile = $_ + if ($GraphProfileFilter -ne "both" -and $graphProfile -ne $GraphProfileFilter) { return } Get-FilesByProfile -GraphProfile $graphProfile -GraphProfilePath $GraphMapping[$graphProfile] -ModulePrefix $ModulePrefix -ModulesToGenerate $ModulesToGenerate } git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Removed invalid full stops from the beginning of lines" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Removed invalid full stops from the beginning of lines" + } else { + $global:LASTEXITCODE = 0 + } } function Get-FilesByProfile { Param( @@ -88,6 +97,9 @@ if ($ModulesToGenerate.Count -eq 0) { [HashTable] $ModuleMapping = Get-Content $ModuleMappingConfigPath | ConvertFrom-Json -AsHashTable $ModulesToGenerate = $ModuleMapping.Keys } +if (-not [string]::IsNullOrWhiteSpace($ModuleFilter)) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) +} Remove-InvalidFullStops -ModulesToGenerate $ModulesToGenerate diff --git a/scripts/RepairExamplesDescriptionsAndTitle.ps1 b/scripts/RepairExamplesDescriptionsAndTitle.ps1 index c8e3c74074799..e1fd1d5a8f172 100644 --- a/scripts/RepairExamplesDescriptionsAndTitle.ps1 +++ b/scripts/RepairExamplesDescriptionsAndTitle.ps1 @@ -4,7 +4,10 @@ Param( $ModulesToGenerate = @(), [string] $SDKDocsPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src"), [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph"), - [string] $CommandMetadataPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src/Authentication/Authentication/custom/common/MgCommandMetadata.json") + [string] $CommandMetadataPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src/Authentication/Authentication/custom/common/MgCommandMetadata.json"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Start-Copy { @@ -22,6 +25,8 @@ function Start-Copy { $ModulePrefix = "Microsoft.Graph.Beta" $ModuleName = $ModuleName.Replace("Beta.", "") } + if ($GraphProfileFilter -ne "both" -and $GraphProfile -ne $GraphProfileFilter) { return } + if (-not [string]::IsNullOrWhiteSpace($ModuleFilter) -and $ModuleName -ne $ModuleFilter) { return } $DocPath = Join-Path $SDKDocsPath $ModuleName $GraphProfile "examples" "$Command.md" try { @@ -38,7 +43,12 @@ function Start-Copy { git config --global user.email "GraphTooling@service.microsoft.com" git config --global user.name "Microsoft Graph DevX Tooling" git add . - git commit -m "Repaired examples and descriptions" + $pending = git status --porcelain + if (-not [string]::IsNullOrWhiteSpace($pending)) { + git commit -m "Repaired examples and descriptions" + } else { + $global:LASTEXITCODE = 0 + } } diff --git a/scripts/UpdateLinks.ps1 b/scripts/UpdateLinks.ps1 index fcc8d8e2253b2..1ba011281aa6a 100644 --- a/scripts/UpdateLinks.ps1 +++ b/scripts/UpdateLinks.ps1 @@ -4,7 +4,10 @@ Param( $ModulesToGenerate = @(), [string] $ModuleMappingConfigPath = (Join-Path $PSScriptRoot "../microsoftgraph/config/ModulesMapping.jsonc"), [string] $SDKDocsPath = (Join-Path $PSScriptRoot "../msgraph-sdk-powershell/src"), - [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph") + [string] $WorkLoadDocsPath = (Join-Path $PSScriptRoot "../microsoftgraph"), + [ValidateSet("both", "v1.0", "beta")] + [string] $GraphProfileFilter = "both", + [string] $ModuleFilter = "" ) function Get-GraphMapping { $graphMapping = @{} @@ -22,6 +25,7 @@ function Start-Update { $GraphMapping = Get-GraphMapping $GraphMapping.Keys | ForEach-Object { $GraphProfile = $_ + if ($GraphProfileFilter -ne "both" -and $GraphProfile -ne $GraphProfileFilter) { return } $profilePath = "graph-powershell-1.0" if ($GraphProfile -eq "beta") { $ProfilePath = "graph-powershell-beta" @@ -205,5 +209,8 @@ if ($ModulesToGenerate.Count -eq 0) { Write-Host -ForegroundColor Green "-------------finished checking out to today's branch-------------" +if (-not [string]::IsNullOrWhiteSpace($ModuleFilter)) { + $ModulesToGenerate = @($ModulesToGenerate | Where-Object { $_ -eq $ModuleFilter }) +} Start-Update -ModulesToGenerate $ModulesToGenerate Write-Host -ForegroundColor Green "-------------Done-------------" \ No newline at end of file From 5202fe4d4c7f28cceeacc3451143fda9366e18b0 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 11:11:08 -0700 Subject: [PATCH 09/16] Fix template path resolution in powershell-docs.yml Azure DevOps resolves template references relative to the directory of the referencing file. powershell-docs.yml lives in azure-pipelines/, so the "azure-pipelines/common-templates/module-stages.yml@self" path resolved to azure-pipelines/azure-pipelines/common-templates/module-stages.yml and failed with "Not Found". Use a path relative to the file's own directory instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 4d27d82f-3809-40d2-b4e7-6623436ff2ef --- azure-pipelines/powershell-docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/azure-pipelines/powershell-docs.yml b/azure-pipelines/powershell-docs.yml index b6dc5b22f8b9b..71679bf595944 100644 --- a/azure-pipelines/powershell-docs.yml +++ b/azure-pipelines/powershell-docs.yml @@ -47,7 +47,7 @@ extends: customBuildTags: - ES365AIMigrationTooling stages: - - template: azure-pipelines/common-templates/module-stages.yml@self + - template: common-templates/module-stages.yml@self parameters: GraphProfileFilter: "v1.0" ProfileLabel: "v1" @@ -99,7 +99,7 @@ extends: - Users.Actions - Users.Functions - WindowsUpdates - - template: azure-pipelines/common-templates/module-stages.yml@self + - template: common-templates/module-stages.yml@self parameters: GraphProfileFilter: "beta" ProfileLabel: "beta" From 4a7f896bcb0a6ff254b8d532449367dde04f7ca6 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:13:41 +0000 Subject: [PATCH 10/16] Updated markdown help --- ...anagementWindowsEnrollmentAutoDiscovery.md | 50 +++++-------------- ...t-MgDeviceManagementEffectivePermission.md | 50 +++++-------------- .../Invoke-MgExperienceDeviceManagement.md | 46 ++++------------- ...rosoft.Graph.DeviceManagement.Functions.md | 21 +------- 4 files changed, 38 insertions(+), 129 deletions(-) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index 26b31e96c9382..023f5c226c527 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -4,7 +4,7 @@ external help file: Microsoft.Graph.DeviceManagement.Functions-Help.xml HelpUri: https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery Locale: en-US Module Name: Microsoft.Graph.DeviceManagement.Functions -ms.date: 06/05/2026 +ms.date: 07/31/2026 PlatyPS schema version: 2024-05-01 title: Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery --- @@ -15,9 +15,6 @@ title: Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery Invoke function verifyWindowsEnrollmentAutoDiscovery -> [!NOTE] -> To view the beta release of this cmdlet, view [Confirm-MgBetaDeviceManagementWindowsEnrollmentAutoDiscovery](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Confirm-MgBetaDeviceManagementWindowsEnrollmentAutoDiscovery?view=graph-powershell-beta) - ## SYNTAX ### Verify (Default) @@ -26,7 +23,7 @@ Invoke function verifyWindowsEnrollmentAutoDiscovery Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery -DomainName [-ResponseHeadersVariable ] [-Break] [-Headers ] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] ``` ### VerifyViaIdentity @@ -36,7 +33,7 @@ Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery -InputObject [-ResponseHeadersVariable ] [-Break] [-Headers ] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-ProxyUseDefaultCredentials] ``` ## ALIASES @@ -48,13 +45,15 @@ This cmdlet has the following aliases, Invoke function verifyWindowsEnrollmentAutoDiscovery -**Permissions** +## EXAMPLES + +### EXAMPLE 1 + +{{ Add code here }} + +### EXAMPLE 2 -| Permission type | Permissions (from least to most privileged) | -| --------------- | ------------------------------------------ | -| Delegated (work or school account) | DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | -| Delegated (personal Microsoft account) | Not supported | -| Application | DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | +{{ Add code here }} ## PARAMETERS @@ -300,34 +299,11 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT ``: Identity Parameter +INPUTOBJECT : Identity Parameter [DomainName ]: Usage: domainName='{domainName}' [Scope ]: Usage: scope='{scope}' ## RELATED LINKS -- [Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery) - - - - - - - - - - - - - - - - - - - - - - - +- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index 62761e07d596f..1d8b4b51d2231 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -4,7 +4,7 @@ external help file: Microsoft.Graph.DeviceManagement.Functions-Help.xml HelpUri: https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission Locale: en-US Module Name: Microsoft.Graph.DeviceManagement.Functions -ms.date: 06/05/2026 +ms.date: 07/31/2026 PlatyPS schema version: 2024-05-01 title: Get-MgDeviceManagementEffectivePermission --- @@ -15,9 +15,6 @@ title: Get-MgDeviceManagementEffectivePermission Retrieves the effective permissions of the currently authenticated user -> [!NOTE] -> To view the beta release of this cmdlet, view [Get-MgBetaDeviceManagementEffectivePermission](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Get-MgBetaDeviceManagementEffectivePermission?view=graph-powershell-beta) - ## SYNTAX ### Get (Default) @@ -27,7 +24,7 @@ Get-MgDeviceManagementEffectivePermission -Scope [-Count] [-Filter ] [-Skip ] [-Top ] [-ResponseHeadersVariable ] [-Break] [-Headers ] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-ProxyUseDefaultCredentials] ``` ### GetViaIdentity @@ -37,7 +34,7 @@ Get-MgDeviceManagementEffectivePermission -InputObject ] [-Search ] [-Skip ] [-Top ] [-ResponseHeadersVariable ] [-Break] [-Headers ] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] - [-ProxyCredential ] [-ProxyUseDefaultCredentials] [] + [-ProxyCredential ] [-ProxyUseDefaultCredentials] ``` ## ALIASES @@ -49,13 +46,15 @@ This cmdlet has the following aliases, Retrieves the effective permissions of the currently authenticated user -**Permissions** +## EXAMPLES + +### EXAMPLE 1 + +{{ Add code here }} + +### EXAMPLE 2 -| Permission type | Permissions (from least to most privileged) | -| --------------- | ------------------------------------------ | -| Delegated (work or school account) | DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All, | -| Delegated (personal Microsoft account) | Not supported | -| Application | DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All, | +{{ Add code here }} ## PARAMETERS @@ -407,34 +406,11 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT ``: Identity Parameter +INPUTOBJECT : Identity Parameter [DomainName ]: Usage: domainName='{domainName}' [Scope ]: Usage: scope='{scope}' ## RELATED LINKS -- [Get-MgDeviceManagementEffectivePermission](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission) - - - - - - - - - - - - - - - - - - - - - - - +- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index e88ed8800953e..62017b58644f2 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -4,7 +4,7 @@ external help file: Microsoft.Graph.DeviceManagement.Functions-Help.xml HelpUri: https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement Locale: en-US Module Name: Microsoft.Graph.DeviceManagement.Functions -ms.date: 06/05/2026 +ms.date: 07/31/2026 PlatyPS schema version: 2024-05-01 title: Invoke-MgExperienceDeviceManagement --- @@ -15,9 +15,6 @@ title: Invoke-MgExperienceDeviceManagement Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices -> [!NOTE] -> To view the beta release of this cmdlet, view [Invoke-MgBetaExperienceDeviceManagement](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Invoke-MgBetaExperienceDeviceManagement?view=graph-powershell-beta) - ## SYNTAX ### Experience (Default) @@ -26,7 +23,7 @@ Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices Invoke-MgExperienceDeviceManagement [-ResponseHeadersVariable ] [-Break] [-Headers ] [-HttpPipelineAppend ] [-HttpPipelinePrepend ] [-Proxy ] [-ProxyCredential ] - [-ProxyUseDefaultCredentials] [] + [-ProxyUseDefaultCredentials] ``` ## ALIASES @@ -38,13 +35,15 @@ This cmdlet has the following aliases, Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices -**Permissions** +## EXAMPLES + +### EXAMPLE 1 + +{{ Add code here }} + +### EXAMPLE 2 -| Permission type | Permissions (from least to most privileged) | -| --------------- | ------------------------------------------ | -| Delegated (work or school account) | DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | -| Delegated (personal Microsoft account) | Not supported | -| Application | DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | +{{ Add code here }} ## PARAMETERS @@ -240,27 +239,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -- [Invoke-MgExperienceDeviceManagement](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement) - - - - - - - - - - - - - - - - - - - - - - - +- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md index 91de6f91a40c8..3733e22a9d813 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md @@ -1,6 +1,6 @@ --- Module Name: Microsoft.Graph.DeviceManagement.Functions -Module Guid: aeaea934-f28e-450d-b1bb-2526cb306ac8 +Module Guid: e7c862cb-ae19-4a92-8bd1-b74491001bc2 Download Help Link: https://learn.microsoft.com/en-us/powershell/module/microsoft.graph.devicemanagement.functions/?view=graph-powershell-1.0 Help Version: 1.0.0.0 Locale: en-US @@ -17,22 +17,3 @@ Microsoft Graph PowerShell Cmdlets ### [Invoke-MgExperienceDeviceManagement](Invoke-MgExperienceDeviceManagement.md) - - - - - - - - - - - - - - - - - - - From c5128dcb721b1496a44a6d6995a1fe2195bcbb7e Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:13:45 +0000 Subject: [PATCH 11/16] Escaped disallowed html tags --- ...anagementWindowsEnrollmentAutoDiscovery.md | 24 ++++++++++++++++++- ...t-MgDeviceManagementEffectivePermission.md | 24 ++++++++++++++++++- .../Invoke-MgExperienceDeviceManagement.md | 22 +++++++++++++++++ ...rosoft.Graph.DeviceManagement.Functions.md | 19 +++++++++++++++ 4 files changed, 87 insertions(+), 2 deletions(-) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index 023f5c226c527..c0d965713196a 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -299,7 +299,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT : Identity Parameter +INPUTOBJECT ``: Identity Parameter [DomainName ]: Usage: domainName='{domainName}' [Scope ]: Usage: scope='{scope}' @@ -307,3 +307,25 @@ INPUTOBJECT : Identity Parameter ## RELATED LINKS - [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery) + + + + + + + + + + + + + + + + + + + + + + diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index 1d8b4b51d2231..bfdbcc8e80ce6 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -406,7 +406,7 @@ COMPLEX PARAMETER PROPERTIES To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT : Identity Parameter +INPUTOBJECT ``: Identity Parameter [DomainName ]: Usage: domainName='{domainName}' [Scope ]: Usage: scope='{scope}' @@ -414,3 +414,25 @@ INPUTOBJECT : Identity Parameter ## RELATED LINKS - [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission) + + + + + + + + + + + + + + + + + + + + + + diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index 62017b58644f2..d5b855b1c41b4 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -240,3 +240,25 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS - [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement) + + + + + + + + + + + + + + + + + + + + + + diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md index 3733e22a9d813..50d9265077a81 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Microsoft.Graph.DeviceManagement.Functions.md @@ -17,3 +17,22 @@ Microsoft Graph PowerShell Cmdlets ### [Invoke-MgExperienceDeviceManagement](Invoke-MgExperienceDeviceManagement.md) + + + + + + + + + + + + + + + + + + + From d7c353378e2420114d0e43df53aa1faaf7db880c Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:26:33 +0000 Subject: [PATCH 12/16] Inserted permissions Table --- ...rm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md | 8 ++++++++ .../Get-MgDeviceManagementEffectivePermission.md | 8 ++++++++ .../Invoke-MgExperienceDeviceManagement.md | 8 ++++++++ 3 files changed, 24 insertions(+) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index c0d965713196a..d0eb47e9d559f 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -45,6 +45,14 @@ This cmdlet has the following aliases, Invoke function verifyWindowsEnrollmentAutoDiscovery +**Permissions** + +| Permission type | Permissions (from least to most privileged) | +| --------------- | ------------------------------------------ | +| Delegated (work or school account) | DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | +| Delegated (personal Microsoft account) | Not supported | +| Application | DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | + ## EXAMPLES ### EXAMPLE 1 diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index bfdbcc8e80ce6..f092ab3f445c9 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -46,6 +46,14 @@ This cmdlet has the following aliases, Retrieves the effective permissions of the currently authenticated user +**Permissions** + +| Permission type | Permissions (from least to most privileged) | +| --------------- | ------------------------------------------ | +| Delegated (work or school account) | DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All, | +| Delegated (personal Microsoft account) | Not supported | +| Application | DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All, | + ## EXAMPLES ### EXAMPLE 1 diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index d5b855b1c41b4..d1601c3ef432c 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -35,6 +35,14 @@ This cmdlet has the following aliases, Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices +**Permissions** + +| Permission type | Permissions (from least to most privileged) | +| --------------- | ------------------------------------------ | +| Delegated (work or school account) | DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | +| Delegated (personal Microsoft account) | Not supported | +| Application | DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | + ## EXAMPLES ### EXAMPLE 1 From ed2464737255adf4f2e4bfa4be1f77651f084ba2 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:26:41 +0000 Subject: [PATCH 13/16] Updated metadata parameters --- ...Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md | 3 +++ .../Get-MgDeviceManagementEffectivePermission.md | 3 +++ .../Invoke-MgExperienceDeviceManagement.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index d0eb47e9d559f..c4bd2c9907514 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -15,6 +15,9 @@ title: Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery Invoke function verifyWindowsEnrollmentAutoDiscovery +> [!NOTE] +> To view the beta release of this cmdlet, view [Confirm-MgBetaDeviceManagementWindowsEnrollmentAutoDiscovery](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Confirm-MgBetaDeviceManagementWindowsEnrollmentAutoDiscovery?view=graph-powershell-beta) + ## SYNTAX ### Verify (Default) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index f092ab3f445c9..c593d63a1df6e 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -15,6 +15,9 @@ title: Get-MgDeviceManagementEffectivePermission Retrieves the effective permissions of the currently authenticated user +> [!NOTE] +> To view the beta release of this cmdlet, view [Get-MgBetaDeviceManagementEffectivePermission](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Get-MgBetaDeviceManagementEffectivePermission?view=graph-powershell-beta) + ## SYNTAX ### Get (Default) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index d1601c3ef432c..04bcf273d13a4 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -15,6 +15,9 @@ title: Invoke-MgExperienceDeviceManagement Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices +> [!NOTE] +> To view the beta release of this cmdlet, view [Invoke-MgBetaExperienceDeviceManagement](/powershell/module/Microsoft.Graph.Beta.DeviceManagement.Functions/Invoke-MgBetaExperienceDeviceManagement?view=graph-powershell-beta) + ## SYNTAX ### Experience (Default) From 47e554eaa9716fe0a7f465b8c5426396d81c7cd0 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:26:46 +0000 Subject: [PATCH 14/16] Repaired examples and descriptions --- .../Get-MgDeviceManagementEffectivePermission.md | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index c593d63a1df6e..d61ba12c73ca8 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -57,16 +57,6 @@ Retrieves the effective permissions of the currently authenticated user | Delegated (personal Microsoft account) | Not supported | | Application | DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All, | -## EXAMPLES - -### EXAMPLE 1 - -{{ Add code here }} - -### EXAMPLE 2 - -{{ Add code here }} - ## PARAMETERS ### -Break @@ -445,5 +435,6 @@ INPUTOBJECT ``: Identity Parameter + From 735db79aa53ef74fa522bfcc65185f5c2224976a Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:26:49 +0000 Subject: [PATCH 15/16] Remove boiler plate code injected by Autorest --- ...gDeviceManagementWindowsEnrollmentAutoDiscovery.md | 11 +---------- .../Invoke-MgExperienceDeviceManagement.md | 11 +---------- 2 files changed, 2 insertions(+), 20 deletions(-) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index c4bd2c9907514..999cc8e3445c9 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -56,16 +56,6 @@ Invoke function verifyWindowsEnrollmentAutoDiscovery | Delegated (personal Microsoft account) | Not supported | | Application | DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | -## EXAMPLES - -### EXAMPLE 1 - -{{ Add code here }} - -### EXAMPLE 2 - -{{ Add code here }} - ## PARAMETERS ### -Break @@ -338,5 +328,6 @@ INPUTOBJECT ``: Identity Parameter + diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index 04bcf273d13a4..0211fe24399d5 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -46,16 +46,6 @@ Invoke function userExperienceAnalyticsSummarizeWorkFromAnywhereDevices | Delegated (personal Microsoft account) | Not supported | | Application | DeviceManagementManagedDevices.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All, | -## EXAMPLES - -### EXAMPLE 1 - -{{ Add code here }} - -### EXAMPLE 2 - -{{ Add code here }} - ## PARAMETERS ### -Break @@ -271,5 +261,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable + From f8a08bf50d2737945849a28318e5db5cf10264d1 Mon Sep 17 00:00:00 2001 From: Microsoft Graph DevX Tooling Date: Fri, 31 Jul 2026 19:27:06 +0000 Subject: [PATCH 16/16] Corrected related link to conform to the new platyps rules --- .../Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md | 2 +- .../Get-MgDeviceManagementEffectivePermission.md | 2 +- .../Invoke-MgExperienceDeviceManagement.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md index 999cc8e3445c9..51235e90668aa 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery.md @@ -307,7 +307,7 @@ INPUTOBJECT ``: Identity Parameter ## RELATED LINKS -- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery) +- [Confirm-MgDeviceManagementWindowsEnrollmentAutoDiscovery](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/confirm-mgdevicemanagementwindowsenrollmentautodiscovery) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md index d61ba12c73ca8..035cdad1133b9 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Get-MgDeviceManagementEffectivePermission.md @@ -414,7 +414,7 @@ INPUTOBJECT ``: Identity Parameter ## RELATED LINKS -- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission) +- [Get-MgDeviceManagementEffectivePermission](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/get-mgdevicemanagementeffectivepermission) diff --git a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md index 0211fe24399d5..419ba08f1b7cf 100644 --- a/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md +++ b/microsoftgraph/graph-powershell-1.0/Microsoft.Graph.DeviceManagement.Functions/Invoke-MgExperienceDeviceManagement.md @@ -240,7 +240,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -- [](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement) +- [Invoke-MgExperienceDeviceManagement](https://learn.microsoft.com/powershell/module/microsoft.graph.devicemanagement.functions/invoke-mgexperiencedevicemanagement)