Azure Service Bus主题订阅DLQ消息删除方案咨询

1. 是否可通过PowerShell脚本删除DLQ消息？ #

可以。虽然Azure PowerShell的Az.ServiceBus模块没有提供直接删除DLQ消息的cmdlet，但你可以通过PowerShell调用Azure Service Bus的REST API实现该操作，这种方式对基础PowerShell用户来说更易上手。

2. 可用于该操作的REST API是什么？ #

删除DLQ消息的常规流程分为两步，对应的REST API如下：

步骤1：获取死信消息的锁定令牌（Peek-Lock） #

先从DLQ中获取消息并拿到锁定令牌，后续用此令牌完成删除操作：

GET https://{service-bus-namespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}/$deadletterqueue/messages/head?timeout=60

步骤2：完成（删除）锁定的消息 #

通过步骤1拿到的lockToken删除指定消息：

POST https://{service-bus-namespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}/$deadletterqueue/messages/{message-id}/complete

请求头必须包含：

• Authorization: 有效的SAS令牌（用于身份验证）
• Lock-Token: 步骤1返回的消息lockToken值
• Content-Type: application/atom+xml;type=entry;charset=utf-8

如果不需要锁定直接删除DLQ的第一条消息，可调用简化的Delete接口：

DELETE https://{service-bus-namespace}.servicebus.windows.net/{topic-name}/subscriptions/{subscription-name}/$deadletterqueue/messages/head

基础PowerShell脚本示例 #

以下是适配基础用户的简化脚本，实现删除单条DLQ消息（添加循环即可实现批量删除）：

# 配置参数
$namespace = "your-servicebus-namespace"
$topicName = "your-topic-name"
$subscriptionName = "your-subscription-name"
$sharedAccessKeyName = "RootManageSharedAccessKey" # 或自定义SAS策略名称
$sharedAccessKey = "your-shared-access-key"

# 生成SAS令牌用于API身份验证
function Generate-SASToken {
    param(
        [string]$resourceUri,
        [string]$keyName,
        [string]$key
    )
    $expiry = [DateTimeOffset]::UtcNow.AddHours(1).ToUnixTimeSeconds()
    $stringToSign = [System.Web.HttpUtility]::UrlEncode($resourceUri) + "`n" + $expiry
    $hmac = New-Object System.Security.Cryptography.HMACSHA256
    $hmac.Key = [Convert]::FromBase64String($key)
    $signature = [Convert]::ToBase64String($hmac.ComputeHash([Text.Encoding]::UTF8.GetBytes($stringToSign)))
    return "SharedAccessSignature sr=" + [System.Web.HttpUtility]::UrlEncode($resourceUri) + "&sig=" + [System.Web.HttpUtility]::UrlEncode($signature) + "&se=" + $expiry + "&skn=" + $keyName
}

$resourceUri = "https://$namespace.servicebus.windows.net/$topicName/subscriptions/$subscriptionName/`$deadletterqueue"
$sasToken = Generate-SASToken -resourceUri $resourceUri -keyName $sharedAccessKeyName -key $sharedAccessKey

# 步骤1：Peek-Lock获取DLQ消息
$peekLockUrl = "https://$namespace.servicebus.windows.net/$topicName/subscriptions/$subscriptionName/`$deadletterqueue/messages/head?timeout=60"
$headers = @{
    "Authorization" = $sasToken
    "Content-Type" = "application/atom+xml;type=entry;charset=utf-8"
}
$messageResponse = Invoke-RestMethod -Uri $peekLockUrl -Headers $headers -Method Get

if ($messageResponse) {
    $lockToken = $messageResponse.LockToken
    $messageId = $messageResponse.MessageId

    # 步骤2：删除消息
    $deleteUrl = "https://$namespace.servicebus.windows.net/$topicName/subscriptions/$subscriptionName/`$deadletterqueue/messages/$messageId/complete"
    $deleteHeaders = $headers.Clone()
    $deleteHeaders.Add("Lock-Token", $lockToken)
    
    try {
        Invoke-RestMethod -Uri $deleteUrl -Headers $deleteHeaders -Method Post
        Write-Host "DLQ消息已成功删除"
    }
    catch {
        Write-Host "删除消息失败: $_"
    }
}
else {
    Write-Host "DLQ中无消息"
}

技术建议 #

• 批量删除：在脚本中添加while循环，重复执行Peek-Lock和删除操作，直到Peek-Lock返回空响应。
• 权限检查：确保使用的SAS策略拥有Manage或Send权限，否则会触发权限不足错误。
• 脚本复用：将命名空间、密钥等参数改为脚本输入参数，方便重复使用。
• 错误排查：若API调用失败，优先检查响应中的错误信息，常见问题包括令牌过期、资源路径拼写错误、权限不足。

内容的提问来源于stack exchange，提问作者Arun Kumar