Modules/AzureDevOpsDsc.Common/Api/Functions/Private/Authentication/AzureCLI/Get-AzCliToken.ps1
|
<#
.SYNOPSIS Acquires an Azure DevOps Bearer token using the Azure CLI. .DESCRIPTION Invokes `az account get-access-token` to obtain a Bearer token scoped to the Azure DevOps resource. Requires the Azure CLI to be installed and an active login session (`az login`). .PARAMETER OrganizationName Azure DevOps organization name, used when verifying the token. .PARAMETER Verify If set, verifies the token by calling the Azure DevOps API after acquisition. #> Function Get-AzCliToken { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String]$OrganizationName, [Parameter()] [Switch]$Verify ) Write-Verbose "[Get-AzCliToken] Acquiring Azure CLI token for organization '$OrganizationName'." # Check that az CLI is available if (-not (Get-Command az -ErrorAction SilentlyContinue)) { throw "[Get-AzCliToken] The Azure CLI ('az') is not installed or not found on PATH. Install it from https://docs.microsoft.com/cli/azure/install-azure-cli and run 'az login'." } # Invoke az and capture output. $LASTEXITCODE is read inside Invoke-AzCLICommand itself (right # after the native call) and returned explicitly, rather than read here after the call returns - # it's a global, ambient variable that isn't reliably preserved across a mocked function # boundary in unit tests. $azResult = Invoke-AzCLICommand -Arguments @('account', 'get-access-token', '--resource', '499b84ac-1321-427f-aa17-267ca6975798') $azOutput = $azResult.Output if ($azResult.ExitCode -ne 0) { throw "[Get-AzCliToken] The Azure CLI returned a non-zero exit code ($($azResult.ExitCode)). Ensure you are logged in with 'az login'. Output: $(Protect-AzDoSecretString -InputString ($azOutput | Out-String).Trim())" } # Invoke-AzCLICommand merges stderr into the output, so a warning from az (an upgrade notice, # a deprecation) arrives as an ErrorRecord next to the JSON. Only stdout is parsed. On a # successful exit the output holds the access token, so it is never put in an error message. $azStandardOutput = @($azOutput | Where-Object { $_ -isnot [System.Management.Automation.ErrorRecord] }) -join [System.Environment]::NewLine try { $response = $azStandardOutput | ConvertFrom-Json -ErrorAction Stop } catch { throw "[Get-AzCliToken] Failed to parse Azure CLI output as JSON. The output is not shown because it can contain the access token." } if ([String]::IsNullOrEmpty($response.accessToken)) { throw "[Get-AzCliToken] Access token not returned by Azure CLI. Ensure you are logged in and have access to the Azure DevOps resource." } Write-Verbose "[Get-AzCliToken] Token acquired successfully." $token = New-AzureCliToken -CLITokenResponse $response if (-not $Verify) { return $token } Write-Verbose "[Get-AzCliToken] Verifying the connection to the Azure DevOps API." if (-not (Test-AzToken $token)) { throw "[Get-AzCliToken] Token verification failed. Unable to connect to Azure DevOps organization '$OrganizationName'." } Write-Verbose "[Get-AzCliToken] Token verified successfully." return $token } <# .SYNOPSIS Thin wrapper around the az CLI invocation to enable mocking in unit tests. #> Function Invoke-AzCLICommand { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [String[]]$Arguments ) $output = (& az @Arguments 2>&1) return [PSCustomObject]@{ Output = $output ExitCode = $LASTEXITCODE } } |