在 Windows 的终端安装并使用 azd 命令
目录
- 一、在 CMD 中使用 PowerShell 安装脚本
- 补充
- 二、确认 azd 是否配置环境变量
- 1. 找到 azd 的安装目录
- 1)通过命令查找 azd 路径
- 2)默认安装目录
- 2. 查看环境变量中是否包含安装目录
- 3. 手动添加安装目录到环境变量 PATH
- 1)通过系统界面添加
- 2)通过命令行临时添加(只对当前会话有效)
- 补充
- 三、azd 的常用命令
- 1. 常用命令
- 2. 使用流程示例
在 Windows 的命令提示符(CMD)中安装并使用 Azure Developer CLI(azd),可以按照以下详细步骤操作:
一、在 CMD 中使用 PowerShell 安装脚本
- 快捷键 Win + R ,输入
cmd
进入命令提示符,在 CMD 里执行以下命令来调用 PowerShell 下载并执行 azd 的安装脚本:
powershell -Command "iwr -useb https://aka.ms/install-azd.ps1 | iex"
-
安装脚本会自动下载安装包并配置环境变量,等待执行完毕,看到提示安装完成后即可。
-
环境变量更新后,关闭当前 CMD 窗口,重新打开一个新的 CMD 窗口。
-
在新的命令提示符窗口输入:
azd version
,如果显示 azd 版本号,说明安装成功。
补充
-
如果显示没有权限运行安装脚本,则以管理员身份运行 CMD 。
-
如果网络不好导致脚本无法下载,可以手动从【官方 GitHub】下载安装包。
-
azd 使用的是独立于 Azure CLI(az)的工具,安装后可以在 CMD、PowerShell、WSL 等环境中使用。
二、确认 azd 是否配置环境变量
需要确认 azd 的安装目录,并查看这个目录是否在系统的 PATH 环境变量里,以便可以在命令行中直接运行 azd 。
1. 找到 azd 的安装目录
1)通过命令查找 azd 路径
打开命令提示符(CMD) 或 PowerShell ,输入:where azd
,这个命令会列出系统中所有名为 azd.exe 的路径。
where azd 命令找不到可执行文件,说明可能没安装成功或者路径没加入环境变量。
2)默认安装目录
如果是使用微软官方的安装脚本安装,一般会默认安装到:C:\Users\<用户名>\AppData\Local\Programs\Azure Dev CLI\
。
2. 查看环境变量中是否包含安装目录
使用命令查看 PATH 里是否有这个目录,在 CMD 中输入:echo %PATH%
或在 PowerShell 中输入 echo $Env:PATH
,查看输出里是否包含 azd.exe 所在的目录。
如果包含,说明 PATH 配置正确;如果没有,需要手动添加。
3. 手动添加安装目录到环境变量 PATH
1)通过系统界面添加
- Win + X ,选择 “系统” ,点击 “高级系统设置” → “环境变量” 。
-
在 “系统变量” 或 “用户变量” 中找到变量名为 Path 的一项,双击它。
-
点击 “新建” ,然后输入 azd.exe 所在的完整文件夹路径,比如:
C:\Users\<用户名>\AppData\Local\Programs\Azure Dev CLI\
。 -
点击 “确定” 保存,重新打开 CMD 窗口,输入
azd version
验证是否生效。
2)通过命令行临时添加(只对当前会话有效)
在 CMD 中输入以下命令:
set PATH=%PATH%;C:\Users\<用户名>\AppData\Local\Programs\Azure Dev CLI\
在 PowerShell 中输入以下命令:
$Env:PATH += ";C:\Users\<用户名>\AppData\Local\Programs\AzureDevCLI\"
补充
-
添加环境变量后必须重新打开命令行窗口才能生效。
-
如果多个用户使用该电脑,要确保在对应用户的环境变量中添加。
三、azd 的常用命令
1. 常用命令
-
azd init :初始化一个新的 Azure Developer 项目,基于预定义的模板或现有代码库结构,快速创建项目结构和配置。
-
azd env new <env-name> :创建一个新的环境(environment),通常用于区分开发、测试和生产环境。例如:
azd env new dev
。 -
azd env select <env-name> :切换当前上下文到指定的环境。例如:
azd env select dev
。 -
azd env list :列出所有已创建的环境。
-
azd env get-values :用于获取当前 Azure Developer CLI 环境内定义的所有环境变量和应用设置(包括 secrets、connection strings、配置参数等)。
它会把这些配置信息以键值对的形式输出,通常是 JSON 格式,这些环境值通常是在你用 azd 部署资源后自动生成或定义的,供应用程序在运行时读取配置,比如数据库连接串、API Key、服务端点等。
>
是 shell 的重定向操作符,表示把命令输出的内容写入到指定文件中,覆盖原文件。azd env get-values > xxx/local.settings.json
表示获取当前环境的所有配置信息(环境变量等),然后将配置信息保存到本地文件。
local.settings.json
是本地环境的配置文件,里面包含应用需要的各种连接字符串、密钥等。通过上面这条命令,你可以方便地将真实环境的配置同步到本地,用于本地调试,保证本地运行的应用能够访问同样的资源和服务。
-
azd provision :根据项目的基础设施配置(比如 ARM 模板或 Bicep 文件)部署或更新 Azure 资源。
-
azd deploy :将应用程序代码和相关内容部署到 Azure(服务、容器、函数等)。
-
azd preview :生成并显示当前项目的部署或变更预览,帮助你在实际部署前查看资源变更详情。
-
azd up :一键完成所有步骤:初始化环境、处理资源、部署应用,适合项目首次上线或快速演示。
如果 azd up 命令后面加上
--environment <env-name>
,则是指定要操作的环境名称。如果存在多个环境,通过这个参数可以指定在某个具体环境下执行 azd up ,以避免默认环境的混淆。
-
azd pipeline config :为项目配置 CI/CD 流水线,支持 GitHub Actions 或 Azure Pipelines。
-
azd monitor :查看和管理 Azure 资源的运行时监控数据,比如日志或指标,便于调试和运维。
-
azd down :删除或销毁当前环境相关的 Azure 资源,释放资源。
-
azd config set <key> <value> :设置项目配置项,比如环境变量、参数等。例如:
azd config set location eastus
。 -
azd config get <key> :读取指定配置项的值。例如:
azd config get location
。 -
azd list templates :列出可用的项目模板模板,用于快速初始化项目。
2. 使用流程示例
azd init # 初始化项目
azd env new dev # 创建开发环境
azd provision # 部署基础设施
azd deploy # 部署应用代码
azd up # 一步完成所有操作(初始化+provision+deploy)
azd pipeline config # 配置自动化部署流水线
azd monitor # 监控部署的服务
azd down # 销毁资源(环境)
如果需要了解更详细示例或特殊命令用法,可以执行以下命令获取最新的官方帮助和参数说明:
azd --help
azd <command> --help