如何使用 Azure API 管理门户或 API 编辑请求标头中 Ocp-Apim-Subscription-Key 的描述字符串？

Question

我正在寻找一种方法来使用 Azure API 管理（管理门户或 API 调用）来编辑 Ocp-Apim-Subscription-Key 请求标头字段的文本描述。该字符串显示在自动生成的文档中，但我不知道它的设置位置。到目前为止，我已经尝试在 swagger 文件和 API Management Publisher Portal 中查找 Ocp-Apim-Subscription-Key 的描述字符串，但一直找不到。

这是一个屏幕截图，突出显示了生成的 API 文档中我要编辑的字段：

这是 Azure API 管理发布者门户中的页面，我在该页面中查找了“请求标头”部分但找不到它：

有关 Azure API 管理的问题的其他答案让我想知道是否有 REST API 调用来编辑此字符串（如果它在发布者门户中不可用），但我似乎无法找到有关它的 API 文档的活动链接.

Answer 1

我为此使用了 Azure PowerShell。先决条件是您已登录 (Login-AzureRmAccount) 并选择了您的订阅 (Select-AzureRmSubscription)。

 $ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName $resourceGroup -ServiceName $serviceName

if($ApiMgmtContext)
{
    foreach($apiEntry in (Get-AzureRmApiManagementApi -Context $ApiMgmtContext))
    {
        $api = Get-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId $apiEntry.ApiId

        Write-Host "setting header for" $api.Name

        $api.SubscriptionKeyHeaderName = "MyApi-Subscription-Key"
        $api | Set-AzureRmApiManagementApi -Context $ApiMgmtContext
    }
}