Azure CLI 参数持久化功能深度解析与最佳实践指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00680/article/details/148548631

Azure CLI 参数持久化功能深度解析与最佳实践指南

azure-cli Azure Command-Line Interface 项目地址: https://gitcode.com/gh_mirrors/az/azure-cli

参数持久化功能概述

参数持久化（Param Persist）是 Azure CLI 提供的一项实用功能，它允许用户在执行命令时自动保存常用参数值，并在后续相关命令中自动复用这些值。这项功能在内部实现中被称为"本地上下文"（Local Context），两者在技术实现上是等价的。

核心概念解析

本地上下文属性（LocalContextAttribute）

本地上下文属性定义了参数如何支持持久化功能，包含三个关键属性：

name：参数名称标识符
- 通常直接使用函数签名中定义的参数名
- 例如 resource_group_name、vnet_name 等
scopes：作用范围定义
- 字符串数组，指定该参数值可以被哪些命令或命令组引用
- 特殊值 ['all'] 表示所有命令均可引用
- 注意：仅在包含 SET 操作时才有意义
actions：操作类型定义
- 使用 LocalContextAction 枚举值
- 支持 GET（从上下文取值）和 SET（保存值到上下文）
- 一个参数可同时定义两种操作

操作类型详解

GET 操作：从持久化存储中检索参数值
- 适用于需要复用之前保存值的场景
- 可减少重复输入相同参数
SET 操作：将参数值保存到持久化存储
- 通常在创建资源时使用
- 保存的值可供后续命令使用

默认支持的参数范围

Azure CLI 为一些常用参数预定义了持久化支持，只要命令函数签名中包含这些参数名，就会自动支持参数持久化：

resource_group_name（资源组名称）

local_context_attribute=LocalContextAttribute(
    name='resource_group_name',
    actions=[LocalContextAction.SET, LocalContextAction.GET],
    scopes=[ALL]
)

vnet_name（虚拟网络名称）

local_context_attribute=LocalContextAttribute(
    name='vnet_name', 
    actions=[LocalContextAction.GET]
)

subnet_name（子网名称）

local_context_attribute=LocalContextAttribute(
    name='subnet_name', 
    actions=[LocalContextAction.GET]
)

最佳实践建议

适用场景选择
- 优先为资源依赖参数启用持久化
- 避免为非资源标识参数启用此功能
操作类型规范
- 在 create 和 delete 命令中，避免为 name 参数定义 GET 操作
- SET 操作应主要定义在 create 命令中
作用域设计
- 合理规划参数的作用范围
- 避免过度使用 ['all'] 全局作用域

实战案例解析

传统操作方式

创建一个 Web 应用的传统流程需要重复输入相同参数：

az group create --name myResourceGroup --location westus
az appservice plan create -g myResourceGroup --name myPlan
az webapp create -g myResourceGroup --plan myPlan --name myWebapp

优化后的持久化方案

资源组创建 - 设置持久化值

with self.argument_context('group create') as c:
    c.argument('rg_name',
              local_context_attribute=LocalContextAttribute(
                  name='resource_group_name',
                  actions=[LocalContextAction.SET], 
                  scopes=[ALL]))

应用服务计划创建 - 复用资源组名并设置计划名

# 自动复用 resource_group_name
def create_app_service_plan(cmd, resource_group_name, name, ...):

# 设置 plan_name 持久化
with self.argument_context('appservice plan create') as c:
    c.argument('name',
              local_context_attribute=LocalContextAttribute(
                  name='plan_name', 
                  actions=[LocalContextAction.SET], 
                  scopes=['appservice', 'webapp', 'functionapp']))

Web 应用创建 - 复用资源组名和计划名

# 自动复用 resource_group_name 和 plan_name
def create_webapp(cmd, resource_group_name, name, plan, ...):

# 设置 webapp 名称持久化
with self.argument_context('webapp create') as c:
    c.argument('name',
              local_context_attribute=LocalContextAttribute(
                  name='web_name', 
                  actions=[LocalContextAction.SET], 
                  scopes=['webapp']))