在 Powershell 中获取 Azure 函数的函数和主机密钥

Question

我已经使用 Arm 模板部署了 Azure 功能。我需要在 Powershell 中部署 Azure Function 的 Function Key 和 host Key。 目前我正在尝试从 ARM 模板的输出部分获取密钥

 "outputs": {
"FunctionAppName": {
  "type": "string",
  "value": "[variables('functionAppName')]"
},
"Key": {
  "type": "string",
  "value": "[listKeys(resourceId('Microsoft.Web/sites', '[variables('functionAppName')]'),'2015-08-01').keys]"
}

}

我尝试了不同的组合，但失败了。 有没有办法在 Powershell 中检索密钥？

Answer 1

我使用以下方法让它工作：

    "outputs": {
    "FunctionAppName": {
        "type": "string",
        "value": "[parameters('functionName')]"
    },
    "Key": {
        "type": "string",
        "value": "[listsecrets(resourceId('Microsoft.Web/sites/functions', parameters('existingFunctionAppName'), parameters('functionName')),'2015-08-01').key]"
    },        
    "Url": {
        "type": "string",
        "value": "[listsecrets(resourceId('Microsoft.Web/sites/functions', parameters('existingFunctionAppName'), parameters('functionName')),'2015-08-01').trigger_url]"
    }        
}

我也找不到任何示例。 但是通过使用上述内容、GitHub 的快速入门示例和resource functions 的文档以及一些试验和错误，我得到了它。

请注意变量/参数和名称已更改。

Answer 2

我无法获得接受的答案来检索默认主机密钥。 @4c74356b41 的答案非常接近。您可以使用下面的代码取出钥匙。默认主机密钥位于Outputs.functionKeys.Value.functionKeys.default.Value。

  "outputs": {
    "functionKeys": {
      "type": "object",
      "value": "[listkeys(concat(resourceId('Microsoft.Web/sites', variables('functionAppName')), '/host/default'), '2018-11-01')]"
    }
  }

Answer 3

问题似乎没有得到回答，因为它要求从 Powershell 而不是 ARM 模板中获取功能键。 我正在使用下面的脚本从 Azure DevOps 中的 Powershell 获取功能键。

$accountInfo = az account show
$accountInfoObject = $accountInfo | ConvertFrom-Json
$subscriptionId  = $accountInfoObject.id

$resourceGroup = "your-resource-group"
$functionName = "your-function-name"

$functionkeylist = az rest --method post --uri "https://management.azure.com/subscriptions/$subscriptionId/resourceGroups/$resourceGroup/providers/Microsoft.Web/sites/$functionName/host/default/listKeys?api-version=2018-11-01"
$keylistobject = $functionkeylist | ConvertFrom-Json
$functionKey = $keylistobject.functionKeys.default

希望这会有所帮助。

Answer 4

首先，你的语法有错误：

  "value": "[listKeys(resourceId('Microsoft.Web/sites', variables('functionAppName')),'2015-08-01').keys]"

但这无济于事，我不认为它是为 Azure Functions 实现的，我对此不是 100% 确定，但我检索密钥的努力是徒劳的

Answer 5

因此，要使此功能适用于应用程序 MyFunctionApp 中的 MyHttpFunction 的功能特定键，我必须在 ARM 模板的 Outputs 部分中使用以下内容：

"MyHttpFunctionKey": {
    "type": "string",
    "value": "[listkeys(resourceId('Microsoft.Web/sites/functions', 'MyFunctionApp', 'MyHttpFunction'), '2019-08-01').default]"
}

如果使用 New-AzResourceGroupDeployment 和参数 -OutVariable arm 从 Powershell 调用，则以下 Powershell 命令将打印密钥：$arm.Outputs.myHttpFunctionKey.Value

Answer 6

以下代码将获得字符串格式的确切密钥，我使用此密钥创建可用性测试。

"outputs": {
      "Key":{
             "type": "string", 
             "value": "[listkeys(concat(resourceId('Microsoft.Web/sites', 'functionAppName'), '/functions', '/FunctionName'), '2018-11-01').default]"    
             }
            }

Answer 7

使用 Azure PowerShell

我想提供另一种解决此问题的方法，即使用尽可能接近纯 Azure PowerShell 的方法。它仍然依赖于编写 Azure“操作”，但只需几行代码即可完成。

注意：这假设您有一个已通过身份验证的 PowerShell 会话。如果您没有看到：Connect-AzAccount 了解更多信息。

选项 1 - 检索功能应用的密钥以用于所有功能

本示例基于此操作：Web Apps - List Host Keys 并使用此 PowerShell cmdlet 执行操作：Invoke-AzRestMethod

## lookup the resource id for your Azure Function App ##
$resourceId = (Get-AzResource -ResourceGroupName $rg -ResourceName $functionAppName -ResourceType "Microsoft.Web/sites").ResourceId

## compose the operation path for listing keys ##
$path = "$resourceId/host/default/listkeys?api-version=2021-02-01"

## invoke the operation ##
$result = Invoke-AzRestMethod -Path $urlPath -Method POST
if($result -and $result.StatusCode -eq 200)
{
   ## Retrieve result from Content body as a JSON object ##
   $contentBody = $result.Content | ConvertFrom-Json

   ## Output the default function key. In reality you would do something more ##
   ## meaningful with this ##
   Write-Host $contentBody.functionKeys.default
}

选项 2 - 检索特定功能的密钥

这个例子是基于这个操作来检索一个特定于函数的键。这通常是更好的做法，这样您就不会拥有所有功能的一键式。但是，您可能需要任何一个都有正当的理由。在此处查看此操作：Web Apps - List Function Keys

## Lookup function name here ##
$functionName = "MyFunction"

## lookup the resource id for your Azure Function App ##
$resourceId = (Get-AzResource -ResourceGroupName $rg -ResourceName $functionAppName -ResourceType "Microsoft.Web/sites").ResourceId

## compose the operation path for listing keys ##
$path = "$resourceId/functions/$functionName/listkeys?api-version=2021-02-01"

## invoke the operation ##
$result = Invoke-AzRestMethod -Path $urlPath -Method POST
if($result -and $result.StatusCode -eq 200)
{
   ## Retrieve result from Content body as a JSON object ##
   $contentBody = $result.Content | ConvertFrom-Json

   ## Output the default function key. In reality you would do something more ##
   ## meaningful with this. ##
   Write-Host $contentBody.default
}