如何在PowerShell中控制脚本/函数返回复杂对象的默认屏幕输出格式？

核心原理：自定义类型+Format.ps1xml格式化 #

Get-AzContext这类cmdlet的核心逻辑是返回完整的复杂对象，但通过自定义格式化规则控制控制台显示内容，完全不需要修改对象本身的属性结构，具体分两步实现：

1. 给返回对象标记自定义类型名
   你返回的pscustomobject需要指定一个唯一的自定义类型名，PowerShell会根据这个类型名匹配对应的格式化规则。示例代码：

   function Get-MyVmInfo {
       # 构建包含完整AzVM、AzNic、AzIpconfig的对象
       $vmInfo = [pscustomobject]@{
           VM = Get-AzVM -Name 'MyVM'
           Nic = Get-AzNetworkInterface -Name 'MyNic'
           IpConfig = (Get-AzNetworkInterface -Name 'MyNic').IpConfigurations[0]
       }
       # 给对象插入自定义类型名（放在最前面确保优先级）
       $vmInfo.PSObject.TypeNames.Insert(0, 'My.Custom.VmInfo')
       return $vmInfo
   }
   

2. 编写Format.ps1xml定义格式化规则
   这个XML文件用来告诉PowerShell：当类型为My.Custom.VmInfo的对象输出到控制台时，要显示哪些基于嵌套属性计算的简化内容。示例XML内容：

   <?xml version="1.0" encoding="utf-8"?>
   <Configuration>
     <ViewDefinitions>
       <View>
         <Name>My.Custom.VmInfo</Name>
         <ViewSelectedBy>
           <TypeName>My.Custom.VmInfo</TypeName>
         </ViewSelectedBy>
         <TableControl>
           <TableHeaders>
             <TableColumnHeader>
               <Label>VM名称</Label>
               <Width>20</Width>
             </TableColumnHeader>
             <TableColumnHeader>
               <Label>NIC名称</Label>
               <Width>20</Width>
             </TableColumnHeader>
             <TableColumnHeader>
               <Label>私有IP</Label>
               <Width>15</Width>
             </TableColumnHeader>
           </TableHeaders>
           <TableRowEntries>
             <TableRowEntry>
               <TableColumnItems>
                 <TableColumnItem>
                   <ScriptBlock>$_.VM.Name</ScriptBlock>
                 </TableColumnItem>
                 <TableColumnItem>
                   <ScriptBlock>$_.Nic.Name</ScriptBlock>
                 </TableColumnItem>
                 <TableColumnItem>
                   <ScriptBlock>$_.IpConfig.PrivateIpAddress</ScriptBlock>
                 </TableColumnItem>
               </TableColumnItems>
             </TableRowEntry>
           </TableRowEntries>
         </TableControl>
       </View>
     </ViewDefinitions>
   </Configuration>
   

加载格式化规则的两种方式 #

1. 简单脚本/函数中临时加载 #

不需要开发模块，在当前PowerShell会话中用Update-FormatData命令临时加载XML文件即可：

# 加载自定义格式化规则
Update-FormatData -PrependPath .\MyVmInfo.Format.ps1xml

# 调用函数：控制台显示简化表格，变量中保留完整对象
$fullVmData = Get-MyVmInfo
$fullVmData # 控制台输出简化的表格视图
$fullVmData.VM # 仍能直接访问完整的AzVM对象属性

注意：这种临时加载仅在当前会话有效，关闭PowerShell后需要重新加载。

2. 打包到模块中永久生效 #

如果想让格式化规则在所有PowerShell会话中自动生效，就需要把函数、自定义类型和Format.ps1xml一起打包成模块：

• 将Format.ps1xml放在模块目录下
• 在模块的.psd1配置文件中添加FormatsToProcess = @('MyVmInfo.Format.ps1xml')
• 模块导入后，自定义类型的格式化规则会自动生效，无需手动加载

为什么Write-* cmdlet没用？ #

Write-Host直接输出文本，会丢失对象的结构和可操作性；Write-Output输出对象但使用默认格式化规则，无法实现“完整对象保留+控制台简化显示”的分离效果。而Format.ps1xml是PowerShell专门用于控制对象显示格式的原生机制，完全匹配你的需求。

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