forked from PowerShell/JEA
-
Notifications
You must be signed in to change notification settings - Fork 10
JeaRoleCapabilities
dscbot edited this page May 10, 2022
·
1 revision
| Parameter | Attribute | DataType | Description | Allowed Values |
|---|---|---|---|---|
| Ensure | Write | Ensure | Specifies whether the Role Capabilities file should be created or removed (not exist). | |
| Path | Key | string | Where to store the file. | |
| ModulesToImport | Write | string[] | Specifies the modules that are automatically imported into sessions that use the role capability file. By default, all of the commands in listed modules are visible. When used with VisibleCmdlets or VisibleFunctions, the commands visible from the specified modules can be restricted. Hashtable with keys ModuleName, ModuleVersion and GUID. | |
| VisibleAliases | Write | string[] | Limits the aliases in the session to those aliases specified in the value of this parameter, plus any aliases that you define in the AliasDefinition parameter. Wildcard characters are supported. By default, all aliases that are defined by the Windows PowerShell engine and all aliases that modules export are visible in the session. | |
| VisibleCmdlets | Write | string[] | Limits the cmdlets in the session to those specified in the value of this parameter. Wildcard characters and Module Qualified Names are supported. | |
| VisibleFunctions | Write | string[] | Limits the functions in the session to those specified in the value of this parameter, plus any functions that you define in the FunctionDefinitions parameter. Wildcard characters are supported. | |
| VisibleExternalCommands | Write | string[] | Limits the external binaries, scripts and commands that can be executed in the session to those specified in the value of this parameter. Wildcard characters are supported. | |
| VisibleProviders | Write | string[] | Limits the Windows PowerShell providers in the session to those specified in the value of this parameter. Wildcard characters are supported. | |
| ScriptsToProcess | Write | string[] | Specifies scripts to add to sessions that use the role capability file. | |
| AliasDefinitions | Write | string[] | Adds the specified aliases to sessions that use the role capability file. Hashtable with keys Name, Value, Description and Options. | |
| FunctionDefinitions | Write | string[] | Adds the specified functions to sessions that expose the role capability. Hashtable with keys Name, Scriptblock and Options. | |
| VariableDefinitions | Write | string[] | Specifies variables to add to sessions that use the role capability file. Hashtable with keys Name, Value, Options. | |
| EnvironmentVariables | Write | string[] | Specifies the environment variables for sessions that expose this role capability file. Hashtable of environment variables. | |
| TypesToProcess | Write | string[] | Specifies type files (.ps1xml) to add to sessions that use the role capability file. The value of this parameter must be a full or absolute path of the type file names. | |
| FormatsToProcess | Write | string[] | Specifies the formatting files (.ps1xml) that run in sessions that use the role capability file. The value of this parameter must be a full or absolute path of the formatting files. | |
| Description | Write | string | Specifies the assemblies to load into the sessions that use the role capability file. | |
| AssembliesToLoad | Write | string[] | Description of the role. | |
| Reasons | Read | Reason[] | Reasons of why the resource isn't in desired state. |
The JeaRoleCapabilities DSC resource creates the Role Capabilities file in the specified location using the specified settings.