ค้นหาเว็บไซต์

Update-Help (Microsoft.PowerShell.Core)

Update-Help

โมดูล :
Microsoft.PowerShell.Core

ดาวน์โหลดและติดตั้งไฟล์วิธีใช้ใหม่ล่าสุดบนคอมพิวเตอร์ของคุณ

ไวยากรณ์

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-SourcePath] <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-Scope <UpdateHelpScope>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-Scope <UpdateHelpScope>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

คำอธิบาย

Update-Help cmdlet จะดาวน์โหลดไฟล์วิธีใช้ใหม่ล่าสุดสำหรับโมดูล PowerShell และติดตั้งลงในคอมพิวเตอร์ของคุณ คุณไม่จำเป็นต้องรีสตาร์ท PowerShell เพื่อให้การเปลี่ยนแปลงมีผล คุณสามารถใช้ Get-Help cmdlet เพื่อดูไฟล์วิธีใช้ใหม่ได้ทันที

Update-Help ตรวจสอบเวอร์ชันของไฟล์วิธีใช้บนคอมพิวเตอร์ของคุณ หากคุณไม่มีไฟล์วิธีใช้สำหรับโมดูลหรือหากไฟล์วิธีใช้ของคุณล้าสมัย Update-Help จะดาวน์โหลดไฟล์วิธีใช้ใหม่ล่าสุด ไฟล์วิธีใช้สามารถดาวน์โหลดและติดตั้งได้จากอินเทอร์เน็ตหรือการแชร์ไฟล์

หากไม่มีพารามิเตอร์ Update-Help จะอัปเดตไฟล์วิธีใช้สำหรับโมดูลที่รองรับวิธีใช้ที่อัปเดตได้และโหลดในเซสชันหรือติดตั้งในตำแหน่งที่รวมอยู่ใน $env:PSModulePath สำหรับข้อมูลเพิ่มเติม โปรดดูที่ about_Updatable_Help

Update-Help ตรวจสอบเวอร์ชันของวิธีใช้ที่ติดตั้ง หาก Update-Help ไม่พบไฟล์วิธีใช้ที่อัปเดตสำหรับโมดูล ไฟล์นั้นจะดำเนินต่อไปโดยไม่แสดงข้อความแสดงข้อผิดพลาด ใช้พารามิเตอร์ บังคับ เพื่อข้ามการตรวจสอบเวอร์ชัน ใช้พารามิเตอร์ Verbose เพื่อดูสถานะและรายละเอียดความคืบหน้า ใช้พารามิเตอร์ โมดูล เพื่ออัปเดตไฟล์วิธีใช้สำหรับโมดูลใดโมดูลหนึ่ง

คุณยังสามารถใช้ Update-Help บนคอมพิวเตอร์ที่ไม่ได้เชื่อมต่อกับอินเทอร์เน็ต ขั้นแรก ให้ใช้ Save-Helpcmdlet เพื่อดาวน์โหลดไฟล์วิธีใช้จากอินเทอร์เน็ต และบันทึกไว้ในโฟลเดอร์แชร์ที่ระบบไม่ได้เชื่อมต่อกับอินเทอร์เน็ตสามารถเข้าถึงได้ จากนั้นใช้พารามิเตอร์ SourcePath ของ Update-Help เพื่อดาวน์โหลดไฟล์วิธีใช้ที่อัปเดตจากที่แชร์ และติดตั้งลงในคอมพิวเตอร์

Update-Help cmdlet ถูกนำมาใช้ใน Windows PowerShell 3.0

มันเป็นสิ่งสำคัญ

Update-Help ต้องใช้สิทธิ์ผู้ดูแลระบบใน PowerShell 6.0 และต่ำกว่า PowerShell 6.1 และสูงกว่าตั้งค่าเริ่มต้น ขอบเขต เป็น CurrentUser ก่อน PowerShell 6.1 พารามิเตอร์ ขอบเขต ไม่พร้อมใช้งาน

คุณต้องเป็นสมาชิกของกลุ่มผู้ดูแลระบบบนคอมพิวเตอร์เพื่ออัปเดตไฟล์วิธีใช้สำหรับโมดูล PowerShell หลัก

