Stop-PSUDashboard

Synopsis

Stops an app in PowerShell Universal.

Syntax

Stop-PSUDashboard [-AppToken <String>] [-ComputerName <String>] [-Integrated] [-UseDefaultCredentials] [-Credential <PSCredential>] [-TrustCertificate] -App <Dashboard> [<CommonParameters>]

Stop-PSUDashboard [-AppToken <String>] [-ComputerName <String>] [-Integrated] [-UseDefaultCredentials] [-Credential <PSCredential>] [-TrustCertificate] -Name <String> [<CommonParameters>]

Description

Stops an app in PowerShell Universal.

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.

Required?                    false
Position?                    named
Default value                None
Accept pipeline input?       False
Aliases                      none
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.

Required?                    false
Position?                    named
Default value                None
Accept pipeline input?       False
Aliases                      Uri
Accept wildcard characters?  false

-Integrated

Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       False
Aliases                      none
Accept wildcard characters?  false

-UseDefaultCredentials

Use default credentials when connecting to the management API

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       False
Aliases                      none
Accept wildcard characters?  false

-Credential

Credentials to login to the PowerShell Universal Management API.

Required?                    false
Position?                    named
Default value                None
Accept pipeline input?       False
Aliases                      none
Accept wildcard characters?  false

-TrustCertificate

Whether the cmdlet should ignore certificate issues.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       False
Aliases                      none
Accept wildcard characters?  false

-App

The app to stop.

Required?                    true
Position?                    named
Default value                None
Accept pipeline input?       True (ByValue)
Aliases                      Dashboard
Accept wildcard characters?  false

-Name

The name of the app to stop.

Required?                    true
Position?                    named
Default value                None
Accept pipeline input?       True (ByValue)
Aliases                      none
Accept wildcard characters?  false

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Inputs

PowerShellUniversal.Dashboard

Outputs

System.Object

Notes

Examples

Example 1

Get-PSUApp -Name 'MyApp' | Stop-PSUDashboard

Stops the 'MyApp' app in PowerShell Universal.

PERMISSIONS

The access token requires apps/update to run this cmdlet remotely.