在C#创建CmdLet中使用DynamicParameter

2021-12-29 14:26:46

在C#创建CmdLet中使用DynamicParameter

今天我们介绍PowerShell 命令中另外一种参数动态参数
所谓动态参数是依据某些特定条件而出现的参数，通常情况下，这些条件包括但不仅限于，特定参数值，特定参数出现，特定参数行为，属性。
我们用一个简单的例子还说明动态参数，这个例子将是下一波PowerShell 扩展中的
Set-SPWebApplicationAuthenticationType 命令
该命令将转换指定的WebApplication 身份验证模式
其中可以转换的为 Classic（经典SharePoint 2010中的身份验证模式）以及Claims（基于声明的身份验证SharePoint 2013中推荐的身份验证）。

首先我们讨论下关于转换为 Classic （经典）
根据微软给出的方法我们很轻易的得出结论转化为 Classic 身份验证从一个命令开发者角度来看仅仅需要知道一个WebApplication 同时修改其属性就能实现。
我们再来看下关于转换为 Claims（基于声明的验证）
在转化为Claims 时候我们需要知道 WebApplication，以及适用该WebApplication的访问账户，该账户对该WebApplication 访问的权限，以及对应的WebApplication Zone（区域）
不难看出从一个命令开发者角度去思考我们会得到下表

不难看出要在一个命令中同时实现转化两种身份验证模式有两个分支
似乎这两个分支可以使用参数集的方法来解决，
但是仔细考虑下你就会发现一个严重的问题AuthenticationType，以及WebApplication 为这两个分支的公共且必须参数且转化为 Classic 不再需要任何参数，这就会造成一个问题参数集界定的十分模糊，虽然从一个开发者本身看这似乎并不是问题，但是该问题对终端用户使用会造成困扰，当他们把 AuthenticationType 参数设置为任意值的时候都会出现 UserAccountName 等几个参数，但是这几个参数却不是转化为 Classic 必须的参数甚至这些参数没有任何意义。虽然你可以在帮助中指明用法，但是这种做法并不严谨，而且十分的愚蠢。
我们不妨换个角度用动态参数的办法实现这个目标。
当 AuthenticationType 为 Claims 时候我们让命令出现参数3-参数5，
这的确是个好办法，即满足需求，又不会造成困扰，当然我们还可以考量下参数4，参数5
的默认值的可能进一步简化用户的使用复杂程度。
基于此我们今天将学会如何在使用C#创建Cmdlet 时候使用动态参数

我们先创建该命令，请注意我们要使用IDynamicParameters

然后按照常规思路把 AuthenticationType，WebApplication的参数进行声明