如何为AutoRest.PowerShell生成的Cmdlet添加Connect连接功能？

核心结论 #

AutoRest默认生成的PowerShell CLI没有内置这种会话式的Connect功能，所有命令都需要手动传入Host、Port等连接参数，不会自动复用之前的配置。

手动添加Connect功能的步骤 #

1. 定义模块级会话变量 #

在你的PowerShell模块根目录（或者生成的CLI脚本开头），添加一个模块级变量用来存储连接会话信息：

# 存储Foo服务的会话信息，仅模块内部可见
$script:FooSession = $null

2. 编写Connect-FooService命令 #

新建一个脚本文件（比如Connect-FooService.ps1），实现连接验证和会话存储逻辑：

function Connect-FooService {
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        [string]$Host,
        [int]$Port = 443
    )

    # 优先调用服务的健康检查接口做可用性验证（如果服务提供）
    $healthUrl = "https://$($Host):$($Port)/health"
    try {
        $response = Invoke-RestMethod -Uri $healthUrl -Method Get -TimeoutSec 10
        Write-Host "成功连接到Foo服务：$Host`:$Port" -ForegroundColor Green
        # 保存会话信息
        $script:FooSession = [PSCustomObject]@{
            Host = $Host
            Port = $Port
            LastConnected = Get-Date
        }
    }
    catch {
        Write-Error "无法连接到Foo服务：$_"
        $script:FooSession = $null
    }
}

如果服务没有健康接口，也可以用基础连通性检查替代：

# 替换上面的try块内容
if (Test-Connection -ComputerName $Host -Port $Port -Count 1 -Quiet -TimeoutSeconds 5) {
    Write-Host "服务器$Host`:$Port 连通性正常" -ForegroundColor Green
    $script:FooSession = [PSCustomObject]@{
        Host = $Host
        Port = $Port
        LastConnected = Get-Date
    }
}
else {
    Write-Error "服务器$Host`:$Port 无法访问"
    $script:FooSession = $null
}

3. 修改生成的命令，自动复用会话 #

找到AutoRest生成的目标命令（比如Get-FooSome.ps1），修改参数处理逻辑，让命令优先读取会话变量：

function Get-FooSome {
    [CmdletBinding()]
    param(
        [string]$Host,
        [int]$Port = 443
    )

    # 自动读取会话信息（如果未手动指定参数）
    if (-not $Host -and $script:FooSession) {
        $Host = $script:FooSession.Host
        $Port = $script:FooSession.Port
    }
    elseif (-not $Host) {
        Write-Error "请先运行 Connect-FooService 建立连接，或者手动指定 -Host 参数"
        return
    }

    # 原有命令逻辑：构建API请求URL并执行
    $apiUrl = "https://$($Host):$($Port)/api/foo/some"
    # ... 保留原有请求处理代码 ...
}

4. 整合到模块 #

把Connect-FooService.ps1和修改后的生成命令放到同一个PowerShell模块目录下，确保模块加载时能加载所有脚本。

用法示例 #

# 建立连接并验证服务器可用性
Connect-FooService -Host foo.net -Port 443
# 自动使用会话信息调用命令
Get-FooSome
# 也可以手动指定参数覆盖会话配置
Get-FooSome -Host bar.net -Port 8443

内容的提问来源于stack exchange，提问作者sorosh_sabz