使用部署按钮从 GitHub 存储库部署模板

本文介绍了如何使用“部署到 Azure”按钮从 GitHub 存储库部署模板。 可直接将此按钮添加到 GitHub 存储库中的 README.md 文件, 也可将其添加到引用该存储库的网页中。

部署范围由模板架构确定。 有关详细信息,请参阅:

使用常用图像

若要将此按钮添加到网页或存储库,请使用以下图像:

![Deploy to Azure](https://aka.ms/deploytoazurebutton)
<img src="https://aka.ms/deploytoazurebutton"/>

此图像显示为:

“部署到 Azure”按钮

创建用于部署模板的 URL

若要为模板创建 URL,请从存储库中模板的原始 URL 开始。 若要查看原始 URL,请选择“原始”。

选择“原始”

URL 的格式为:

https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json

然后,将 URL 转换为 URL 编码的值。 可以使用联机编码器,也可以运行一个命令。 以下 PowerShell 示例展示了如何对值进行 URL 编码。

$url = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/quickstarts/microsoft.storage/storage-account-create/azuredeploy.json"
[uri]::EscapeDataString($url)

进行 URL 编码后,示例 URL 具有以下值。

https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.storage%2Fstorage-account-create%2Fazuredeploy.json

每个链接都以相同的基 URL 开头:

https://portal.azure.cn/#create/Microsoft.Template/uri/

将进行 URL 编码后的模板链接添加到基 URL 的末尾。

https://portal.azure.cn/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.storage%2Fstorage-account-create%2Fazuredeploy.json

你已具有该链接的完整 URL。

备注

若要部署模板或引用存储在专用 GitHub 存储库中的链接模板,请参阅 MVP 博客中记录的自定义解决方案。 可以将 Azure 函数设置为代理,以构造访问专用 GitHub 存储库中的模板文件所需的 URL。

如果使用包含 Azure Repos 的 Git 而不是 GitHub 存储库,那么仍可使用“部署到 Azure”按钮。 请确保存储库是公共的。 使用项操作获取模板。 请求应采用以下格式:

https://dev.azure.com/{organization-name}/{project-name}/_apis/git/repositories/{repository-name}/items?scopePath={url-encoded-path}&api-version=6.0

对此请求 URL 进行编码。

创建“部署到 Azure”按钮

最后,将链接和图像放在一起。

若要向 GitHub 存储库中的 README.md 文件或者向网页中添加带 Markdown 的按钮,请使用:

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.cn/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.storage%2Fstorage-account-create%2Fazuredeploy.json)

对于 HTML,请使用:

<a href="https://portal.azure.cn/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure%2Fazure-quickstart-templates%2Fmaster%2Fquickstarts%2Fmicrosoft.storage%2Fstorage-account-create%2Fazuredeploy.json" target="_blank">
  <img src="https://aka.ms/deploytoazurebutton"/>
</a>

对于包含 Azure 存储库的 Git,该按钮的格式为:

[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.cn/#create/Microsoft.Template/uri/https%3A%2F%2Fdev.azure.com%2Forgname%2Fprojectname%2F_apis%2Fgit%2Frepositories%2Freponame%2Fitems%3FscopePath%3D%2freponame%2fazuredeploy.json%26api-version%3D6.0)

部署模板

若要测试整个解决方案,请选择以下按钮:

“部署到 Azure”

门户会显示一个窗格,你可以在其中轻松地提供参数值。 这些参数预先填充了来自模板的默认值。 在门户上显示时,模板中定义的驼峰式大小写参数名称 storageAccountType 将转换为以空格分隔的字符串。

使用门户进行部署

后续步骤