New-PSUPublishedFolder
SYNOPSIS
Creates a new published folder in PowerShell Universal.
SYNTAX
New-PSUPublishedFolder -RequestPath <String> -Path <String> [-Authentication] [-Role <String[]>]
[-DefaultDocument <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
[<CommonParameters>]
DESCRIPTION
Creates a new published folder in PowerShell Universal. Published folders allow you to host files in the PowerShell Universal web server. You can optionally configure authentication, authorization and default documents.
EXAMPLES
Example 1
New-PSUPublishedFolder -RequestPath '/images' -Path 'C:\images'
Publishes the images folder to the request path of images. You will be able to download images from this folder by using URLs like: http://localhost:5000/images/myImage.png
Example 2
New-PSUPublishedFolder -RequestPath '/website' -Path 'C:\website' -DefaultDocument "index.html"
Publishes the website folder and sets the default document to index.html. This allows the you to navigate to the URL http://localhost:5000/website and the web server will return the index.html file automatically. This is helpful for static websites.
PARAMETERS
-AppToken
The AppToken that is used for calling the PowerShell Universal Management API. You can also call Connect-PSUServer before calling this cmdlet to set the AppToken for the entire session.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Authentication
Specifies whether authentication is required to view files in this published folder. Authentication requires a Dashboard license.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName
Specifies the computer name or URL that should be called when accessing the PowerShell Universal Management API. You can also use Connect-PSUServer before calling this cmdlet to set the computer name for the entire session.
Type: System.String
Parameter Sets: (All)
Aliases: Uri
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultDocument
The default document to server when visiting the root of this published folder.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
The local file system path.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RequestPath
The HTTP request path.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Role
The role to require when viewing files in this published folder. -Authentication is required when using roles.
Type: System.String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UseDefaultCredentials
Use default credentials when connecting to the management API
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.