Windows PowerShell command on Get-command Publish-Script

NAME

Publish-Script

SYNOPSIS

Publishes a script.

SYNTAX

Publish-Script [-Confirm] [-Credential ] [-Force] -LiteralPath [-NuGetApiKey ]

[-Repository ] [-WhatIf] []

Publish-Script [-Confirm] [-Credential ] [-Force] [-NuGetApiKey ] -Path

[-Repository ] [-WhatIf] []

DESCRIPTION

The Publish-Script cmdlet publishes the specified script to the online gallery.

PARAMETERS

-Confirm []

Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-Credential

@{Text=} Required? false Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Force []

@{Text=} Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false

-LiteralPath

Specifies a path to one or more locations. Unlike the Path parameter, the value of the LiteralPath parameter is used exactly as entered. No characters are interpreted as wildcards. If the path includes escape characters, enclose them in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences. Required? true Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-NuGetApiKey

Specifies the API key that you want to use to publish a script to the online gallery. The API key is part of your profile in the online gallery, and can be found on your user account page in the gallery. The API key is

NuGet-specific functionality.

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

-Path

Specifies a path to one or more locations. Wildcards are permitted. The default location is the current directory (.). Required? true Position? named Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Repository

Specifies the friendly name of a repository that has been registered by running Register-PSRepository.

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

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

Example 1: Create a script file, add content to it, and publish it

PS C:\>New-ScriptFileInfo -Path "D:\ScriptSharingDemo\Demo-Script.ps1" -Version 1.0 -Author "pattif@microsoft.com"

-Description "my test script file description goes here"

PS C:\> Get-Content -Path "D:\ScriptSharingDemo\Demo-Script.ps1"

<#PSScriptInfo .VERSION 1.0 .AUTHOR pattif@microsoft.com

.COMPANYNAME

.COPYRIGHT .TAGS .LICENSEURI .PROJECTURI .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

#> <#

.DESCRIPTION

my test script file description goes here #>

Param() PS C:\>Add-Content -Path "D:\ScriptSharingDemo\Demo-Script.ps1" -Value @"

Function Demo-ScriptFunction { 'Demo-ScriptFunction' }

Workflow Demo-ScriptWorkflow { 'Demo-ScriptWorkflow' }

Demo-ScriptFunction

Demo-ScriptWorkflow

PS C:\> Test-ScriptFileInfo -Path "D:\ScriptSharingDemo\Demo-Script.ps1"

Version Name Author Description

------- ---- ------ -----------

1.0 Demo-Script pattif@microsoft.com my test script file description goes here PS

C:\>Publish-Script -Path "D:\ScriptSharingDemo\Demo-Script.ps1" -Repository "LocalRepo1"

PS C:\> Find-Script -Repository "LocalRepo1" -Name "Demo-Script"

Version Name Type Repository Description

------- ---- ---- ---------- -----------

1.0 Demo-Script Script LocalRepo1 my test script file description

goes here

The first command uses the New-ScriptFileInfo cmdlet to create a script file named Demo-Script.ps1.

The second command uses the Get-Content cmdlet to get the content of Demo-Script.ps1 and display it.

The third command uses the Add-Content cmdlet to add a function and a workflow to Demo-Script.

The fourth command uses the Test-ScriptFileInfo cmdlet to validate Demo-Script and display the results.

The fifth command uses the Publish-Script cmdlet to publish Demo-Script.ps1 to the LocalRepo1 repository and

display the results.

The final command uses the Find-Script cmdlet to find Demo-Script.ps1 in the LocalRepo1 repository.

Publish-Script

Save-Script

Update-Script