New-PSRoleCapabilityFile

Syntaxe

Default (Par défaut)

New-PSRoleCapabilityFile
    [-Path] <String>
    [-Guid <Guid>]
    [-Author <String>]
    [-Description <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-ModulesToImport <Object[]>]
    [-VisibleAliases <String[]>]
    [-VisibleCmdlets <Object[]>]
    [-VisibleFunctions <Object[]>]
    [-VisibleExternalCommands <String[]>]
    [-VisibleProviders <String[]>]
    [-ScriptsToProcess <String[]>]
    [-AliasDefinitions <IDictionary[]>]
    [-FunctionDefinitions <IDictionary[]>]
    [-VariableDefinitions <Object>]
    [-EnvironmentVariables <IDictionary>]
    [-TypesToProcess <String[]>]
    [-FormatsToProcess <String[]>]
    [-AssembliesToLoad <String[]>]
    [<CommonParameters>]

Description

Exemples

Exemple 1 : Créer un fichier de capacité de rôle vide

New-PSRoleCapabilityFile -Path ".\ExampleFile.psrc"

Exemple 2 : Créer un fichier de capacité de rôle permettant aux utilisateurs de redémarrer les services et n’importe quel ordinateur VDI

$roleParameters = @{
    Path = ".\Maintenance.psrc"
    Author = "User01"
    CompanyName = "Fabrikam Corporation"
    Description = "This role enables users to restart any service and restart any VDI computer."
    ModulesToImport = "Microsoft.PowerShell.Core"
    VisibleCmdlets = "Restart-Service", @{
                      Name = "Restart-Computer"
                      Parameters = @{ Name = "ComputerName"; ValidatePattern = "VDI\d+" }
    }
}
New-PSRoleCapabilityFile @roleParameters

Paramètres

-AliasDefinitions

Ajoute les alias spécifiés aux sessions qui utilisent le fichier de capacité de rôle. Entrez une table de hachage avec les clés suivantes :

• Nom. Nom de l’alias. Cette clé est requise.
• Valeur. Commande que l’alias représente. Cette clé est requise.
• Description. Chaîne de texte qui décrit l’alias. Cette clé est facultative.
• Options. Options d’alias. Cette clé est facultative. La valeur par défaut est Aucun. Les valeurs acceptables pour ce paramètre sont : None, ReadOnly, Constant, Private ou AllScope.

Par exemple : @{Name="hlp";Value="Get-Help";Description="Gets help";Options="ReadOnly"}

Propriétés du paramètre

Jeux de paramètres

-AssembliesToLoad

Spécifie les assemblys à charger dans les sessions qui utilisent le fichier de capacité de rôle.

Propriétés du paramètre

Jeux de paramètres

-Author

Spécifie l’utilisateur qui a créé le fichier de capacité de rôle.

Propriétés du paramètre

Jeux de paramètres

-CompanyName

Identifie l’entreprise qui a créé le fichier de capacité de rôle. La valeur par défaut est Unknown.

Propriétés du paramètre

Jeux de paramètres

-Copyright

Spécifie un droit d’auteur pour le fichier de capacité de rôle. Si vous omettez ce paramètre, New-PSRoleCapabilityFile génère une déclaration de copyright à l’aide de la valeur du paramètre Author .

Propriétés du paramètre

Jeux de paramètres

-Description

Spécifie une description du fichier de capacité de rôle.

Propriétés du paramètre

Jeux de paramètres

-EnvironmentVariables

Spécifie les variables d’environnement pour les sessions qui exposent ce fichier de capacité de rôle. Entrez une table de hachage dans laquelle les clés sont les noms des variables d’environnement et les valeurs sont les valeurs des variables d’environnement.

Par exemple : EnvironmentVariables=@{TestShare="\\\\Server01\TestShare"}

Propriétés du paramètre

Jeux de paramètres

-FormatsToProcess

Spécifie les fichiers de formatage (.ps1xml) qui s’exécutent dans les sessions qui utilisent le fichier de capacité de rôle. La valeur de ce paramètre doit être un chemin d’accès complet ou absolu des fichiers de mise en forme.

Propriétés du paramètre

Jeux de paramètres

-FunctionDefinitions

Ajoute les fonctions spécifiées aux sessions qui exposent la fonctionnalité de rôle. Entrez une table de hachage avec les clés suivantes :

• Nom. Nom de la fonction. Cette clé est requise.
• ScriptBlock. Corps de la fonction. Entrez un bloc de script. Cette clé est requise.
• Options. Options de fonction. Cette clé est facultative. La valeur par défaut est Aucun. Les valeurs acceptables pour ce paramètre sont : None, ReadOnly, Constant, Private ou AllScope.

Par exemple:

@{Name="Get-PowerShellProcess";ScriptBlock={Get-Process PowerShell};Options="AllScope"}

Propriétés du paramètre

Jeux de paramètres

-Guid

Spécifie un identificateur unique pour le fichier de capacité de rôle. Si vous omettez ce paramètre, New-PSRoleCapabilityFile génère un GUID pour le fichier. Pour créer un GUID dans PowerShell, tapez [guid]::NewGuid().

Propriétés du paramètre

Jeux de paramètres

-ModulesToImport

Spécifie les modules qui sont automatiquement importés dans des sessions qui utilisent le fichier de capacité de rôle. Par défaut, toutes les commandes des modules répertoriés sont visibles. Lorsqu’elles sont utilisées avec VisibleCmdlets ou VisibleFunctions, les commandes visibles à partir des modules spécifiés peuvent être restreintes.

