New-PSRoleCapabilityFile

Syntaxis

Default (Standaard)

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

Voorbeelden

Voorbeeld 1: Een leeg functiebestand maken

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

Voorbeeld 2: Een functiemogelijkheidsbestand maken waarmee gebruikers services en elke VDI-computer opnieuw kunnen opstarten

$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

Parameters

-AliasDefinitions

Voegt de opgegeven aliassen toe aan sessies die gebruikmaken van het functiemogelijkheidsbestand. Voer een hash-tabel in met de volgende sleutels:

• Naam Naam van de alias. Deze sleutel is vereist.
• Waarde. De opdracht die de alias vertegenwoordigt. Deze sleutel is vereist.
• Beschrijving. Een tekenreeks die de alias beschrijft. Deze sleutel is optioneel.
• Opties. Aliasopties. Deze sleutel is optioneel. De standaardwaarde is Geen. De acceptabele waarden voor deze parameter zijn: None, ReadOnly, Constant, Private of AllScope.

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

Parametereigenschappen

Parametersets

-AssembliesToLoad

Hiermee geeft u de assembly's die moeten worden geladen in de sessies die gebruikmaken van het functiemogelijkheidsbestand.

Parametereigenschappen

Parametersets

-Author

Hiermee geeft u de gebruiker op die het functiebestand voor rollen heeft gemaakt.

Parametereigenschappen

Parametersets

-CompanyName

Identificeert het bedrijf dat het functiebestand heeft gemaakt. De standaardwaarde is Onbekend.

Parametereigenschappen

Parametersets

-Copyright

Hiermee geeft u een copyright op voor het functiefunctiebestand. Als u deze parameter weglaat, genereert New-PSRoleCapabilityFile een copyright-instructie met behulp van de waarde van de parameter Author.

Parametereigenschappen

Parametersets

-Description

Hiermee geeft u een beschrijving voor het functiefunctiebestand.

Parametereigenschappen

Parametersets

-EnvironmentVariables

Hiermee geeft u de omgevingsvariabelen op voor sessies die dit functiemogelijkheidsbestand beschikbaar maken. Voer een hashtabel in waarin de sleutels de namen van de omgevingsvariabelen zijn en de waarden de omgevingsvariabelewaarden zijn.

Bijvoorbeeld: EnvironmentVariables=@{TestShare="\\\\Server01\TestShare"}

Parametereigenschappen

Parametersets

-FormatsToProcess

Hiermee geeft u de opmaakbestanden (.ps1xml) die worden uitgevoerd in sessies die gebruikmaken van het functiebestand voor rollen. De waarde van deze parameter moet een volledig of absoluut pad van de opmaakbestanden zijn.

Parametereigenschappen

Parametersets

-FunctionDefinitions

Voegt de opgegeven functies toe aan sessies die de functiemogelijkheid beschikbaar maken. Voer een hash-tabel in met de volgende sleutels:

• Naam Naam van de functie. Deze sleutel is vereist.
• ScriptBlock. Hoofdtekst van de functie. Voer een scriptblok in. Deze sleutel is vereist.
• Opties. Functieopties. Deze sleutel is optioneel. De standaardwaarde is Geen. De acceptabele waarden voor deze parameter zijn: None, ReadOnly, Constant, Private of AllScope.

Voorbeeld:

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

Parametereigenschappen

Parametersets

-Guid

Hiermee geeft u een unieke id voor het functiemogelijkheidsbestand. Als u deze parameter weglaat, genereert New-PSRoleCapabilityFile een GUID voor het bestand. Als u een nieuwe GUID wilt maken in PowerShell, typt u [guid]::NewGuid().

Parametereigenschappen

Parametersets

-ModulesToImport

Hiermee geeft u de modules op die automatisch worden geïmporteerd in sessies die gebruikmaken van het functiemogelijkheidsbestand. Standaard zijn alle opdrachten in vermelde modules zichtbaar. Wanneer deze worden gebruikt met VisibleCmdlets of VisibleFunctions, kunnen de opdrachten die zichtbaar zijn vanuit de opgegeven modules worden beperkt.

Elke module die wordt gebruikt in de waarde van deze parameter, kan worden vertegenwoordigd door een tekenreeks of een hash-tabel. Een moduletekenreeks bestaat alleen uit de naam van de module. Een module-hashtabel kan ModuleName, ModuleVersionen GUID- sleutels bevatten. Alleen de ModuleName-sleutel is vereist.

De volgende waarde bestaat bijvoorbeeld uit een tekenreeks en een hash-tabel. Elke combinatie van tekenreeksen en hashtabellen, in elke volgorde, is geldig.

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

Parametereigenschappen

Parametersets

-Path

Hiermee geeft u het pad en de bestandsnaam van het functiemogelijkheidsbestand. Het bestand moet een .psrc bestandsnaamextensie hebben.

