Syntaxe de cmdlet Exchange

 

S’applique à :Exchange Online, Exchange Online Protection, Exchange Server 2016, Office 365 Security & Compliance Center

Dernière rubrique modifiée :2015-11-30

En savoir plus sur la structure et la syntaxe des cmdlets dans Exchange, Exchange Online, Exchange Online Protection et le Centre de conformité et sécurité dans Office 365.

Les rubriques de référence des cmdlets Exchange utilisent une méthode standardisée qui décrit les aspects clés des cmdlets : Par exemple :

  • Les paramètres disponibles dans les cmdlets.

  • Les valeurs acceptées par chaque paramètre.

  • Les paramètres qui peuvent être utilisés ensemble et ceux qui doivent être utilisés séparément.

Cette rubrique explique ces conventions et la syntaxe nécessaire pour exécuter les commandes dans Exchange PowerShell.

Contenu

Conventions des commandes dans Exchange PowerShell

Jeux de paramètres dans Exchange PowerShell

Guillemets dans Exchange PowerShell

Caractères d’échappement dans Exchange PowerShell

Opérateurs de commande dans Exchange PowerShell

Exchange PowerShell permet de respecter les conventions indiquant les éléments obligatoires et facultatifs, et comment entrer les paramètres et les valeurs lorsque vous exécutez une commande. Les conventions de commandes sont répertoriées dans le tableau suivant.

 

Symbole Description

-

Un tiret indique un paramètre. Par exemple, -Identity.

< >

Des chevrons indiquent les valeurs possibles pour un paramètre. Par exemple, -Location <ServerName> ou -Enabled <$true | $false>.

[ ]

Des crochets indiquent des paramètres facultatifs et leurs valeurs. Par exemple, [-WhatIf <SwitchParameter>].

Les paires paramètre-valeur qui ne sont pas mises entre crochets sont obligatoires.

|

Les barres verticales dans les valeurs de paramètre indiquent un choix entre des valeurs. Par exemple, -Enabled <$true | $false> indique que le paramètre Enabled peut avoir la valeur $true ou $false.

Ces conventions de commandes permettent de comprendre la manière dont une commande est construite. À l’exception du trait d’union qui indique un paramètre, vous n’utilisez pas les symboles tels qu’ils sont décrits dans le tableau lorsque vous exécutez des cmdlets dans Exchange PowerShell.

Les jeux de paramètres sont des groupes de paramètres pouvant être utilisés ensemble dans la même commande. Les paramètres qui existent dans différents jeux de paramètres s’excluent mutuellement (ils ne peuvent pas être utilisés conjointement dans la même commande).

Beaucoup de cmdlets n'ont qu’un seul jeu de paramètres, ce qui signifie que tous les paramètres disponibles peuvent être utilisés ensemble. D’autres cmdlets ont plusieurs jeux de paramètres ; dans ce cas, certains paramètres exécutent des fonctions incompatibles avec d’autres paramètres. Par exemple, supposons que les jeux de paramètres suivants sont disponibles pour la cmdlet New-SystemMessage :

New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false> -Language <CultureInfo> -Text <String> <COMMON PARAMETERS> 
 
New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailboxUnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | WarningPublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSendReceiveMailBox> -Text <String> <COMMON PARAMETERS> 
 
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Cette cmdlet a deux jeux de paramètres distincts. Cela signifie que vous pouvez utiliser ces paramètres ensemble dans la même commande :

  • DsnCode

  • Internal

  • Language

  • Text

Et vous pouvez également utiliser ces paramètres ensemble dans la même commande :

  • Language

  • QuotaMessageType

  • Text

Mais vous ne pouvez pas utiliser ces paramètres ensemble dans la même commande :

  • DsnCode et QuotaMessageType.

  • Internal et QuotaMessageType.

