如何使用Azure API管理门户或API编辑请求标头中Ocp Apim订阅密钥的描述字符串？

Question

我正在寻找一种使用Azure API管理（管理门户或API调用）来编辑Ocp Apim订阅密钥请求头字段的文本描述的方法。这个字符串显示在自动生成的文档中，但我不知道它设置在哪里。到目前为止，我已经尝试在swagger文件和API管理发布者门户中查找Ocp-Apim订阅密钥的描述字符串，但没有找到它。

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

有关Azure API管理的其他问题的答案让我想知道是否有一个REST API调用来编辑此字符串（如果在发布服务器门户中不可用），但我似乎找不到与此相关的API留档的活动链接。

Answer 1

我使用Azure PowerShell来实现这一点。先决条件是您已登录（登录AzureRmAccount）并选择了您的订阅（选择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
    }
}