Chaque module utilisé dans la valeur de ce paramètre peut être représenté par une chaîne ou par une table de hachage. Une chaîne de module se compose uniquement du nom du module. Une table de hachage de module peut inclure ModuleName, ModuleVersionet GUID clés. Seule la clé ModuleName est requise.

Par exemple, la valeur suivante se compose d’une chaîne et d’une table de hachage. Toute combinaison de chaînes et de tables de hachage, dans n’importe quel ordre, est valide.

"TroubleshootingPack", @{ModuleName="PSDiagnostics"; ModuleVersion="1.0.0.0";GUID="c61d6278-02a3-4618-ae37-a524d40a7f44"}

Propriétés du paramètre

Jeux de paramètres

-Path

Spécifie le chemin d’accès et le nom du fichier de capacité de rôle. Le fichier doit avoir une extension de nom de fichier .psrc.

Propriétés du paramètre

Jeux de paramètres

-ScriptsToProcess

Spécifie des scripts à ajouter à des sessions qui utilisent le fichier de capacité de rôle. Entrez le chemin d’accès et les noms de fichiers des scripts. La valeur de ce paramètre doit être un chemin d’accès complet ou absolu des noms de fichiers de script.

Propriétés du paramètre

Jeux de paramètres

-TypesToProcess

Spécifie les fichiers de type (.ps1xml) à ajouter aux sessions qui utilisent le fichier de capacité de rôle. Entrez les noms de fichiers de type. La valeur de ce paramètre doit être un chemin d’accès complet ou absolu des noms de fichiers de type.

Propriétés du paramètre

Jeux de paramètres

-VariableDefinitions

Spécifie des variables à ajouter à des sessions qui utilisent le fichier de capacité de rôle. Entrez une table de hachage avec les clés suivantes :

• Nom. Nom de la variable. Cette clé est requise.
• Valeur. Valeur de variable. Cette clé est requise.
• Options. Options variables. Cette clé est facultative. La valeur par défaut est Aucun. Les valeurs acceptables pour ce paramètre sont : None, ReadOnly, Constant, Private ou AllScope.

Par exemple : @{Name="WarningPreference";Value="SilentlyContinue";Options="AllScope"}

Propriétés du paramètre

Jeux de paramètres

-VisibleAliases

Limite les alias de la session à ces alias spécifiés dans la valeur de ce paramètre, ainsi que les alias que vous définissez dans le paramètre AliasDefinition. Les caractères génériques sont pris en charge. Par défaut, tous les alias définis par le moteur PowerShell et tous les alias que les modules exportent sont visibles dans la session.

Par exemple, pour limiter les alias disponibles à gm et gcm, utilisez cette syntaxe : VisibleAliases="gcm", "gp"

Lorsqu’un paramètre visible est inclus dans le fichier de fonctionnalité de rôle, PowerShell supprime l’applet de commande Import-Module et son alias de ipmo de la session.

Propriétés du paramètre

Jeux de paramètres

-VisibleCmdlets

Limite les applets de commande de la session à celles spécifiées dans la valeur de ce paramètre. Les caractères génériques et les noms qualifiés de module sont pris en charge.

Par défaut, toutes les applets de commande que les modules de l’exportation de session sont visibles dans la session. Utilisez les paramètres SessionType et ModulesToImport pour déterminer quels modules et composants logiciels enfichables sont importés dans la session. Si aucun module dans ModulesToImport exposer l’applet de commande, New-PSRoleCapabilityFile tente de charger le module approprié.

Quand un paramètre Visible est inclus dans le fichier de configuration de session, PowerShell supprime l’applet de commande Import-Module et son alias de ipmo de la session.

Propriétés du paramètre

Jeux de paramètres

-VisibleExternalCommands

Limite les fichiers binaires, scripts et commandes externes qui peuvent être exécutés dans la session à ceux spécifiés dans la valeur de ce paramètre.

Par défaut, aucune commande externe n’est visible dans cette session.

Quand un paramètre Visible est inclus dans le fichier de configuration de session, PowerShell supprime l’applet de commande Import-Module et son alias de ipmo de la session.

Propriétés du paramètre

Jeux de paramètres

-VisibleFunctions

Limite les fonctions de la session à celles spécifiées dans la valeur de ce paramètre, ainsi que les fonctions que vous définissez dans le paramètre FunctionDefinitions. Les caractères génériques sont pris en charge.

Par défaut, toutes les fonctions exportées par les modules de la session sont visibles dans cette session. Utilisez les paramètres SessionType et ModulesToImport pour déterminer quels modules sont importés dans la session.

Quand un paramètre Visible est inclus dans le fichier de configuration de session, PowerShell supprime l’applet de commande Import-Module et son alias de ipmo de la session.

Propriétés du paramètre

Jeux de paramètres

-VisibleProviders

Limite les fournisseurs PowerShell de la session à ceux spécifiés dans la valeur de ce paramètre. Les caractères génériques sont pris en charge.

Par défaut, tous les fournisseurs exportés par un module dans la session sont visibles dans la session. Utilisez les paramètres SessionType et ModulesToImport pour déterminer quels modules sont importés dans la session.

Quand un paramètre Visible est inclus dans le fichier de configuration de session, PowerShell supprime l’applet de commande Import-Module et son alias de ipmo de la session.

Propriétés du paramètre

Jeux de paramètres

CommonParameters

Liens associés

• New-PSSessionConfigurationFile
• Get-PSSessionCapability