Fonctions

Une fonction est un morceau de code nommé.

Une fois exécutée, la fonction est chargée en mémoire dans la session Powershell en cours. Elle devient une commande disponible comme les autres.

Une fonction est définie par le mot clé function, un nom et optionnellement, des paramètres.

Les paramètres

Quick and dirty 💩

function Write-Presentation ($name, $age)
{

  "Bonjour $name, Tu as $age ans"

}

Cette syntaxe de base ne permet pas le contrôle des valeurs de paramètres entrés, de leur type, il ne permet pas non plus de les rendre obligatoires.

L'ordre des paramètres lors du lancement de la commandes sera le même que l'ordre dans lequel ils ont étés déclarés dans la fonction.

Cette fonction pourra donc être appelés de ces deux façons:

Write-Presentation "Julien" "38"

Write-Presentation -Name "Julien" -Age "38"

Advanced and clean 👍

function Write-Presentation
{
    [CmdletBinding()] 
	param
    (
        [Parameter(Mandatory=$true,Position=0)]
        [String]$name,

        [Parameter(Mandatory=$true,Position=1)]
        [int]$age
    )
    
   Write-host "Bonjour $name, Tu as $age ans"

}

Nous ajoutons ici à nos déclarations de paramètres plusieurs élements:

Attributs de paramètres

Ils permettent d'ajuster le comportement du paramètres. Par exemple ici, le paramètres sera obligatoire mandatory=$true, et dans le cas ou le nom du paramètres ne sera pas spécifié lors de l'appel de la fonction, il devra se trouver en première position Position=0.

[Parameter(Mandatory=$Boolean,
Position=Int,
ParameterSetName="String",
ValueFromPipeline=$Boolean,
ValueFromPipelineByPropertyName=$Boolean,
ValueFromRemainingArguments=Boolean)]
[Alias("String")]
[ValidateNotNull()]
[ValidateNotNullOrEmpty()]
[ValidateSet("String1", "String2")]
[ValidateCount(Int_min, Int_max)]
[ValidateLength(Int_min, Int_max)]
[ValidateRange(Int_min, Int_max)]
[ValidatePattern("RegexPattern")]
[ValidateScript({Expression})]
[AllowNull()]
[AllowEmptyString()]
[AllowEmptyCollection()]
[Type[]]
$Name

CmdLetBinding

function Write-Presentation
{
    [CmdletBinding()] 
	param
    (
        [Parameter(Mandatory=$true,Position=0)]
        [String]$name,

        [Parameter(Mandatory=$true,Position=1)]
        [int]$age
    )
    
   Write-host "Bonjour $name, Tu as $age ans"

}

Le mot clé CmdLetBinding() permet l'ajout à votre fonction des paramètres communs à toute les commandes Powershell

Fonctions avancées : Intégration au pipeline

Une fonction avancée qui pourra recevoir les objets avec lesquels interagir depuis le pipeline

Function Ping-IP
{
    [CmdletBinding()]
    param(
        [Parameter(Mandatory = $True, ValueFromPipeline = $True, ValueFromPipelineByPropertyName = $true)]
        [Alias("Name")]
        [Alias("ServerName")]
        [string[]]$computername
    )
    
    BEGIN 
    {
	    Write-Verbose "Ping de $($computername.count) hostname"
    }

    PROCESS
    {
        Write-Verbose "Ping de l'ordinateur $ComputerName"
        Test-Connection -ComputerName $computername -Count 1 -ErrorAction SilentlyContinue
    }

    END 
    {
	     Write-Verbose "Fin du traitement"
    }
}

• ValueFromPipeline = $true permet à la commande d'être appelé à la droite du pipeline

• ValueFromPipelineByPropertyName = $true permet à la commande de prendre comme valeur de paramètre, la propriété des objets reçu possédant le même nom (ou alias)

• Le bloc begin sera exécuté une fois au début

• Le bloc process sera exécuté autant de fois qu'il y a d'objets dans la collection envoyé dans le pipeline.

• Le bloc end sera exécuté une fois à la fin

Retour de la fonction

Une fonction (ou un script) retournera indifférement:

• Tout objet qui sera pas enregistré dans une variable.
• Tout objet renvoyé par la commande Write-Output .
• Tout objets renvoyé par le mot clé return