หากต้องการดาวน์โหลดหรืออัปเดตไฟล์วิธีใช้สำหรับโมดูลในไดเร็กทอรีการติดตั้ง PowerShell ($PSHOME\Modules) รวมถึงโมดูล PowerShell Core ให้เริ่ม PowerShell โดยใช้ตัวเลือก Run as administrator ตัวอย่างเช่น: Start-Process pwsh.exe -Verb RunAs

ตัวอย่าง

ตัวอย่างที่ 1: อัปเดตไฟล์วิธีใช้สำหรับโมดูลทั้งหมด

cmdlet Update-Help อัปเดตไฟล์วิธีใช้สำหรับโมดูลที่ติดตั้งซึ่งสนับสนุนวิธีใช้ที่อัปเดตได้ ภาษาวัฒนธรรมอินเทอร์เฟซผู้ใช้ (UI) ได้รับการตั้งค่าในระบบปฏิบัติการ

Update-Help

ตัวอย่างที่ 2: อัปเดตไฟล์วิธีใช้สำหรับโมดูลที่ระบุ

Update-Help cmdlet อัปเดตไฟล์ช่วยเหลือสำหรับชื่อโมดูลที่ขึ้นต้นด้วย Microsoft.PowerShell เท่านั้น

Update-Help -Module Microsoft.PowerShell*

ตัวอย่างที่ 3: การอัปเดตความช่วยเหลือบนระบบที่ไม่ได้ตั้งค่าเป็นภาษา en-US

Update-Help cmdlet ได้รับการออกแบบมาเพื่อดาวน์โหลดความช่วยเหลือในหลายภาษา อย่างไรก็ตาม เมื่อไม่มีความช่วยเหลือสำหรับภาษาที่ระบบของคุณใช้ ข้อความแสดงข้อผิดพลาดจะปรากฏขึ้นสำหรับโมดูลและวัฒนธรรม UI

ในตัวอย่างนี้ Update-Help กำลังทำงานบนระบบที่ตั้งค่าเป็นภาษา en-GB

Update-Help Microsoft.PowerShell.Utility -Force

Update-Help: Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with
UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a culture
from the following list: {en-US}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.

ไฟล์วิธีใช้จะถูกเผยแพร่สำหรับภาษา en-US เสมอ หากต้องการดาวน์โหลดวิธีใช้ภาษาอังกฤษ ให้เรียกใช้ Update-Help ด้วยพารามิเตอร์ UICulture และระบุภาษา en-US

ตัวอย่างที่ 4: อัปเดตไฟล์วิธีใช้บนคอมพิวเตอร์หลายเครื่องจากการแชร์ไฟล์

ในตัวอย่างนี้ ไฟล์วิธีใช้ที่อัปเดตจะถูกดาวน์โหลดจากอินเทอร์เน็ตและบันทึกไว้ในการแชร์ไฟล์ จำเป็นต้องมีข้อมูลประจำตัวผู้ใช้ที่มีสิทธิ์ในการเข้าถึงการแชร์ไฟล์และติดตั้งการอัปเดต เมื่อใช้การแชร์ไฟล์ คุณสามารถอัปเดตคอมพิวเตอร์ที่อยู่หลังไฟร์วอลล์หรือไม่ได้เชื่อมต่อกับอินเทอร์เน็ตได้

Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
     Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}

คำสั่ง Save-Help จะดาวน์โหลดไฟล์วิธีใช้ใหม่ล่าสุดสำหรับโมดูลทั้งหมดที่สนับสนุนวิธีใช้ที่อัปเดตได้ พารามิเตอร์ DestinationPath จะบันทึกไฟล์ในการแชร์ไฟล์ \\Server01\Share\PSHelp พารามิเตอร์ ข้อมูลรับรอง ระบุผู้ใช้ที่มีสิทธิ์เข้าถึงพื้นที่แชร์ไฟล์