Parametereigenschappen

Parametersets

-ScriptsToProcess

Hiermee geeft u scripts toe te voegen aan sessies die gebruikmaken van het functiemogelijkheidsbestand. Voer het pad en de bestandsnamen van de scripts in. De waarde van deze parameter moet een volledig of absoluut pad van de bestandsnamen van het script zijn.

Parametereigenschappen

Parametersets

-TypesToProcess

Hiermee geeft u typebestanden (.ps1xml) toe te voegen aan sessies die gebruikmaken van het functiemogelijkheidsbestand. Voer de bestandsnaam van het type in. De waarde van deze parameter moet een volledig of absoluut pad van het type bestandsnamen zijn.

Parametereigenschappen

Parametersets

-VariableDefinitions

Hiermee geeft u variabelen op die moeten worden toegevoegd aan sessies die gebruikmaken van het functiemogelijkheidsbestand. Voer een hash-tabel in met de volgende sleutels:

• Naam Naam van de variabele. Deze sleutel is vereist.
• Waarde. Variabele waarde. Deze sleutel is vereist.

Bijvoorbeeld: @{Name="WarningPreference";Value="SilentlyContinue"}

Parametereigenschappen

Parametersets

-VisibleAliases

Beperkt de aliassen in de sessie tot die aliassen die zijn opgegeven in de waarde van deze parameter, plus aliassen die u in de parameter AliasDefinition definieert. Jokertekens worden ondersteund. Standaard zijn alle aliassen die zijn gedefinieerd door de PowerShell-engine en alle aliassen die door modules worden geëxporteerd, zichtbaar in de sessie.

Als u bijvoorbeeld de beschikbare aliassen wilt beperken tot gm en gcm, gebruikt u deze syntaxis: VisibleAliases="gcm", "gp"

Wanneer een parameter Visible is opgenomen in het functiebestand, verwijdert PowerShell de Import-Module cmdlet en de bijbehorende ipmo alias uit de sessie.

Parametereigenschappen

Parametersets

-VisibleCmdlets

Hiermee beperkt u de cmdlets in de sessie tot de cmdlets die zijn opgegeven in de waarde van deze parameter. Jokertekens en module gekwalificeerde namen worden ondersteund.

Standaard zijn alle cmdlets die de modules in de sessieexport zichtbaar zijn in de sessie. Gebruik de parameters SessionType en ModulesToImport om te bepalen welke modules en modules in de sessie worden geïmporteerd. Als er geen modules in ModulesToImport beschikbaar stellen, probeert New-PSRoleCapabilityFile de juiste module te laden.

Wanneer een parameter Visible is opgenomen in het sessieconfiguratiebestand, verwijdert PowerShell de Import-Module cmdlet en de bijbehorende ipmo alias uit de sessie.

Parametereigenschappen

Parametersets

-VisibleExternalCommands

Hiermee beperkt u de externe binaire bestanden, scripts en opdrachten die in de sessie kunnen worden uitgevoerd tot de bestanden die zijn opgegeven in de waarde van deze parameter.

Standaard zijn er geen externe opdrachten zichtbaar in deze sessie.

Wanneer een parameter Visible is opgenomen in het sessieconfiguratiebestand, verwijdert PowerShell de Import-Module cmdlet en de bijbehorende ipmo alias uit de sessie.

Parametereigenschappen

Parametersets

-VisibleFunctions

Beperkt de functies in de sessie tot de functies die zijn opgegeven in de waarde van deze parameter, plus functies die u definieert in de parameter FunctionDefinitions. Jokertekens worden ondersteund.

Standaard zijn alle functies die door modules in de sessie worden geëxporteerd, zichtbaar in die sessie. Gebruik de parameters SessionType en ModulesToImport om te bepalen welke modules in de sessie worden geïmporteerd.

Wanneer een parameter Visible is opgenomen in het sessieconfiguratiebestand, verwijdert PowerShell de Import-Module cmdlet en de bijbehorende ipmo alias uit de sessie.

Parametereigenschappen

Parametersets

-VisibleProviders

Hiermee beperkt u de PowerShell-providers in de sessie tot de providers die zijn opgegeven in de waarde van deze parameter. Jokertekens worden ondersteund.

Standaard zijn alle providers die door een module in de sessie worden geëxporteerd, zichtbaar in de sessie. Gebruik de parameters SessionType en ModulesToImport om te bepalen welke modules in de sessie worden geïmporteerd.

Wanneer een parameter Visible is opgenomen in het sessieconfiguratiebestand, verwijdert PowerShell de Import-Module cmdlet en de bijbehorende ipmo alias uit de sessie.

Parametereigenschappen

Parametersets

CommonParameters

Verwante koppelingen

• New-PSSessionConfigurationFile
• Get-PSSessionCapability