Troubleshooting issues with Copilot in SQL Server Management Studio

General logging

In scenarios where more details are needed to investigate a problem, you can view Copilot commands in the output window using View > Output and selecting Copilot from the dropdown list. Alternatively, you can save the information using the /log command in the prompt box.

Configuration

If you enter the endpoint and deployment values in the first-run experience (initial dialog when you first launch Copilot) and the progress bar repeats, check your browser for a Microsoft Entra authentication dialog.

Log capture

If you get an error after entering the endpoint and deployment values in the first-run experience (initial dialog when you first launch Copilot), use the list of error messages to troubleshoot further, or capture logs in the output window.

1. Go to Tools > Options > Copilot to enter the endpoint and deployment values, then select OK.
2. No validation occurs in this dialog.
3. Before you open Copilot, go to View > Output to open the output viewer.
4. Select the Copilot button on the toolbar to launch Copilot in SSMS.
5. Upon launch, you're prompted to authenticate to Azure, unless you're using an API Key.
6. If you don't see the prompt to authenticate, check your browser for a Microsoft Entra authentication dialog.
7. If you see an error in the Copilot chat, select Copilot from the dropdown list in the output viewer.
8. The information in the output viewer can be used for further troubleshooting.

Test access

Use the Azure Command-Line Interfact (CLI) to verify you have access to the Azure OpenAI resources. The Azure CLI must be installed on the same machine as SQL Server Management Studio (SSMS). If the Azure OpenAI resources use Microsoft Entra authentication, you must use az login to log in to Azure before you run the PowerShell script. The script requires the name of the resource group in which the Azure OpenAI resources are hosted, and the name of the endpoint resource. If the script completes successfully, the available Azure OpenAI models are listed as the output.

# Set your Azure OpenAI resource values
$resourceGroup = "msdocs-azuresql-rg-$randomIdentifier"
$resourceName = "copilot-in-ssms"

# ---- Get the endpoint ----
$endpoint = az cognitiveservices account show `
    --name $resourceName `
    --resource-group $resourceGroup `
    --query "properties.endpoint" `
    --output tsv

if (-not $endpoint) {
    Write-Host "Couldn't retrieve endpoint. Check resource group/name." -ForegroundColor Red
    exit 1
}

# ---- Get an API key for the resource ----
$apiKey = az cognitiveservices account keys list `
    --name $resourceName `
    --resource-group $resourceGroup `
    --query "key1" `
    --output tsv

if (-not $apiKey) {
    Write-Host "Couldn't retrieve API key. Check permissions." -ForegroundColor Red
    exit 1
}

# ---- Make a request to /openai/models ----
$headers = @{
    "api-key" = $apiKey
    "Content-Type" = "application/json"
}
$url = "$endpoint/openai/models?api-version=2024-02-01"

try {
    $response = Invoke-RestMethod -Method Get -Uri $url -Headers $headers
    Write-Host "✅ Successfully connected to Azure OpenAI endpoint and listed models:" -ForegroundColor Green
    $response.data | Select-Object id
}
catch {
    Write-Host "❌ Failed to connect or authenticate with Azure OpenAI endpoint." -ForegroundColor Red
    Write-Host $_.Exception.Message
    exit 1
}

Error messages