Invoke-Command cmdlet เรียกใช้คำสั่ง Update-Help ระยะไกลบนคอมพิวเตอร์หลายเครื่อง พารามิเตอร์ ComputerName รับรายการคอมพิวเตอร์ระยะไกลจากไฟล์ Servers.txt พารามิเตอร์ ScriptBlock รันคำสั่ง Update-Help และใช้พารามิเตอร์ SourcePath เพื่อระบุพื้นที่แชร์ไฟล์ที่มีไฟล์วิธีใช้ที่อัปเดต พารามิเตอร์ ข้อมูลรับรอง ระบุผู้ใช้ที่สามารถเข้าถึงพื้นที่แชร์ไฟล์และเรียกใช้คำสั่ง Update-Help ระยะไกล

ตัวอย่างที่ 5: รับรายการไฟล์วิธีใช้ที่อัปเดต

cmdlet Update-Help อัปเดตความช่วยเหลือสำหรับโมดูลที่ระบุ cmdlet ใช้พารามิเตอร์ทั่วไป Verbose เพื่อแสดงรายการไฟล์วิธีใช้ที่ได้รับการอัปเดต คุณสามารถใช้ Verbose เพื่อดูผลลัพธ์ของไฟล์วิธีใช้ทั้งหมดหรือไฟล์วิธีใช้สำหรับโมดูลเฉพาะ

หากไม่มีพารามิเตอร์ Verbose Update-Help จะไม่แสดงผลลัพธ์ของคำสั่ง เอาต์พุตพารามิเตอร์ Verbose มีประโยชน์ในการตรวจสอบว่าไฟล์วิธีใช้ได้รับการอัปเดตหรือมีการติดตั้งเวอร์ชันล่าสุดหรือไม่

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

ตัวอย่างที่ 6: ค้นหาโมดูลที่รองรับวิธีใช้ที่อัปเดตได้

ตัวอย่างนี้แสดงรายการโมดูลที่รองรับวิธีใช้ที่อัปเดตได้ คำสั่งใช้คุณสมบัติ HelpInfoUri ของโมดูลเพื่อระบุโมดูลที่สนับสนุนวิธีใช้ที่อัปเดตได้ คุณสมบัติ HelpInfoUri ประกอบด้วย URL ที่ถูกเปลี่ยนเส้นทางเมื่อมีการเรียกใช้ cmdlet Update-Help

Get-Module -ListAvailable | Where-Object -Property HelpInfoUri

Directory: C:\program files\powershell\6\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   6.1.0.0    CimCmdlets                          Core      {Get-CimAssociatedInstance... }
Manifest   1.2.2.0    Microsoft.PowerShell.Archive        Desk      {Compress-Archive... }
Manifest   6.1.0.0    Microsoft.PowerShell.Diagnostics    Core      {Get-WinEvent, New-WinEvent}

    Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules

ModuleType Version    Name                                PSEdition ExportedCommands
---------- -------    ----                                --------- ----------------
Manifest   2.0.1.0    Appx                                Core,Desk {Add-AppxPackage, ... }
Script     1.0.0.0    AssignedAccess                      Core,Desk {Clear-AssignedAccess, ... }
Manifest   1.0.0.0    BitLocker                           Core,Desk {Unlock-BitLocker, ... }

ตัวอย่างที่ 7: ไฟล์วิธีใช้ที่อัพเดตสินค้าคงคลัง

ในตัวอย่างนี้ สคริปต์ Get-UpdateHelpVersion.ps1 จะสร้างรายการไฟล์วิธีใช้ที่อัปเดตได้สำหรับแต่ละโมดูลและหมายเลขเวอร์ชัน

สคริปต์ระบุโมดูลที่สนับสนุนวิธีใช้ที่อัปเดตได้โดยใช้คุณสมบัติ HelpInfoUri ของโมดูล สำหรับโมดูลที่รองรับวิธีใช้ที่อัปเดตได้ สคริปต์จะค้นหาและแยกวิเคราะห์ไฟล์ข้อมูลวิธีใช้ (*helpinfo.xml) เพื่อค้นหาหมายเลขเวอร์ชันล่าสุด

สคริปต์ใช้คลาส PSCustomObject และตารางแฮชเพื่อสร้างออบเจ็กต์เอาต์พุตแบบกำหนดเอง

# Get-UpdateHelpVersion.ps1
Param(
    [parameter(Mandatory=$False)]
    [String[]]
    $Module
)
$HelpInfoNamespace = @{helpInfo='http://schemas.microsoft.com/powershell/help/2010/05'}

