PowerShell单引号Here-String中如何混合保留与展开指定变量？

问题场景 #

你需要编写用于远程执行的PowerShell脚本内容，使用Here-String时要求：

• 部分变量（如$Instance）原样输出，不被展开
• 特定变量（如$S3BucketName、$file）自动展开为实际值

现有单引号Here-String代码示例：

$S3BucketName = "Dynamically generated"
$file = "Dynamically generated" 

#This is for remote execution
$UserDataInput = @'
$Instance = "Dynamically generated"
Read-S3Object -BucketName $S3BucketName -Key "Path\$file.pem" -File "C:\Temp\$file.pem"
$Pass=Get-EC2PasswordData -InstanceId $Instance -PemFile "C:\Temp\$file.pem"
'@

期望生成的Here-String实际值：

$Instance = "Dynamically generated"
Read-S3Object -BucketName testbucket -Key "Path\testfile.pem" -File "C:\Temp\testfile.pem"
$Pass=Get-EC2PasswordData -InstanceId $Instance -PemFile "C:\Temp\testfile.pem"

解决方案 #

方法1：使用双引号Here-String转义需保留的变量 #

PowerShell的双引号Here-String会自动展开未转义的变量，通过在需要保留的变量前添加反引号（），可以让$`符号原样输出，从而保留变量名不展开。

示例代码：

$S3BucketName = "testbucket"
$file = "testfile" 

$UserDataInput = @"
`$Instance = "Dynamically generated"
Read-S3Object -BucketName $S3BucketName -Key "Path\$file.pem" -File "C:\Temp\$file.pem"
`$Pass=Get-EC2PasswordData -InstanceId `$Instance -PemFile "C:\Temp\$file.pem"
"@

方法2：单引号Here-String结合字符串替换 #

先使用单引号Here-String定义脚本框架（所有变量均原样保留），再通过字符串替换将需要展开的变量替换为实际值。这种方法适合变量较多或需要更清晰控制的场景。

示例代码：

$S3BucketName = "testbucket"
$file = "testfile" 

# 用占位符标记需要替换的变量
$UserDataInput = @'
$Instance = "Dynamically generated"
Read-S3Object -BucketName {S3BucketName} -Key "Path\{file}.pem" -File "C:\Temp\{file}.pem"
$Pass=Get-EC2PasswordData -InstanceId $Instance -PemFile "C:\Temp\{file}.pem"
'@

# 替换占位符为实际变量值
$UserDataInput = $UserDataInput -replace '{S3BucketName}', $S3BucketName `
                               -replace '{file}', $file

方法对比 #

• 方法1更简洁直接，适合需要保留的变量数量较少的场景，无需额外替换步骤。
• 方法2避免了大量反引号转义，脚本结构更清晰，适合复杂场景或变量数量较多的情况。

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