Syntaxe de cmdlet ExchangeExchange cmdlet syntax

Rubriques de référence de cmdlet Exchange utilisent une méthode normalisée qui décrit les principaux aspects concernant l’applet de commande. Par exemple :Exchange cmdlet reference topics use a standardized method that describes key aspects about the cmdlet. For example:

  • Paramètres qui sont disponibles sur l’applet de commande.Parameters that are available on the cmdlet.

  • Chaque paramètre accepte les valeurs.Values that each parameter accepts.

  • Les paramètres qui peuvent être utilisés ensemble et les paramètres qui doivent être utilisées séparément.Parameters that can be used together, and parameters that need to be used separately.

Cette rubrique explique ces conventions et la syntaxe nécessaire pour exécuter les commandes dans Exchange PowerShell.This topic explains these conventions, and also the syntax that's required to run commands in Exchange PowerShell.

Conventions des commandes dans Exchange PowerShellCommand conventions in 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.Exchange PowerShell help follows conventions that indicate what's required or optional, and how to enter parameters and values when you run a command. These command conventions are listed in the following table.

SymboleSymbol DescriptionDescription
- Un trait d’union indique un paramètre. Par exemple, -Identity.A hyphen indicates a parameter. For example, -Identity.
< > Crochets indiquent les valeurs possibles pour un paramètre. Par exemple, -Location <ServerName> ou '-activé < $trueAngle brackets indicate the possible values for a parameter. For example, -Location <ServerName> or `-Enabled <$true
[ ] Crochets indiquent des paramètres facultatifs et leurs valeurs. Par exemple, [-WhatIf <SwitchParameter>]. Les paires de valeur de paramètre qui ne sont pas placés entre crochets sont nécessaires.Square brackets indicate optional parameters and their values. For example, [-WhatIf <SwitchParameter>]. Parameter-value pairs that aren't enclosed in square brackets are required.
| Symboles de canal de valeurs de paramètre indiquent un choix entre les valeurs. Par exemple, '-activé < $truePipe symbols in parameter values indicate a choice between values. For example, `-Enabled <$true

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.These command conventions help you understand how a command is constructed. With the exception of the hyphen that indicates a parameter, you don't use these symbols as they're described in the table when you run cmdlets in Exchange PowerShell.

Jeux de paramètres dans Exchange PowerShellParameter sets in 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).Parameter sets are groups of parameters that can be used with each other in the same command. Parameters that exist different parameter sets are mutually exclusive (they can't be used together in the same command).

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:Many cmdlets have only one parameter set, which means that all available parameters can be used with each other. Other cmdlets have several parameter sets, which indicates some parameters perform functions that are incompatible with other parameters. For example, suppose the following parameter sets are available on the New-SystemMessage cmdlet:

New-SystemMessage -DsnCode <EnhancedStatusCode> -Internal <$true | $false> -Language <CultureInfo> -Text <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]  <COMMON PARAMETERS>

New-SystemMessage -Language <CultureInfo> -QuotaMessageType <WarningMailboxUnlimitedSize | WarningPublicFolderUnlimitedSize | WarningMailbox | WarningPublicFolder | ProhibitSendMailbox | ProhibitPostPublicFolder | ProhibitSendReceiveMailBox> -Text <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]] <COMMON PARAMETERS>

Cette cmdlet a deux jeux de paramètres distincts. Cela signifie que vous pouvez utiliser ces paramètres ensemble dans la même commande :This cmdlet has two separate parameter sets. This indicates that you can use these parameters together in the same command:

  • DsnCodeDsnCode

  • InternalInternal

  • LanguageLanguage

  • TextText

  • ConfirmConfirm

  • Contrôleur de domaineDomainController

  • WhatIfWhatIf

Et vous pouvez également utiliser ces paramètres ensemble dans la même commande :And you can use these parameters together in the same command:

  • LanguageLanguage

  • QuotaMessageTypeQuotaMessageType

  • TextText

  • ConfirmConfirm

  • Contrôleur de domaineDomainController

  • WhatIfWhatIf

Mais vous ne pouvez pas utiliser ces paramètres ensemble dans la même commande :But you can't use these parameters together in the same command:

  • DsnCode et QuotaMessageType.DsnCode and QuotaMessageType.

  • Interne et QuotaMessageType.Internal and QuotaMessageType.

Le <COMMON PARAMETERS> entrée indique que l’applet de commande prend en charge les paramètres de base de Windows PowerShell qui sont disponibles sur pratiquement n’importe quelle applet de commande (par exemple, Debug). Vous pouvez utiliser les paramètres communs avec des paramètres à partir de n’importe quel jeu de paramètres. Pour plus d’informations, consultez about_CommonParameters.The <COMMON PARAMETERS> entry indicates the cmdlet supports the basic Windows PowerShell parameters that are available on virtually any cmdlet (for example, Debug). You can use common parameters with parameters from any parameter set. For more information, see about_CommonParameters.