if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }

foreach ($mModule in $Modules)
{
    $mDir = $mModule.ModuleBase

    if (Test-Path $mdir\*helpinfo.xml)
    {
        $mName=$mModule.Name
        $mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
            Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
        foreach ($mNode in $mNodes)
        {
            $mCulture=$mNode.Node.UICultureName
            $mVer=$mNode.Node.UICultureVersion

            [PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
        }
    }
}

ModuleName                              Culture                                 Version
----------                              -------                                 -------
ActiveDirectory                         en-US                                   3.0.0.0
ADCSAdministration                      en-US                                   3.0.0.0
ADCSDeployment                          en-US                                   3.0.0.0
ADDSDeployment                          en-US                                   3.0.0.0
ADFS                                    en-US                                   3.0.0.0

พารามิเตอร์

-Confirm

แจ้งให้คุณยืนยันก่อนเรียกใช้ cmdlet

พิมพ์ :

SwitchParameter

นามแฝง :

cf

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

False

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-Credential

ระบุข้อมูลรับรองของผู้ใช้ที่มีสิทธิ์เข้าถึงตำแหน่งระบบไฟล์ที่ระบุโดย SourcePath พารามิเตอร์นี้ใช้ได้เฉพาะเมื่อมีการใช้พารามิเตอร์ SourcePath หรือ LiteralPath ในคำสั่ง

พารามิเตอร์ ข้อมูลรับรอง ช่วยให้คุณสามารถเรียกใช้คำสั่ง Update-Help ด้วยพารามิเตอร์ SourcePath บนคอมพิวเตอร์ระยะไกล ด้วยการให้ข้อมูลประจำตัวที่ชัดเจน คุณสามารถเรียกใช้คำสั่งบนคอมพิวเตอร์ระยะไกลและเข้าถึงการแชร์ไฟล์บนคอมพิวเตอร์เครื่องที่สามโดยไม่ต้องพบกับข้อผิดพลาดที่ถูกปฏิเสธการเข้าถึง หรือใช้การรับรองความถูกต้อง CredSSP เพื่อมอบหมายข้อมูลประจำตัว

พิมพ์ชื่อผู้ใช้ เช่น User01 หรือ Domain01\User01 หรือป้อนวัตถุ PSCredential ที่สร้างโดย Get-Credential รหัส> cmdlet. หากคุณพิมพ์ชื่อผู้ใช้ คุณจะได้รับแจ้งให้ป้อนรหัสผ่าน

ข้อมูลประจำตัวจะถูกจัดเก็บไว้ในวัตถุ PSCredential และรหัสผ่านจะถูกจัดเก็บเป็น SecureString

บันทึก

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการปกป้องข้อมูล SecureString โปรดดู SecureString มีความปลอดภัยเพียงใด

พิมพ์ :

PSCredential

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

ผู้ใช้ปัจจุบัน

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-Force

บ่งชี้ว่า cmdlet นี้ไม่เป็นไปตามข้อจำกัดวันละครั้ง ข้ามการตรวจสอบเวอร์ชัน และดาวน์โหลดไฟล์ที่เกินขีดจำกัด 1 GB

หากไม่มีพารามิเตอร์นี้ Update-Help จะทำงานเพียงครั้งเดียวในช่วงเวลา 24 ชั่วโมงแต่ละช่วง การดาวน์โหลดจะถูกจำกัดเนื้อหาที่ไม่มีการบีบอัดไว้ที่ 1 GB ต่อโมดูล และไฟล์วิธีใช้จะถูกติดตั้งเมื่อไฟล์เหล่านั้นใหม่กว่าไฟล์ที่มีอยู่ในคอมพิวเตอร์เท่านั้น

การจำกัดวันละครั้งจะปกป้องเซิร์ฟเวอร์ที่โฮสต์ไฟล์วิธีใช้ และทำให้คุณสามารถเพิ่มคำสั่ง Update-Help ลงในโปรไฟล์ PowerShell ของคุณได้จริง โดยไม่ทำให้เกิดต้นทุนทรัพยากรของการเชื่อมต่อหรือการดาวน์โหลดซ้ำๆ

หากต้องการอัปเดตความช่วยเหลือสำหรับโมดูลในหลายวัฒนธรรม UI โดยไม่มีพารามิเตอร์ Force ให้รวมวัฒนธรรม UI ทั้งหมดในคำสั่งเดียวกัน เช่น:

Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
พิมพ์ :

SwitchParameter

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-FullyQualifiedModule

ค่าอาจเป็นชื่อโมดูล ข้อมูลจำเพาะของโมดูลแบบเต็ม หรือเส้นทางไปยังไฟล์โมดูล

เมื่อค่าเป็นเส้นทาง เส้นทางสามารถมีคุณสมบัติครบถ้วนหรือสัมพันธ์กันได้ เส้นทางสัมพัทธ์ได้รับการแก้ไขโดยสัมพันธ์กับสคริปต์ที่มีคำสั่งการใช้งาน

เมื่อค่าเป็นชื่อหรือข้อกำหนดเฉพาะของโมดูล PowerShell จะค้นหา PSModulePath สำหรับโมดูลที่ระบุ

ข้อมูลจำเพาะของโมดูลคือแฮชเทเบิลที่มีคีย์ดังต่อไปนี้

  • ModuleName - จำเป็น ระบุชื่อโมดูล
  • GUID - เป็นทางเลือก ระบุ GUID ของโมดูล

  • นอกจากนี้ จำเป็น จะต้องระบุอย่างน้อยหนึ่งในสามคีย์ด้านล่าง

    • ModuleVersion - ระบุเวอร์ชันขั้นต่ำที่ยอมรับได้ของโมดูล
    • MaximumVersion - ระบุเวอร์ชันสูงสุดที่ยอมรับได้ของโมดูล
    • RequiredVersion - ระบุเวอร์ชันที่จำเป็นและแน่นอนของโมดูล ไม่สามารถใช้กับคีย์เวอร์ชันอื่นได้

คุณไม่สามารถระบุพารามิเตอร์ FullyQualifiedModule ในคำสั่งเดียวกันกับพารามิเตอร์ Module

พิมพ์ :

ข้อมูลจำเพาะของโมดูล[]

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

True

ยอมรับอักขระตัวแทน:

False

-LiteralPath

ระบุโฟลเดอร์สำหรับไฟล์วิธีใช้ที่อัปเดต แทนที่จะดาวน์โหลดจากอินเทอร์เน็ต ใช้พารามิเตอร์นี้หรือ SourcePath หากคุณใช้ cmdlet Save-Help เพื่อดาวน์โหลดไฟล์วิธีใช้ไปยังไดเร็กทอรี

คุณสามารถไปป์ไลน์ออบเจ็กต์ไดเรกทอรี เช่น จาก cmdlets Get-Item หรือ Get-ChildItem ไปยัง Update-Help

ต่างจากค่าของ SourcePath ค่าของ LiteralPath จะถูกใช้ตรงตามที่พิมพ์ทุกประการ ไม่มีอักขระใดที่ถูกตีความว่าเป็นอักขระตัวแทน หากเส้นทางมีอักขระเลี่ยง ให้ใส่เครื่องหมายคำพูดเดี่ยว เครื่องหมายคำพูดเดี่ยวบอกให้ PowerShell ไม่ต้องตีความอักขระใดๆ เป็นลำดับหลีก

พิมพ์ :

String[]

นามแฝง :

PSPath, LP

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

True

ยอมรับอักขระตัวแทน:

False

-Module

อัปเดตความช่วยเหลือสำหรับโมดูลที่ระบุ ป้อนชื่อโมดูลหรือรูปแบบชื่ออย่างน้อยหนึ่งชื่อในรายการที่คั่นด้วยเครื่องหมายจุลภาค หรือระบุไฟล์ที่แสดงชื่อโมดูลหนึ่งชื่อในแต่ละบรรทัด อนุญาตให้ใช้อักขระตัวแทนได้ คุณสามารถไปป์ไลน์โมดูลจาก Get-Module cmdlet ไปยัง Update-Help cmdlet

โมดูลที่คุณระบุจะต้องได้รับการติดตั้งบนคอมพิวเตอร์ แต่ไม่จำเป็นต้องนำเข้าไปยังเซสชันปัจจุบัน คุณสามารถระบุโมดูลใดๆ ในเซสชันหรือโมดูลใดๆ ที่ติดตั้งในตำแหน่งที่แสดงอยู่ในตัวแปรสภาพแวดล้อม $env:PSModulePath

ค่า * (ทั้งหมด) พยายามปรับปรุงวิธีใช้สำหรับโมดูลทั้งหมดที่ติดตั้งบนคอมพิวเตอร์ มีโมดูลที่ไม่รองรับวิธีใช้ที่อัปเดตได้รวมอยู่ด้วย ค่านี้อาจสร้างข้อผิดพลาดเมื่อคำสั่งพบโมดูลที่ไม่รองรับวิธีใช้ที่อัปเดตได้ ให้เรียกใช้ Update-Help โดยไม่มีพารามิเตอร์แทน

พารามิเตอร์ โมดูล ของ Update-Help cmdlet ไม่ยอมรับเส้นทางแบบเต็มของไฟล์โมดูลหรือไฟล์รายการโมดูล หากต้องการอัปเดตความช่วยเหลือสำหรับโมดูลที่ไม่ได้อยู่ในตำแหน่ง $env:PSModulePath ให้นำเข้าโมดูลไปยังเซสชันปัจจุบันก่อนที่คุณจะรันคำสั่ง Update-Help

พิมพ์ :

String[]

นามแฝง :

Name

ตำแหน่ง:

0

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

True

ยอมรับอักขระตัวแทน:

True

-Recurse

ดำเนินการค้นหาไฟล์วิธีใช้แบบเรียกซ้ำในไดเร็กทอรีที่ระบุ พารามิเตอร์นี้ใช้ได้เฉพาะเมื่อคำสั่งใช้พารามิเตอร์ SourcePath

พิมพ์ :

SwitchParameter

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-Scope

ระบุขอบเขตของระบบที่มีการอัพเดตวิธีใช้ การอัปเดตที่ขอบเขต ผู้ใช้ทั้งหมด ต้องใช้สิทธิ์ผู้ดูแลระบบบนระบบ Windows พารามิเตอร์ -Scope ถูกนำมาใช้ใน PowerShell Core เวอร์ชัน 6.1

CurrentUser เป็นขอบเขตเริ่มต้นสำหรับไฟล์วิธีใช้ใน PowerShell 6.1 ขึ้นไป ผู้ใช้ทั้งหมด สามารถระบุเพื่อติดตั้งหรืออัปเดตความช่วยเหลือสำหรับผู้ใช้ทั้งหมดได้ ในระบบ Unix จำเป็นต้องมีสิทธิ์ sudo เพื่ออัปเดตความช่วยเหลือสำหรับผู้ใช้ทุกคน ตัวอย่างเช่น: sudo pwsh -c Update-Help

ค่าที่ยอมรับได้คือ:

  • CurrentUser
  • AllUsers
พิมพ์ :

อัพเดต HelpScope

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

CurrentUser

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

True

ยอมรับอักขระตัวแทน:

False

-SourcePath

ระบุโฟลเดอร์ระบบไฟล์ที่ Update-Help ได้รับไฟล์วิธีใช้ที่อัปเดต แทนที่จะดาวน์โหลดจากอินเทอร์เน็ต ป้อนเส้นทางของโฟลเดอร์ อย่าระบุชื่อไฟล์หรือนามสกุลไฟล์ คุณสามารถไปป์ไลน์โฟลเดอร์ เช่น โฟลเดอร์จาก Get-Item หรือ Get-ChildItem cmdlets ไปยัง Update-Help

ตามค่าเริ่มต้น Update-Help จะดาวน์โหลดไฟล์วิธีใช้ที่อัปเดตจากอินเทอร์เน็ต ใช้ SourcePath เมื่อคุณใช้ cmdlet Save-Help เพื่อดาวน์โหลดไฟล์วิธีใช้ที่อัปเดตไปยังไดเร็กทอรี

หากต้องการระบุค่าเริ่มต้นสำหรับ SourcePath ให้ไปที่ นโยบายกลุ่ม, การกำหนดค่าคอมพิวเตอร์ และ ตั้งค่าเส้นทางต้นทางเริ่มต้นสำหรับ Update-Help . การตั้งค่านโยบายกลุ่มนี้ป้องกันไม่ให้ผู้ใช้ใช้ Update-Help เพื่อดาวน์โหลดไฟล์วิธีใช้จากอินเทอร์เน็ต สำหรับข้อมูลเพิ่มเติม โปรดดูที่ about_Group_Policy_Settings

พิมพ์ :

String[]

นามแฝง :

Path

ตำแหน่ง:

1

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-UICulture

ระบุค่าวัฒนธรรม UI ที่ cmdlet นี้ได้รับไฟล์วิธีใช้ที่อัปเดต ป้อนรหัสภาษาอย่างน้อยหนึ่งรหัส เช่น es-ES ตัวแปรที่มีวัตถุวัฒนธรรม หรือคำสั่งที่ได้รับวัตถุวัฒนธรรม เช่น Get-Culture หรือ < รหัส>รับ-UICulture คำสั่ง ไม่อนุญาตให้ใช้อักขระตัวแทน

ตามค่าเริ่มต้น Update-Help จะได้รับไฟล์ความช่วยเหลือในวัฒนธรรม UI ที่ตั้งค่าไว้สำหรับระบบปฏิบัติการหรือวัฒนธรรมทางเลือก หากคุณระบุพารามิเตอร์ UICulture Update-Help จะค้นหาเฉพาะความช่วยเหลือสำหรับภาษาที่ระบุเท่านั้น

เริ่มต้นใน PowerShell 7.4 คุณสามารถใช้รหัสภาษาบางส่วน เช่น en เพื่อดาวน์โหลดวิธีใช้เป็นภาษาอังกฤษสำหรับทุกภูมิภาค

บันทึก

Ubuntu 18.04 เปลี่ยนการตั้งค่าภาษาเริ่มต้นเป็น C.UTF.8 ซึ่งไม่เป็นที่ยอมรับในวัฒนธรรม UI Update-Help ไม่สามารถดาวน์โหลดความช่วยเหลือได้ เว้นแต่คุณจะใช้พารามิเตอร์นี้กับภาษาที่รองรับ เช่น en-US สิ่งนี้อาจเกิดขึ้นได้บนแพลตฟอร์มใด ๆ ที่ใช้ค่าที่ไม่รองรับ

พิมพ์ :

ข้อมูลวัฒนธรรม[]

ตำแหน่ง:

2

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-UseDefaultCredentials

บ่งชี้ว่า Update-Help รันคำสั่ง รวมถึงการดาวน์โหลดทางอินเทอร์เน็ต โดยใช้ข้อมูลประจำตัวของผู้ใช้ปัจจุบัน ตามค่าเริ่มต้น คำสั่งจะทำงานโดยไม่มีข้อมูลประจำตัวที่ชัดเจน

พารามิเตอร์นี้จะมีผลเฉพาะเมื่อการดาวน์โหลดเว็บใช้ NT LAN Manager (NTLM), negotiate หรือการรับรองความถูกต้องแบบ Kerberos

พิมพ์ :

SwitchParameter

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

None

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

-WhatIf

แสดงสิ่งที่จะเกิดขึ้นหาก cmdlet ทำงาน cmdlet ไม่ทำงาน

พิมพ์ :

SwitchParameter

นามแฝง :

wi

ตำแหน่ง:

ตั้งชื่อ

ค่าเริ่มต้น:

False

ที่จำเป็น:

False

ยอมรับอินพุตไปป์ไลน์:

False

ยอมรับอักขระตัวแทน:

False

อินพุต

ข้อมูลไดเรกทอรี

คุณสามารถไปป์วัตถุเส้นทางไดเรกทอรีไปยัง cmdlet นี้

PSModuleInfo

คุณสามารถไปป์วัตถุโมดูลไปที่ cmdlet นี้

เอาท์พุต

ไม่มี

cmdlet นี้ส่งคืนไม่มีผลลัพธ์

หมายเหตุ

หากต้องการอัปเดตความช่วยเหลือสำหรับโมดูล PowerShell หลักที่มีคำสั่งที่ติดตั้งด้วย PowerShell หรือโมดูลใดๆ ในไดเรกทอรี $PSHOME\Modules ให้เริ่ม PowerShell ด้วยตัวเลือกเพื่อ เรียกใช้ในฐานะผู้ดูแลระบบ< /แข็งแกร่ง>.

เฉพาะสมาชิกของกลุ่มผู้ดูแลระบบบนคอมพิวเตอร์เท่านั้นที่สามารถอัปเดตความช่วยเหลือสำหรับโมดูล PowerShell หลัก คำสั่งที่ติดตั้งร่วมกับ PowerShell และสำหรับโมดูลในโฟลเดอร์ $PSHOME\Modules หากคุณไม่ได้รับอนุญาตให้อัปเดตไฟล์วิธีใช้ คุณสามารถอ่านไฟล์วิธีใช้ออนไลน์ได้ ตัวอย่างเช่น Get-Help Update-Help -Online

โมดูลเป็นหน่วยที่เล็กที่สุดของความช่วยเหลือที่สามารถอัพเดตได้ คุณไม่สามารถอัปเดตความช่วยเหลือสำหรับ cmdlet เฉพาะได้ หากต้องการค้นหาโมดูลที่มี cmdlet เฉพาะ ให้ใช้คุณสมบัติ ModuleName ของ Get-Command cmdlet เช่น (Get-Command Update-Help).ModuleName .

เนื่องจากมีการติดตั้งไฟล์วิธีใช้ไว้ในไดเร็กทอรีของโมดูล cmdlet Update-Help จึงสามารถติดตั้งไฟล์วิธีใช้ที่อัปเดตสำหรับโมดูลที่ติดตั้งบนคอมพิวเตอร์เท่านั้น อย่างไรก็ตาม Save-Help cmdlet สามารถบันทึกความช่วยเหลือสำหรับโมดูลที่ไม่ได้ติดตั้งบนคอมพิวเตอร์

Update-Help cmdlet ถูกนำมาใช้ใน Windows PowerShell 3.0 ไม่สามารถใช้งานได้ใน PowerShell เวอร์ชันก่อนหน้า บนคอมพิวเตอร์ที่มีทั้ง Windows PowerShell 2.0 และ Windows PowerShell 3.0 ให้ใช้ Update-Help cmdlet ในเซสชัน Windows PowerShell 3.0 เพื่อดาวน์โหลดและอัปเดตไฟล์วิธีใช้ ไฟล์วิธีใช้มีทั้ง Windows PowerShell 2.0 และ Windows PowerShell 3.0

Update-Help และ Save-Help cmdlet ใช้พอร์ตต่อไปนี้เพื่อดาวน์โหลดไฟล์วิธีใช้: พอร์ต 80 สำหรับ HTTP และพอร์ต 443 สำหรับ HTTPS

Update-Help รองรับโมดูลทั้งหมดและสแน็ปอิน PowerShell หลัก มันไม่รองรับสแนปอินอื่นๆ

หากต้องการอัปเดตความช่วยเหลือสำหรับโมดูลในตำแหน่งที่ไม่อยู่ในตัวแปรสภาพแวดล้อม $env:PSModulePath ให้นำเข้าโมดูลไปยังเซสชันปัจจุบัน จากนั้นเรียกใช้ Update-Help คำสั่ง เรียกใช้ Update-Help โดยไม่มีพารามิเตอร์ หรือใช้พารามิเตอร์ Module เพื่อระบุชื่อโมดูล พารามิเตอร์ โมดูล ของ cmdlets Update-Help และ Save-Help ไม่ยอมรับเส้นทางแบบเต็มของไฟล์โมดูลหรือไฟล์รายการโมดูล

ทุกโมดูลสามารถรองรับ Updateable Help ได้ สำหรับคำแนะนำในการสนับสนุนวิธีใช้ที่อัปเดตได้ในโมดูลที่คุณสร้าง โปรดดูที่ การสนับสนุนวิธีใช้ที่อัปเดตได้

Update-Help และ Save-Help cmdlet ไม่ได้รับการสนับสนุนบน Windows Preinstallation Environment (Windows PE)

บทความที่เกี่ยวข้อง