大网数据广告活动
Windows Server 管理

在扩展中使用 PowerShell

· 52CE 我爱测

让我们更深入地了解 Windows 管理中心扩展 SDK,我们来谈谈如何向扩展添加 PowerShell 命令。

适用于:Windows Admin Center、Windows Admin Center 预览版

让我们更深入地了解 Windows 管理中心扩展 SDK,我们来谈谈如何向扩展添加 PowerShell 命令。

TypeScript 中的 PowerShell

Gulp 生成过程有一个生成步骤,该步骤将使用 {!ScriptName}.ps1 文件夹中的任何一个, \src\resources\scripts 并将其生成到 powershell-scripts 文件夹下的类中 \src\generated 。

Note: 不要手动更新 powershell-scripts.ts strings.ts 文件或文件。 你所做的任何更改将在下一次生成时被覆盖。

运行 PowerShell 脚本

要在节点上运行的任何脚本都可以放置在中 \src\resources\scripts\{!ScriptName}.ps1 。

Important: 在运行之前,在文件中进行的任何更改 {!ScriptName}.ps1 都不会反映在您的项目中 gulp generate 。

该 API 的工作原理是:首先在目标节点上创建 PowerShell 会话,使用需要传入的任何参数创建 PowerShell 脚本,然后在已创建的会话上运行该脚本。

例如,我们有此脚本 \src\resources\scripts\Get-NodeName.ps1 :

Param
 (
    [String] $stringFormat
 )
 $nodeName = [string]::Format($stringFormat,$env:COMPUTERNAME)
 Write-Output $nodeName

我们将为目标节点创建 PowerShell 会话:

const session = this.appContextService.powerShell.createSession('{!TargetNode}');

然后,我们将使用输入参数创建 PowerShell 脚本:

const script = PowerShell.createScript(PowerShellScripts.Get_NodeName, {stringFormat: 'The name of the node is {0}!'});

最后,我们需要在创建的会话中运行该脚本:

  public ngOnInit(): void {
    this.session = this.appContextService.powerShell.createAutomaticSession('{!TargetNode}');
  }

  public getNodeName(): Observable<any> {
    const script = PowerShell.createScript(PowerShellScripts.Get_NodeName.script, { stringFormat: 'The name of the node is {0}!'});
    return this.appContextService.powerShell.run(this.session, script)
    .pipe(
        map(
        response => {
            if (response && response.results) {
                return response.results;
            }
            return 'no response';
        }
      )
    );
  }

  public ngOnDestroy(): void {
    this.session.dispose()
  }

现在,我们需要订阅刚刚创建的可观察函数。 将其放在需要调用函数以运行 PowerShell 脚本的位置:

this.getNodeName().subscribe(
     response => {
    console.log(response)
     }
);

通过向 createSession 方法提供节点名称,将创建并使用一个新的 PowerShell 会话,然后在 PowerShell 调用完成后立即将其销毁。

密钥选项

在调用 PowerShell API 时,有几个选项可用。 每次创建会话时,都可以使用或不使用密钥来创建会话。

密钥: 这将创建一个可以查找并重复使用的键控会话, (这意味着 Component1 可以创建具有密钥 "ROCKS" 的会话,并且 Component2 可以使用同一会话) 。如果提供了一个密钥,则必须通过调用 dispose ( # A3 来释放创建的会话,如上面的示例中所述。 不应将会话保留的时间超过5分钟。

  const session = this.appContextService.powerShell.createSession('{!TargetNode}', '{!Key}');

无键: 系统将自动为该会话创建一个密钥。 此会话将在3分钟后自动释放。 使用无键,扩展可以回收在创建会话时已可用的任何运行空间。 如果没有可用的运行空间,则将创建一个新的运行空间。 此功能适用于一次性调用,但重复使用会影响性能。 创建会话大约需要1秒钟,因此持续回收会话可能会导致瓶颈。

  const session = this.appContextService.powerShell.createSession('{!TargetNodeName}');

or

const session = this.appContextService.powerShell.createAutomaticSession('{!TargetNodeName}');

在大多数情况下,请在方法中创建一个键控会话 ngOnInit() ,然后在中释放它 ngOnDestroy() 。 如果组件中有多个 PowerShell 脚本,但基础会话不是跨组件共享的,请遵循此模式。 为了获得最佳结果,请确保在组件(而不是服务)内管理会话创建,这有助于确保可以正确管理生存期和清理。

为了获得最佳结果,请确保在组件(而不是服务)内管理会话创建,这有助于确保可以正确管理生存期和清理。

PowerShell 流

如果你有长时间运行的脚本,并且数据是渐进式输出的,则 PowerShell 流将允许你处理数据,而不必等待脚本完成。 接收到数据后,将立即调用 ( # A1 的可观测对象。

this.appContextService.powerShellStream.run(session, script);

长时间运行的脚本

如果你有想要在后台运行的长时间运行的脚本,则可以提交工作项。 脚本的状态将由网关跟踪,状态的更新可以发送到通知。

const workItem: WorkItemSubmitRequest = {
    typeId: 'Long Running Script',
    objectName: 'My long running service',
    powerShellScript: script,

    //in progress notifications
    inProgressTitle: 'Executing long running request',
    startedMessage: 'The long running request has been started',
    progressMessage: 'Working on long running script – {{ percent }} %',

    //success notification
    successTitle: 'Successfully executed a long running script!',
    successMessage: '{{objectName}} was successful',
    successLinkText: 'Bing',
    successLink: 'http://www.bing.com',
    successLinkType: NotificationLinkType.Absolute,

    //error notification
    errorTitle: 'Failed to execute long running script',
    errorMessage: 'Error: {{ message }}'

    nodeRequestOptions: {
       logAudit: true,
       logTelemetry: true
    }
};

return this.appContextService.workItem.submit('{!TargetNode}', workItem);

Note: 要显示进度,必须在编写的脚本中包括写入进度。 例如:

 Write-Progress -Activity ‘The script is almost done!' -percentComplete 95
工作项选项
函数 说明
提交 ( # A1 提交工作项
submitAndWait ( # A1 提交工作项并等待其执行完成
等待 ( # A1 等待现有工作项完成
查询 ( # A1 按 id 查询现有工作项
查找 ( # A1 按 TargetNodeName、ModuleName 或 typeId 查找和现有工作项。

PowerShell 批处理 Api

如果需要在多个节点上运行同一个脚本,则可以使用批处理 PowerShell 会话。 例如:

const batchSession = this.appContextService.powerShell.createBatchSession(
    ['{!TargetNode1}', '{!TargetNode2}', sessionKey);
  this.appContextService.powerShell.runBatchSingleCommand(batchSession, command).subscribe((responses: PowerShellBatchResponseItem[]) => {
    for (const response of responses) {
      if (response.error || response.errors) {
        //handle error
      } else {
        const results = response.properties && response.properties.results;
        //response.nodeName
        //results[0]
      }
    }
     },
     Error => { /* handle error */ });

PowerShellBatch 选项
选项 说明
runSingleCommand 对数组中的所有节点运行单个命令
run 在配对节点上运行相应的命令
cancel 在数组中的所有节点上取消该命令

历史资料。此文对应 2021-03-23 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者(原始作者元数据 nwashburn-ms)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / Windows Server 中文文档历史快照
适用范围
历史中文快照 2021-03-23;详见原文产品版本;文档日期 05/09/2019
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。