Deklarera egenskaper som parametrar

Det här avsnittet innehåller grundläggande information som du måste förstå innan du deklarerar parametrarna för en cmdlet.

Om du vill deklarera parametrarna för en cmdlet i cmdlet-klassen definierar du de offentliga egenskaper som representerar varje parameter och lägger sedan till ett eller flera parameterattribut för varje egenskap. Den Windows PowerShell körningen använder parameterattributen för att identifiera egenskapen som en cmdlet-parameter. Den grundläggande syntaxen för att deklarera parameterattributet är [Parameter()] .

Här är ett exempel på en egenskap som definierats som en obligatorisk parameter.

[Parameter(Position = 0, Mandatory = true)]
public string UserName
{
  get { return userName; }
  set { userName = value; }
}
private string userName;

Här är några saker att komma ihåg om parametrar.

  • En parameter måste uttryckligen markeras som offentlig. Parametrar som inte har markerats som offentlig standard som interna och som inte hittas av Windows PowerShell-körningen.

  • Parametrar ska definieras som Microsoft .NET Framework för att ge bättre parametervalidering. Till exempel ska parametrar som är begränsade till ett värde av en uppsättning värden definieras som en uppräkningstyp. Parametrar som tar ett Uniform Resource Identifier -värde (URI) ska vara av typen System.Uri.

  • Undvik grundläggande strängparametrar för alla egenskaper utom friformstext.

  • Du kan lägga till en parameter till val annat antal parameteruppsättningar. Mer information om parameteruppsättningar finns i Cmdlet Parameter Sets.

Windows PowerShell också en uppsättning gemensamma parametrar som är automatiskt tillgängliga för varje cmdlet. Mer information om dessa parametrar och deras alias finns i Cmdlet Common Parameters.

Se även

Vanliga parametrar för cmdlet

Typer av cmdlet-parameter

Skriva en Windows PowerShell-cmdlet