Guillemets dans Exchange PowerShellQuotation marks in Exchange PowerShell

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 :In Exchange PowerShell, you use single quotation marks ( ' ) or double quotation marks ( " ) to enclose parameter values that contain spaces. For example, the following commands behave the same:

  • Get-ReceiveConnector -Identity "Contoso Receive Connector"

  • Get-ReceiveConnector -Identity 'Contoso Receive Connector'

Si vous ne placez pas la valeur Contoso Receive Connector dans les devis, Exchange PowerShell tente de traiter chaque mot comme un nouvel argument, et la commande échouera. Dans cet exemple, vous recevrez une erreur qui ressemble à ceci :If you don't enclose the value Contoso Receive Connector in quotes, Exchange PowerShell tries to treat each word as a new argument, and the command will fail. In this example, you'll receive an error that looks like this:

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

Si la valeur contient des variables, vous devez soigneusement choisir entre guillemets simples et doubles. Par exemple, supposons que vous avez une variable nommée $Server ayant la valeur Mailbox01.If the value contains variables, you need choose carefully between single quotes and double quotes. For example, suppose you have a variable named $Server that has the value Mailbox01.

  • Guillemets: sont remplacées par les valeurs des Variables. Résultats de l' entrée « $Server exemple » dans la sortie de Mailbox01 Example.Double quotation marks: Variables are substituted with their values. The input "$Server Example" results in the output Mailbox01 Example.

  • Guillemets simples: Variables sont traités de manière littérale. L' entrée ' exemple $Server' entraîne la sortie $Server Example.Single quotation marks: Variables are treated literally. The input '$Server Example' results in the output $Server Example.

Pour plus d’informations sur les variables, consultez Les Variables définies par l’utilisateur et les Variables d’environnement.For more information about variables, see User-Defined Variables and Shell Variables.

Caractères d'échappement dans Exchange PowerShellEscape characters in Exchange PowerShell

Dans n’importe quel langage de programmation, un caractère d’échappement est utilisé pour identifier les caractères spéciaux littéralement et non pas par leur fonction normale dans cette langue. Dans PowerShell d’Exchange, lorsque vous placez une chaîne de texte entre guillemets doubles, le caractère d’échappement est le caractère d’échappement de guillemet arrière ( ` ).In any programming language, an escape character is used to identify special characters literally, and not by their normal function in that language. In Exchange PowerShell, when you enclose a text string in double quotation marks, the escape character is the back quotation mark escape character ( ` ).

Par exemple, si vous souhaitez que la sortie The price is $23, entrez la valeur « le prix est `$23 ». Le caractère d’échappement est nécessaire car le caractère de signe dollar ($) définit les variables dans Exchange PowerShell.For example, if you want the output The price is $23, enter the value "The price is `$23". The escape character is required because the dollar sign character ( $ ) defines variables in Exchange PowerShell.

Si vous placez la chaîne entre guillemets simples, le seul caractère spécial que devez vous soucier est le caractère de guillemet simple, qui nécessite deux guillemets simples ('').If you enclose the string in single quotation marks, the only special character you need to worry about is the single quotation mark character itself, which requires two single quotation marks ( '' ).

Par exemple, si vous souhaitez que la sortie Don't confuse two single quotation marks with a double quotation mark!, entrez la valeur ' Don'' t confondez pas deux guillemets simples avec un guillemet double !'.For example, if you want the output Don't confuse two single quotation marks with a double quotation mark!, enter the value 'Don''t confuse two single quotation marks with a double quotation mark!'.

Opérateurs de commandes dans Exchange PowerShellCommand operators in Exchange PowerShell

Le tableau suivant présente les opérateurs valides que vous pouvez utiliser dans une commande d’Exchange. Certains de ces symboles ont été également décrits dans les conventions de commande antérieures dans la section d’Exchange PowerShell. Toutefois, ces symboles ont des significations différentes lorsqu’elles sont utilisées sur la ligne de commande en tant qu’opérateurs. Par exemple, le signe qui est utilisé pour indiquer un paramètre peut également servir dans une commande comme un opérateur mathématique.The following table shows the valid operators that you can use in an Exchange command. Some of these symbols were also described in the earlier Command conventions in Exchange PowerShell section. However, these symbols have different meanings when they're used on the command line as operators. For example, the minus sign that's used to indicate a parameter can also be used in a command as a mathematical operator.

OpérateurOperator DescriptionDescription
= 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 :The equal sign is used as an assignment character. The value on the right side of the equal sign is assigned to the variable on the left side of the equal sign. The following characters are also assignment characters:
+= Ajoutez la valeur à droite du signe Égal à la valeur actuelle contenue dans la variable à gauche du signe Égal.+= Add the value on the right side of the equal sign to the current value that's contained in the variable on the left side of the equal sign.
-= Soustrayez la valeur à droite du signe Égal de la valeur actuelle contenue dans la variable à gauche du signe Égal.-= Subtract the value on the right side of the equal sign from the current value that's contained in the variable on the left side of the equal sign.
*= Multipliez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal.*= Multiply the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
/= Divisez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal./= Divide the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
%= Remplacez la valeur actuelle de la variable à gauche du signe Égal par la valeur à droite du signe Égal.%= Modify the current value of the variable on the left side of the equal sign by the value that's specified on the right side of the equal sign.
: 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 Parameters. A colon can be used to separate a parameter's name from the parameter's value. For example, -Enabled:$True. Using a colon is optional with all parameter types except switch parameters. For more information about switch parameters, see Parameters.
! 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 ». The exclamation point is a logical NOT operator. When it is used with the equal ( = ) sign, the combined pair means "not equal to."
[ ] Pour spécifier la valeur de l’index de position d’un tableau, les crochets sont utilisés. Valeurs d’index sont des offsets qui commencent à zéro. Par exemple, $Red[9] fait référence à la dixième position d’index dans le tableau, $Red.Brackets are used to specify the index value of an array position. Index values are offsets that start at zero. For example, $Red[9] refers to the tenth index position in the array, $Red.
Crochets permet également d’affecter un type à une variable (par exemple, $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, etXML.Brackets can also be used to assign a type to a variable (for example, $A=[XML] "<Test><A>value</A></Test>"). The following variable types are available: Array, Bool, Byte, Char, Char[], Decimal, Double, Float, Int, Int[], Long, Long[], RegEx, Single, ScriptBlock, String, Type, and XML.
{ } Les accolades servent à inclure une expression dans une commande ; par exemple, `Get-ProcessBraces are used to include an expression in a command. For example, `Get-Process
| La barre verticale est utilisée quand une cmdlet envoie un résultat vers une autre cmdlet ; par exemple, `Get-Mailbox -Server SRV1The pipe symbol is used when one cmdlet pipes a result to another cmdlet. For example, `Get-Mailbox -Server SRV1
> Le crochet est utilisé pour envoyer la sortie d’une commande dans un fichier, et le contenu du fichier est remplacé. Par exemple, Get-TransportRulePredicate > "C:\My Documents\Output.txt".The right-angle bracket is used to send the output of a command to a file, and the contents of the file are overwritten. For example, Get-TransportRulePredicate > "C:\My Documents\Output.txt".
>> Doubles chevrons de droite sont utilisés pour ajouter la sortie d’une commande vers un fichier existant. Si le fichier n’existe pas, un nouveau fichier est créé. Par exemple, Get-TransportRulePredicate >> "C:\My Documents\Output.txt".Double right-angle brackets are used to append the output of a command to an existing file. If the file doesn't exist, a new file is created. For example, Get-TransportRulePredicate >> "C:\My Documents\Output.txt".
" Les guillemets permettent d'entourer une chaîne contenant des espaces.Double quotation marks are used to enclose text strings that contains spaces.
$ Un signe dollar indique une variable. Par exemple, $Blue = 10 affecte la valeur 10 à la variable $Blue. A dollar sign indicates a variable. For example, $Blue = 10 assigns the value 10 to the variable $Blue.
@ Le symbole @ fait référence à un tableau associatif. Pour plus d'informations, voir Arrays.The @ symbol references an associative array. For more information, see Arrays.
$( )$( ) Un signe dollar ( $ ) entre parenthèses indique le remplacement de la commande. Vous pouvez utiliser la substitution de commande lorsque vous voulez utiliser la sortie d’une commande en tant qu’argument dans une autre commande. Par exemple, Get-ChildItem $(Read-Host -Prompt "Enter FileName: ").A dollar sign ( $ ) with parentheses indicates command substitution. You can use command substitution when you want to use the output of one command as an argument in another command. For example, 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].Double-periods indicate a value range. For example, if an array contains several indexes, you can return the values of all indexes between the second and fifth indexes by running the command: $Blue[2..5].
+ L'opérateur + additionne deux valeurs. Par exemple, 6 + 6 est égal à 12. The + operator adds two values together. For example, 6 + 6 equals 12.
- Le - opérateur soustrait une valeur d’une autre valeur (par exemple, 12 - 6 est égal à 6) ou indique un nombre négatif (par exemple, -6 * 6 est égal à -36).The - operator subtracts one value from another value (for example, 12 - 6 equals 6) or indicates a negative number (for example, -6 * 6 equals -36).
\* Vous pouvez utiliser le caractère générique pour comparer des chaînes (par exemple « Get-UserYou can use the wildcard character to match strings (for example `Get-User
/ L'opérateur / divise une valeur par une autre. Par exemple, 6 / 6 est égal à 1. The / operator divides one value by another. For example, 6 / 6 equals 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. In a numerical evaluation, the % operator returns the remainder from a division operator. For example, 6 % 4 equals 2.
Dans un tuyau, le caractère de pourcentage ( % ) est l’abréviation de l’applet de commande ForEach-Object . Par exemple, ' importation-Csv c:\MyFile.csvIn a pipeline, the percent character ( % ) is shorthand for the ForEach-Object cmdlet. For example, `Import-Csv c:\MyFile.csv
? Le point d'interrogation ( ?) est le raccourci de la cmdlet Where-Object. Par exemple, `Get-AliasThe question mark character ( ? ) is shorthand for the Where-Object cmdlet. For example, `Get-Alias