How to my own cmdlet (using C#) with two input parameters mandatory but mutually exclusive?

Question

I'm developing PowerShell Cmdlets in C#. I would like to define mandatory parameters, but that are mutually exclusive.

Example:

Parameter A
Parameter B

When invoking the command, I must set only parameter A or only parameter B, but I cannot set both and I cannot set none.

Not sure there is any kind of aspect, or modifier which will allow you to enforce this without just doing parameter validation in your cmdlet code. Why not just do that ? — Darkwing
– Darkwing, Commented Mar 28, 2024 at 10:17

carrvo · Accepted Answer · 2024-10-14 17:14:59Z

2

You want to use Parameter Sets. You can think of them like C# overloaded functions.

[Cmdlet(...)]
public sealed class MyExample : Cmdlet
{
    [Parameter(Mandatory = true, ParameterSetName = "only parameter A")]
    public string ParameterA { get; set; }

    [Parameter(Mandatory = true, ParameterSetName = "only parameter B")]
    public string ParameterB { get; set; }
}

Just found this for the first time as another resource! https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/cmdlet-parameter-sets?view=powershell-7.4

answered Oct 14, 2024 at 17:14

carrvo

6777 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to my own cmdlet (using C#) with two input parameters mandatory but mutually exclusive?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related