New-PSRoleCapabilityFile
Létrehoz egy fájlt, amely meghatározza a munkamenet-konfiguráción keresztül közzéteendő képességek készletét.
Syntax
Default (Alapértelmezett)
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
A New-PSRoleCapabilityFile parancsmag létrehoz egy fájlt, amely meghatározza a munkamenet-konfigurációs fájlokon keresztül elérhetővé tehető felhasználói képességeket. Ez magában foglalja annak meghatározását, hogy mely parancsmagok, függvények és szkriptek érhetők el a felhasználók számára. A képességfájl egy ember által olvasható szövegfájl, amely a munkamenet-konfigurációs tulajdonságok és értékek kivonattábláját tartalmazza. A fájl fájlnévkiterjesztéssel .psrc rendelkezik, és több munkamenet-konfigurációval is használható.
Az összes paraméter New-PSRoleCapabilityFile megadása nem kötelező, kivéve az Elérési út paramétert, amely a fájl elérési útját adja meg. Ha nem ad meg paramétert a parancsmag futtatásakor, a munkamenet-konfigurációs fájl megfelelő kulcsát megjegyzésként fűzi hozzá a rendszer, kivéve, ha a paraméter leírása fel van jegyezve. Ha például nem tartalmazza a AssembliesToLoad paramétert, a rendszer megjegyzést fűz a munkamenet-konfigurációs fájlhoz.
Ha a szerepkör-képességfájlt munkamenet-konfigurációban szeretné használni, először helyezze a fájlt egy érvényes PowerShell-modulmappa RoleCapabilities almappájába. Ezután hivatkozzon a fájlra név szerint egy PowerShell-munkamenet-konfigurációs (.pssc) fájl RoleDefinitions mezőjében.
Ezt a parancsmagot a Windows PowerShell 5.0-ban vezették be.
Példák
1. példa: Üres szerepkör-képességfájl létrehozása
Ez a példa egy új szerepkör-képességfájlt hoz létre, amely az alapértelmezett (üres) értékeket használja. A fájl később szerkeszthető egy szövegszerkesztőben a konfigurációs beállítások módosításához.
New-PSRoleCapabilityFile -Path ".\ExampleFile.psrc"
2. példa: Szerepkör-képességfájl létrehozása, amely lehetővé teszi a felhasználók számára a szolgáltatások és bármely VDI-számítógép újraindítását
Ez a példa egy minta szerepkör-képességfájlt hoz létre, amely lehetővé teszi a felhasználók számára az adott névmintának megfelelő szolgáltatások és számítógépek újraindítását. A névszűrés úgy határozható meg, hogy a ValidatePattern paramétert reguláris kifejezésre VDI\d+állítja.
$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éterek
-AliasDefinitions
Hozzáadja a megadott aliasokat a szerepkör-képességfájlt használó munkamenetekhez. Adjon meg egy kivonattáblát a következő kulcsokkal:
- Név. Az alias neve. Ez a kulcs szükséges.
- Érték. Az alias által képviselt parancs. Ez a kulcs szükséges.
- Leírás. Az aliast leíró szöveges karakterlánc. Ez a kulcs nem kötelező.
- Beállítások. Alias opciók. Ez a kulcs nem kötelező. Az alapértelmezett érték Nincs. A paraméter elfogadható értékei a következők: None, ReadOnly, Constant, Private vagy AllScope.
Például: @{Name="hlp";Value="Get-Help";Description="Gets help";Options="ReadOnly"}
Paramétertulajdonságok
| Típus: | |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-AssembliesToLoad
Megadja a szerepkör-képességfájlt használó munkamenetekbe betöltendő szerelvényeket.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Author
Megadja azt a felhasználót, aki létrehozta a szerepkör-képességfájlt.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-CompanyName
Azonosítja a szerepkör-képességfájlt létrehozó vállalatot. Az alapértelmezett érték Ismeretlen.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Copyright
Megadja a szerepkör-képességfájl szerzői jogát. Ha kihagyja ezt a paramétert, New-PSRoleCapabilityFile létrehoz egy szerzői jogi nyilatkozatot a Szerző paraméter értékével.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Description
Megadja a szerepkör-képességfájl leírását.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-EnvironmentVariables
Megadja a szerepkör-képességfájlt elérhetővé tevő munkamenetek környezeti változóit. Adjon meg egy kivonattáblát, amelyben a kulcsok a környezeti változók nevei, az értékek pedig a környezeti változó értékei.
Például: EnvironmentVariables=@{TestShare="\\\\Server01\TestShare"}
Paramétertulajdonságok
| Típus: | IDictionary |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-FormatsToProcess
Megadja a szerepkör-képességfájlt használó munkamenetekben futtatott formázási fájlokat (.ps1xml).
A paraméter értékének a formázási fájlok teljes vagy abszolút elérési útjának kell lennie.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-FunctionDefinitions
Hozzáadja a megadott függvényeket a szerepkör-képességet elérhetővé tevő szekciókhoz. Adjon meg egy kivonattáblát a következő kulcsokkal:
- Név. A függvény neve. Ez a kulcs szükséges.
- ScriptBlock. Funkció test. Adjon meg egy szkriptblokkot. Ez a kulcs szükséges.
- Beállítások. Funkció opciók. Ez a kulcs nem kötelező. Az alapértelmezett érték Nincs. A paraméter elfogadható értékei a következők: None, ReadOnly, Constant, Private vagy AllScope.
Például:
@{Name="Get-PowerShellProcess";ScriptBlock={Get-Process powershell};Options="AllScope"}
Paramétertulajdonságok
| Típus: | |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Guid
Megadja a szerepkör-képességfájl egyedi azonosítóját. Ha kihagyja ezt a paramétert, New-PSRoleCapabilityFile létrehoz egy GUID-t a fájlhoz. Ha új GUID-t szeretne létrehozni a PowerShellben, írja be a [guid]::NewGuid().
Paramétertulajdonságok
| Típus: | Guid |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ModulesToImport
Megadja azokat a modulokat, amelyeket a rendszer automatikusan importál a szerepkör-képességfájlt használó munkamenetekbe. Alapértelmezés szerint a felsorolt modulok összes parancsa látható. A VisibleCmdlets vagy a VisibleFunctions használatával a megadott modulokból látható parancsok korlátozhatók.
A paraméter értékében használt minden modult karakterlánc vagy kivonattábla ábrázolhat. A modul sztring csak a modul nevéből áll. A modulkivonattáblák tartalmazhatnak ModuleName, ModuleVersionés GUID kulcsokat. Csak a ModuleName kulcs szükséges.
A következő érték például egy sztringből és egy kivonattáblából áll. A sztringek és kivonattáblák tetszőleges kombinációja bármilyen sorrendben érvényes.
"TroubleshootingPack", @{ModuleName="PSDiagnostics"; ModuleVersion="1.0.0.0";GUID="c61d6278-02a3-4618-ae37-a524d40a7f44"}
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Path
Megadja a szerepkör-képességfájl elérési útját és fájlnevét. A fájlnak fájlnévkiterjesztéssel kell rendelkeznie .psrc .
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 0 |
| Kötelező: | True |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ScriptsToProcess
Megadja a szerepkör-képességfájlt használó munkamenetekhez hozzáadandó parancsfájlokat. Adja meg a szkriptek elérési útját és fájlneveit. Ennek a paraméternek az értékének a szkriptfájlnevek teljes vagy abszolút elérési útjának kell lennie.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-TypesToProcess
Megadja a szerepkör-képességfájlt használó munkamenetekhez hozzáadni kívánt típusfájlokat (.ps1xml). Adja meg a típusfájlneveket. Ennek a paraméternek az értékének a fájlnevek típus teljes vagy abszolút elérési útjának kell lennie.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VariableDefinitions
Megadja a szerepkör-képességfájlt használó munkamenetekhez hozzáadandó változókat. Adjon meg egy kivonattáblát a következő kulcsokkal:
- Név. A változó neve. Ez a kulcs szükséges.
- Érték. Változó értéke. Ez a kulcs szükséges.
Például: @{Name="WarningPreference";Value="SilentlyContinue"}
Paramétertulajdonságok
| Típus: | Object |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VisibleAliases
A munkamenet aliasait a paraméter értékében megadott aliasokra, valamint az AliasDefinition paraméterben definiált aliasokra korlátozza. A helyettesítő karakterek támogatottak. Alapértelmezés szerint a PowerShell-motor által definiált összes alias és a modulok által exportált összes alias látható a munkamenetben.
Például a rendelkezésre álló álnevek gm-re és gcm-re való korlátozásához használja a következő szintaxist: VisibleAliases="gcm", "gp"
Ha a szerepkör-képességfájlban bármilyen látható paraméter szerepel, a PowerShell eltávolítja a Import-Module parancsmagot és annak ipmo aliasát a munkamenetből.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VisibleCmdlets
A munkamenet parancsmagjait a paraméter értékében megadottakra korlátozza. A helyettesítő karakterek és a modul minősített nevei támogatottak.
Alapértelmezés szerint a munkamenet által exportált modulok összes parancsmagja látható a munkamenetben. A SessionType és ModulesToImport paraméterekkel határozza meg, hogy mely modulok és beépülő modulok legyenek importálva a munkamenetbe. Ha a ModulesToImport egyik modulja sem teszi elérhetővé a parancsmagot, New-PSRoleCapabilityFile megpróbálja betölteni a megfelelő modult.
Ha Látható paraméter szerepel a munkamenet-konfigurációs fájlban, a PowerShell eltávolítja a Import-Module parancsmagot és annak ipmo aliasát a munkamenetből.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VisibleExternalCommands
A munkamenetben végrehajtható külső bináris fájlokat, szkripteket és parancsokat a paraméter értékében megadottakra korlátozza.
Alapértelmezés szerint ebben a munkamenetben nem láthatók külső parancsok.
Ha Látható paraméter szerepel a munkamenet-konfigurációs fájlban, a PowerShell eltávolítja a Import-Module parancsmagot és annak ipmo aliasát a munkamenetből.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VisibleFunctions
A szekció függvényeit a paraméter értékében megadottakra, valamint a FunctionDefinitions paraméterben definiált függvényekre korlátozza. A helyettesítő karakterek támogatottak.
Alapértelmezés szerint a szekcióban lévő modulok által exportált összes függvény látható az adott munkamenetben. A SessionType és ModulesToImport paraméterekkel határozza meg, hogy mely modulokat importálja a munkamenetbe.
Ha Látható paraméter szerepel a munkamenet-konfigurációs fájlban, a PowerShell eltávolítja a Import-Module parancsmagot és annak ipmo aliasát a munkamenetből.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-VisibleProviders
A munkamenet PowerShell-szolgáltatóinak korlátozása a paraméter értékében megadottakra. A helyettesítő karakterek támogatottak.
Alapértelmezés szerint a munkamenet egy modulja által exportált összes szolgáltató látható a munkamenetben. A SessionType és ModulesToImport paraméterekkel határozza meg, hogy mely modulokat importálja a munkamenetbe.
Ha Látható paraméter szerepel a munkamenet-konfigurációs fájlban, a PowerShell eltávolítja a Import-Module parancsmagot és annak ipmo aliasát a munkamenetből.
Paramétertulajdonságok
| Típus: | String[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
