ARM Template.json 动态连接字符串

Question

我从 azure 获取了一个部署模板，并将其添加到 Visual Studio 2015 年的一个部署项目中。创建和部署资源组后，除网站连接字符串外，一切正常。

我有 TableStorage、DocumentDb 和 Redis 实例都是由此创建的，无法弄清楚如何获取这些项目的主连接字符串和主键，这样我就不必手动进入并添加他们。

查看 ARM Template Functions ListKeys 应该可以解决问题，但部署后该值为空。此外，尝试一个简单的字符串 (TestConnectionString) 也会添加名称，但不会添加值。

   {
      "type": "Microsoft.Web/sites",
      "kind": "app",
      "name": "[parameters('WebAppName')]",
      "apiVersion": "2015-08-01",
      "properties": {
        "name": "[parameters('WebAppName')]",
        "resources": [],
        "siteConfig": {
          "connectionstrings": [
            {
              "name": "DocumentDbKey",
              "value": "[listKeys(resourceId('Microsoft.DocumentDB/databaseAccounts', parameters('docDbName')), '2015-11-06').primaryMasterKey]",
              "type": "Custom"
            },
            {
              "name": "TestConnectionString",
              "value": "dummystring:pleaseignore;",
              "type": "Custom"
            }
          ]
        }
      },
      "dependsOn": [
        "[resourceId('Microsoft.DocumentDB/databaseAccounts', parameters('docDbName'))]",
      ]
    }

Answer 1

根据您的描述，我们可以使用ARM模板函数ListKeys来获取Keys。我们可以使用以下模板代码来设置连接字符串。我测试了 Azure 存储连接字符串和文档数据库密钥，它对我来说工作正常，请试一试。以下是我的详细步骤：

1.Create 带有模板 WebApp 的基本 Azure 资源组项目

2.From 演示删除不需要的资源。

3.Add连接字符串设置

"resources": [
        {
          "name": "connectionstrings",
          "type": "config",
          "apiVersion": "2015-08-01",
          "dependsOn": [
            "[concat('Microsoft.Web/sites/', variables('webSiteName'))]"
          ],
          "tags": {
            "displayName": "tomConnectionString"
          },
          "properties": {
            "documentDB": {
              "value": "[listKeys(resourceId('Microsoft.DocumentDB/databaseAccounts', variables('docDbName')), '2015-11-06').primaryMasterKey]",
              "type": "Custom"
            },
            "storage": {
              "value": "[concat('DefaultEndpointsProtocol=https;AccountName=',parameters('storageAccountName'),';AccountKey=',concat(listKeys(variables('storageAccountId'),'2015-05-01-preview').key1))]",
              "type": "Custom"
            }
          }
        }
      ]

添加相应的参数或变量，如存储信息或docDbName

部署网站
从门户查看结果

完整模板代码：

{
  "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "hostingPlanName": {
      "type": "string",
      "minLength": 1
    },
    "skuName": {
      "type": "string",
      "defaultValue": "S1",
      "allowedValues": [
        "F1",
        "D1",
        "B1",
        "B2",
        "B3",
        "S1",
        "S2",
        "S3",
        "P1",
        "P2",
        "P3",
        "P4"
      ],
      "metadata": {
        "description": "Describes plan's pricing tier and instance size. Check details at https://azure.microsoft.com/en-us/pricing/details/app-service/"
      }
    },
    "storageAccountName": {
      "type": "string",
      "metadata": {
        "description": "Storage Account to access blob storage."
      }
    },
    "skuCapacity": {
      "type": "int",
      "defaultValue": 1,
      "minValue": 1,
      "metadata": {
        "description": "Describes plan's instance count"
      }
    }
  },
  "variables": {
    "webSiteName": "[concat('webSite', uniqueString(resourceGroup().id))]",
    "docDbName": "tomdocumentdb",
    "storageAccountId": "[concat(resourceGroup().id,'/providers/Microsoft.Storage/storageAccounts/', parameters('storageAccountName'))]"
  },
  "resources": [
    {
      "apiVersion": "2015-08-01",
      "name": "[parameters('hostingPlanName')]",
      "type": "Microsoft.Web/serverfarms",
      "location": "[resourceGroup().location]",
      "tags": {
        "displayName": "HostingPlan"
      },
      "sku": {
        "name": "[parameters('skuName')]",
        "capacity": "[parameters('skuCapacity')]"
      },
      "properties": {
        "name": "[parameters('hostingPlanName')]"
      }
    },
    {
      "apiVersion": "2015-08-01",
      "name": "[variables('webSiteName')]",
      "type": "Microsoft.Web/sites",
      "location": "[resourceGroup().location]",
      "tags": {
        "[concat('hidden-related:', resourceGroup().id, '/providers/Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]": "Resource",
        "displayName": "Website"
      },
      "dependsOn": [
        "[concat('Microsoft.Web/serverfarms/', parameters('hostingPlanName'))]"
      ],
      "properties": {
        "name": "[variables('webSiteName')]",
        "serverFarmId": "[resourceId('Microsoft.Web/serverfarms', parameters('hostingPlanName'))]"
      },

      "resources": [
        {
          "name": "connectionstrings",
          "type": "config",
          "apiVersion": "2015-08-01",
          "dependsOn": [
            "[concat('Microsoft.Web/sites/', variables('webSiteName'))]"
          ],
          "tags": {
            "displayName": "tomConnectionString"
          },
          "properties": {
            "documentDB": {
              "value": "[listKeys(resourceId('Microsoft.DocumentDB/databaseAccounts', variables('docDbName')), '2015-11-06').primaryMasterKey]",
              "type": "Custom"
            },
            "storage": {
              "value": "[concat('DefaultEndpointsProtocol=https;AccountName=',parameters('storageAccountName'),';AccountKey=',concat(listKeys(variables('storageAccountId'),'2015-05-01-preview').key1))]",
              "type": "Custom"
            }
          }
        }
      ]
    }
  ]
}

更新：

我们可以从 azure resource.

中获得更多关于 ARM 模板的有用信息

Answer 2

我刚刚遇到了同样的问题，结果发现保存连接字符串的属性的名称应该命名为 connectionString，所以您的 siteConfig 对象应该如下所示：

"siteConfig": {
    "connectionstrings": [
    {
      "name": "DocumentDbKey",
      "connectionString": "[listKeys(resourceId('Microsoft.DocumentDB/databaseAccounts', parameters('docDbName')), '2015-11-06').primaryMasterKey]",
      "type": "Custom"
    },
    {
      "name": "TestConnectionString",
      "connectionString": "dummystring:pleaseignore;",
      "type": "Custom"
    }
  ]
}

ARM Template.json 动态连接字符串

ARM Template.json Dynamic connectionstring

azure-cosmosdb

azure-resource-manager