La section COMMON PARAMETERS contient les paramètres (en général, facultatifs) utilisables avec les paramètres de n’importe quel jeu de paramètres. Par exemple, vous pouvez utiliser le paramètre Confirm avec les paramètres DsnCode et QuotaMessageType, même si ces derniers sont dans des jeux de paramètres différents.

Dans Exchange PowerShell, vous utilisez des apostrophes (') ou des guillemets (") autour des valeurs de paramètres qui contiennent des espaces. Par exemple, les commandes suivantes ont le même comportement :

  • Get-ReceiveConnector -Identity "Contoso Receive Connector"

  • Get-ReceiveConnector -Identity 'Contoso Receive Connector'

Si vous ne placez pas la valeur Contoso Receive Connector entre guillemets, Exchange PowerShell tente de traiter chaque mot comme un nouvel argument, et la commande échoue. Dans cet exemple, vous recevrez une erreur de ce type :

A positional parameter cannot be found that accepts argument 'Receive'

Vous devez choisir soigneusement entre apostrophes et guillemets si la valeur contient des variables. Par exemple, prenons une variable nommée $Server qui a la valeur Mailbox01.

  • Guillemets   Les variables sont remplacées par les valeurs correspondantes. L’entrée "$Server Example" génère la sortie Mailbox01 Example.

  • Apostrophes   Les variables sont traitées littéralement. L’entrée '$Server Example' génère la sortie $Server Example.

Pour plus d’informations sur les variables, consultez les rubriques Variables définies par l’utilisateur et Variables de l’environnement Shell.

Dans n’importe quel langage de programmation, un caractère d’échappement sert à identifier les caractères spéciaux littéralement et non selon leur fonction normale dans ce langage. Dans Exchange PowerShell, lorsque vous placez une chaîne de texte entre guillemets, le caractère d’échappement est l’accent grave ( ` ).

Par exemple, si vous souhaitez obtenir la sortie The price is $23, entrez la valeur "The price is `$23". Le caractère d’échappement est obligatoire, car le signe dollar ($) définit les variables dans Exchange PowerShell.

Si vous placez la chaîne entre apostrophes, le seul caractère spécial dont vous avez besoin est l’apostrophe elle-même, ce qui nécessite de la doubler ('').

Par exemple, si vous souhaitez obtenir la sortie Don't confuse two single quotation marks with a double quotation mark!, entrez la valeur 'Don''t confuse two single quotation marks with a double quotation mark!'.

Le tableau suivant présente les opérateurs valides que vous pouvez utiliser dans une commande Exchange. Certains de ces symboles ont été également décrits plus haut, dans la section Conventions des commandes dans Exchange PowerShell. Toutefois, ces symboles ont des significations différentes lorsqu’ils sont utilisés comme opérateurs dans la ligne de commande. Par exemple, le signe moins utilisé pour signaler un paramètre peut également servir d’opérateur mathématique dans une commande.

 

Opérateur Description

=

Le signe Égal est utilisé comme caractère d’affectation. La valeur à droite du signe Égal est affectée à la variable à gauche du signe Égal. Les caractères ci-après sont également des caractères d’affectation :

  • +=   Ajoutez la valeur à droite du signe Égal à la valeur actuelle contenue dans la variable à gauche du signe Égal.

  • -=   Soustrayez la valeur à droite du signe Égal de la valeur actuelle contenue dans la variable à gauche du signe Égal.

  • *=   Multipliez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal.

  • /=   Divisez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal.

  • %=   Remplacez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal.

:

Le signe deux-points peuvent servir à séparer le nom et la valeur d’un paramètre, comme dans l’exemple suivant : -Enabled:$True. L’utilisation des deux-points est facultative pour tous les types de paramètre, excepté pour les paramètres de commutateur. Pour plus d’informations sur les paramètres de commutateur, voir Paramètres.

!

Le point d’exclamation est un opérateur logique NOT. Lorsqu’il est utilisé avec le signe Égal (=), la paire combinée signifie « est différent de ».

[ ]

Les crochets servent à spécifier la valeur index d’une position dans un tableau. Les valeurs d’index sont des décalages qui commencent à zéro. Par exemple, $Red[9] fait référence à la dixième position d’index du tableau, $Red.

Les crochets peuvent également être utilisés pour affecter un type à une variable, comme dans l’exemple suivant : $A=[XML] "<Test><A>value</A></Test>". Les types de variables suivants sont disponibles : Array, Bool, Byte, Char, Char[], Decimal, Double, Float, Int, Int[], Long, Long[], RegEx, Single, ScriptBlock, String, Type et XML..

{ }

Les accolades servent à inclure une expression dans une commande ; par exemple, Get-Process | Where {$_.HandleCount -gt 400}.

|

La barre verticale est utilisée quand une cmdlet envoie un résultat vers une autre cmdlet ; par exemple, Get-Mailbox -Server SRV1 | Set-Mailbox -ProhibitSendQuota 2GB.

>

Le chevron vers la droite sert à envoyer la sortie d’une commande vers un fichier, et le contenu du fichier est remplacé. Par exemple, Get-TransportRulePredicate > "C:\My Documents\Output.txt".

>>

Les chevrons doubles vers la droite permettent d’ajouter la sortie d’une commande à un fichier existant. Si le fichier n’existe pas, il est créé. Par exemple, Get-TransportRulePredicate >> "C:\My Documents\Output.txt".

"

Les guillemets permettent d’entourer une chaîne contenant des espaces.

$

Un signe dollar indique une variable. Par exemple, $Blue = 10 affecte la valeur 10 à la variable $Blue.

@

Le symbole @ fait référence à un tableau associatif. Pour plus d’informations, voir Tableaux.

$( )

Un signe dollar ($) entre parenthèses indique une substitution de commande. Une substitution de commande vous permet d’utiliser la sortie d’une commande comme argument dans une autre commande, comme dans l’exemple suivant : Get-ChildItem $(Read-Host -Prompt "Enter FileName: ").

..

Les points doubles indiquent une plage de valeurs. Par exemple, si un tableau contient plusieurs index, vous pouvez renvoyer les valeurs de tous les index situés entre les deuxième et cinquième index à l’aide de la commande suivante : $Blue[2..5].

+

L’opérateur + additionne deux valeurs. Par exemple, 6 + 6 est égal à 12.

-

L’opérateur - soustrait une valeur à une autre valeur. Par exemple, 12 - 6 est égal à 6.

L’opérateur - représente également un nombre négatif, tel que -6. Par exemple, -6 * 6 est égal à -36.

*

Un caractère générique a plusieurs significations. Les caractères génériques permettent de faire correspondre des chaînes, de multiplier les valeurs numériques ou, au cas où les chaînes et les valeurs numériques sont utilisées ensemble, de répéter la valeur de la chaîne le nombre de fois spécifié par la valeur numérique. Par exemple, "Test" * 3 est égal à TestTestTest.

/

L’opérateur / divise une valeur par une autre. Par exemple, 6 / 6 est égal à 1.

%

Dans une évaluation numérique, l’opérateur % renvoie le reste d’un opérateur de division. Par exemple, 6 % 4 est égal à 2.

Dans un pipeline, le caractère de pourcentage (%) est le raccourci de la cmdlet ForEach-Object. Par exemple, Import-Csv c:\MyFile.csv | ForEach-Object {Set-Mailbox $_.Identity -Name $_.Name} est identique à Import-Csv c:\MyFile.csv | % {Set-Mailbox $_.Identity -Name $_.Name}.

Pour plus d’informations, voir Traitement en pipeline.

?

Le point d’interrogation (?) est le raccourci de la cmdletWhere-Object. Par exemple, Get-Alias | Where-Object {$_.Definition -eq "Clear-Host"} est identique à Get-Alias | ? {$_.Definition -eq "Clear-Host"}.

 
Afficher: