Get-Help (Microsoft.PowerShell.Core)

Ayrıntılı parametresi, yardım makalesinin parametre açıklamalarını ve örneklerini içeren ayrıntılı görünümünü görüntüler.

Tam parametresi, yardım makalesinin parametre açıklamalarını, örnekleri, giriş ve çıkış nesne türlerini ve ek notları içeren tam görünümünü görüntüler.

Ayrıntılı ve Tam parametreleri yalnızca bilgisayarda yüklü yardım dosyaları bulunan komutlar için etkilidir. Parametreler kavramsal (hakkında_) yardım makaleleri için etkili değildir.

Örnek 4: Parametreleri kullanarak bir cmdlet'in seçilen bölümlerini görüntüleme

Bu örnekler, Format-Table cmdlet yardımının seçilen bölümlerini görüntüler.

Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy

Örnekler parametresi, yardım dosyasının AD ve ÖZET bölümlerini ve tüm Örnekleri görüntüler. Örnekler parametresi bir anahtar parametresi olduğundan Örnek numarası belirtemezsiniz.

Parametre parametresi yalnızca belirtilen parametrelerin açıklamalarını görüntüler. Yalnızca yıldız işareti (*) joker karakterini belirtirseniz, tüm parametrelerin açıklamaları görüntülenir. Parametre, GroupBy gibi bir parametre adı belirttiğinde, bu parametreyle ilgili bilgiler gösterilir.

Bu parametreler kavramsal (hakkında_) yardım makaleleri için etkili değildir.

Örnek 5: Yardımın çevrimiçi sürümünü görüntüleyin

Bu örnek, varsayılan web tarayıcınızdaki Format-Table cmdlet'ine ilişkin yardım makalesinin çevrimiçi sürümünü görüntüler.

Get-Help Format-Table -Online

Örnek 6: Yardım sistemiyle ilgili yardımı görüntüleyin

Parametresiz Get-Help cmdlet'i, PowerShell yardım sistemi hakkındaki bilgileri görüntüler.

Get-Help

Örnek 7: Mevcut yardım makalelerini görüntüleyin

Bu örnek, bilgisayarınızda bulunan tüm yardım makalelerinin bir listesini görüntüler.

Get-Help *

Örnek 8: Kavramsal makalelerin listesini görüntüleyin

Bu örnek, PowerShell yardımında yer alan kavramsal makalelerin bir listesini görüntüler. Bu makalelerin tümü about_ karakterleriyle başlar. Belirli bir yardım dosyasını görüntülemek için Get-Help \ yazın, örneğin, Get-Help about_Signing.

Yalnızca bilgisayarınızda yüklü yardım dosyalarının bulunduğu kavramsal makaleler görüntülenir. PowerShell 3,0'da yardım dosyalarını indirme ve yükleme hakkında bilgi için bkz. Güncelleme-Yardım.

Get-Help about_*

Örnek 9: Cmdlet yardımında bir kelime arayın

Bu örnek, bir cmdlet yardım makalesinde bir sözcüğün nasıl aranacağını gösterir.

Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml

the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-Clixml

Get-Help, Üye Ekle için yardım bilgisi almak amacıyla Tam parametresini kullanır. MamlCommandHelpInfo nesnesi ardışık düzene gönderilir. Out-String, nesneyi bir dizeye dönüştürmek için Stream parametresini kullanır. Select-String, dizede Clixml'i aramak için Pattern parametresini kullanır.

Örnek 10: Bir kelimeyi içeren makalelerin listesini görüntüleyin

Bu örnekte uzaktan iletişim kelimesini içeren makalelerin bir listesi görüntülenir.

Herhangi bir makale başlığında görünmeyen bir kelime girdiğinizde, Get-Help bu kelimeyi içeren makalelerin bir listesini görüntüler.

Get-Help -Name remoting

Name                              Category  Module                    Synopsis
----                              --------  ------                    --------
Install-PowerShellRemoting.ps1    External                            Install-PowerShellRemoting.ps1
Disable-PSRemoting                Cmdlet    Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting                 Cmdlet    Microsoft.PowerShell.Core Configures the computer...

Örnek 11: Sağlayıcıya özel yardımı görüntüleyin

Bu örnek, Get-Item için sağlayıcıya özel yardım almanın iki yolunu gösterir. Bu komutlar, PowerShell SQL Server sağlayıcısının DataCollection düğümündeki Get-Item cmdlet'inin nasıl kullanılacağını açıklayan yardım alır.

İlk örnek, SQL Server sağlayıcısının yolunu belirtmek için Get-Help Path parametresini kullanır. Sağlayıcının yolu belirtildiğinden, komutu herhangi bir yol konumundan çalıştırabilirsiniz.

İkinci örnekte SQL Server sağlayıcısının yoluna gitmek için Set-Location kullanılır. Bu konumdan, sağlayıcıya özel yardım almak amacıyla Get-Help için Yol parametresine gerek yoktur.

Get-Help Get-Item -Path SQLSERVER:\DataCollection

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item

NAME

    Get-Item

SYNOPSIS

    Gets a collection of Server objects for the local computer and any computers

    to which you have made a SQL Server PowerShell connection.
    ...

Örnek 12: Bir komut dosyası için yardımı görüntüleme

Bu örnek, MyScript.ps1 betiği için yardım alır. İşlevleriniz ve komut dosyalarınız için nasıl yardım yazılacağı hakkında bilgi için bkz. about_Comment_Based_Help.

Get-Help -Name C:\PS-Test\MyScript.ps1

Parametreler

-Category

Yalnızca belirtilen kategorideki öğelere ve bunların takma adlarına ilişkin yardımı görüntüler. Kavramsal makaleler YardımDosyası kategorisindedir.

Bu parametre için kabul edilebilir değerler aşağıdaki gibidir:

• Takma ad
• Cmdlet'i
• sağlayıcı
• Genel
• SSS
• Sözlük
• HelpFile
• ScriptCommand
• İşlev
• Filtre
• ExternalScript
• Tüm
• DefaultHelp
• İş akışı
• DscResource
• Sınıf
• Yapılandırma

Tip :

String[]

Kabul edilen değerler:

Takma Ad, Cmdlet, Sağlayıcı, Genel, SSS, Sözlük, HelpFile, ScriptCommand, İşlev, Filtre, HariciScript, Tümü, DefaultHelp, İş Akışı, DscResource, Sınıf, Yapılandırma

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Component

Exchange gibi belirtilen bileşen değerine sahip komutları görüntüler. Bir bileşen adı girin. Joker karakterlere izin verilir. Bu parametrenin kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Detailed

Temel yardım ekranına parametre açıklamaları ve örnekler ekler. Bu parametre yalnızca yardım dosyaları bilgisayara yüklendiğinde etkilidir. Kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Examples

Yalnızca adı, özeti ve örnekleri görüntüler. Bu parametre yalnızca yardım dosyaları bilgisayara yüklendiğinde etkilidir. Kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Full

Bir cmdlet'e ilişkin yardım makalesinin tamamını görüntüler. Tam parametre açıklamalarını ve niteliklerini, örnekleri, giriş ve çıkış nesne türlerini ve ek notları içerir.

Bu parametre yalnızca yardım dosyaları bilgisayara yüklendiğinde etkilidir. Kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Functionality

Belirtilen işlevselliğe sahip öğelere ilişkin yardımı görüntüler. İşlevselliği girin. Joker karakterlere izin verilir. Bu parametrenin kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Name

Belirtilen komut veya kavram hakkında yardım alır. Get-Member gibi bir cmdlet, işlev, sağlayıcı, komut dosyası veya iş akışının adını, about_Objects gibi kavramsal bir makale adını veya aşağıdaki gibi bir takma adı girin ls olarak. Cmdlet ve sağlayıcı adlarında joker karakterlere izin verilir, ancak işlev yardımı ve komut dosyası yardımı makalelerinin adlarını bulmak için joker karakterler kullanamazsınız.

$env:Path ortam değişkeninde listelenen bir yolda bulunmayan bir komut dosyasıyla ilgili yardım almak için komut dosyasının yolunu ve dosya adını yazın.

Bir yardım makalesinin tam adını girerseniz Get-Help makale içeriğini görüntüler.

Birkaç yardım makalesi başlığında görünen bir kelime veya kelime kalıbı girerseniz, Get-Help eşleşen başlıkların bir listesini görüntüler.

Herhangi bir yardım makalesi başlığıyla eşleşmeyen bir metin girerseniz, Get-Help içeriğinde bu metni içeren makalelerin bir listesini görüntüler.

about_Objects gibi kavramsal makalelerin adları, PowerShell'in İngilizce olmayan sürümlerinde bile İngilizce olarak girilmelidir.

Tip :

String

Konum:

0

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

True

Joker karakterleri kabul et:

True

-Online

Bir yardım makalesinin çevrimiçi sürümünü varsayılan tarayıcıda görüntüler. Bu parametre yalnızca cmdlet, işlev, iş akışı ve komut dosyası yardım makaleleri için geçerlidir. Uzak bir oturumda Çevrimiçi parametresini Get-Help ile kullanamazsınız.

Yazdığınız yardım makalelerinde bu özelliğin desteklenmesi hakkında bilgi için about_Comment_Based_Help ve Çevrimiçi Yardımı Destekleme ve PowerShell Cmdlet'leri için Yardım Yazma konularına bakın.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

-Parameter

Yalnızca belirtilen parametrelerin ayrıntılı açıklamalarını görüntüler. Joker karakterlere izin verilir. Bu parametrenin kavramsal (Hakkında_) yardımın görüntülenmesi üzerinde hiçbir etkisi yoktur.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Path

Belirtilen sağlayıcı yolunda cmdlet'in nasıl çalıştığını açıklayan yardım alır. Bir PowerShell sağlayıcı yolu girin.

Bu parametre, cmdlet'in belirtilen PowerShell sağlayıcı yolunda nasıl çalıştığını açıklayan bir cmdlet yardım makalesinin özelleştirilmiş bir sürümünü alır. Bu parametre yalnızca sağlayıcı cmdlet'i hakkında yardım için ve yalnızca sağlayıcı, yardım dosyasına sağlayıcı cmdlet'i yardım makalesinin özel bir sürümünü eklediğinde etkilidir. Bu parametreyi kullanmak için sağlayıcıyı içeren modülün yardım dosyasını yükleyin.

Bir sağlayıcı yoluna ilişkin özel cmdlet yardımını görmek için, sağlayıcı yolu konumuna gidin ve bir Get-Help komutunu girin veya herhangi bir yol konumundan Path parametresini kullanın. Sağlayıcı yolunu belirtmek için Get-Help. Ayrıca özel cmdlet yardımını çevrimiçi olarak yardım makalelerinin sağlayıcı yardım bölümünde de bulabilirsiniz.

PowerShell sağlayıcıları hakkında daha fazla bilgi için bkz. about_Providers.

Tip :

String

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-Role

Belirtilen kullanıcı rolü için özelleştirilmiş yardımı görüntüler. Bir rol girin. Joker karakterlere izin verilir.

Kullanıcının bir kuruluşta oynadığı rolü girin. Bazı cmdlet'ler, bu parametrenin değerine bağlı olarak yardım dosyalarında farklı metinler görüntüler. Bu parametrenin çekirdek cmdlet'lere yönelik yardım üzerinde hiçbir etkisi yoktur.

Tip :

String[]

Konum:

Adlandırılmış

Varsayılan değer:

None

Gerekli:

False

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

True

-ShowWindow

Daha kolay okunması için yardım konusunu bir pencerede görüntüler. Pencerede bir Bul arama özelliği ve bir yardım konusunun yalnızca seçilen bölümlerini görüntüleme seçenekleri de dahil olmak üzere görüntüleme seçeneklerini ayarlamanıza olanak tanıyan bir Ayarlar kutusu bulunur.

ShowWindow parametresi, komutlar (cmdlet'ler, işlevler, CIM komutları, komut dosyaları) ve kavramsal Hakkında makaleleri için yardım konularını destekler. Sağlayıcı yardımını desteklemiyor.

Bu parametre PowerShell 7,0'da yeniden sunuldu. Bu parametre yalnızca Windows'ta kullanılabilir.

Tip :

SwitchParameter

Konum:

Adlandırılmış

Varsayılan değer:

False

Gerekli:

True

Boru hattı girişini kabul edin:

False

Joker karakterleri kabul et:

False

Girişler

Yok

Nesneleri bu cmdlet'e aktaramazsınız.

Çıkışlar

ExtulatedCmdletHelpInfo

Yardım dosyası olmayan bir komutta Get-Help'i çalıştırırsanız, Get-Help, otomatik olarak oluşturulmuş yardımı temsil eden bir ExtishedCmdletHelpInfo nesnesi döndürür .

Dize

Kavramsal bir yardım makalesi alırsanız Get-Help bunu bir dize olarak döndürür.

MamlCommandHelpInfo

Yardım dosyası içeren bir komut alırsanız Get-Help, bir MamlCommandHelpInfo nesnesi döndürür.

Notlar

PowerShell 3,0 yardım dosyalarını içermez. Get-Help'in okuduğu yardım dosyalarını indirip yüklemek için Update-Help cmdlet'ini kullanın. PowerShell ile birlikte gelen temel komutlara ve yüklediğiniz tüm modüllere ilişkin yardım dosyalarını indirmek ve yüklemek için Update-Help cmdlet'ini kullanabilirsiniz. Ayrıca, bilgisayarınızdaki yardımın hiçbir zaman güncel olmamasını sağlamak amacıyla yardım dosyalarını güncellemek için de kullanabilirsiniz.

Ayrıca Windows PowerShell'e Başlarken bölümünden başlayarak çevrimiçi olarak PowerShell ile birlikte gelen komutlarla ilgili yardım makalelerini de okuyabilirsiniz.

Get-Help, Windows işletim sistemi için belirlenen yerel ayardaki veya o yerel ayar için geri dönüş dilindeki yardımı görüntüler. Birincil veya yedek yerel ayar için yardım dosyalarınız yoksa Get-Help, bilgisayarda hiç yardım dosyası yokmuş gibi davranır. Farklı bir yerel ayar için yardım almak amacıyla ayarları değiştirmek üzere Denetim Masası'ndaki Bölge ve Dil'i kullanın. Windows 10 veya sonraki sürümlerde, Ayarlar, Zaman ve Dil.

Yardımın tam görünümü parametreler hakkında bir bilgi tablosu içerir. Tablo aşağıdaki alanları içerir:

• Zorunlu. Parametrenin gerekli mi (doğru) yoksa isteğe bağlı mı (yanlış) olduğunu belirtir.

• Konum. Parametrenin adlandırılmış mı yoksa konumsal mı (sayısal) olduğunu belirtir. Konumsal parametreler komutta belirtilen bir yerde görünmelidir.

• Adlandırılmış, parametre adının gerekli olduğunu ancak parametrenin komutun herhangi bir yerinde görünebileceğini belirtir.

• Sayısal, parametre adının isteğe bağlı olduğunu ancak ad atlandığında parametrenin sayıyla belirtilen yerde olması gerektiğini belirtir. Örneğin 2, parametre adı atlandığında parametrenin komuttaki ikinci veya tek adsız parametre olması gerektiğini belirtir. Parametre adı kullanıldığında parametre komutun herhangi bir yerinde görünebilir.

• Varsayılan değer. Parametreyi komuta eklemezseniz PowerShell'in kullandığı parametre değeri veya varsayılan davranış.

• Boru hattı girişini kabul eder. Nesneleri bir işlem hattı aracılığıyla parametreye gönderip gönderemeyeceğinizi (doğru) veya gönderemeyeceğinizi (yanlış) belirtir. Özellik Adına Göre, ardışık düzen nesnesinin parametre adıyla aynı ada sahip bir özelliğe sahip olması gerektiği anlamına gelir.

• Joker karakterleri kabul eder. Bir parametrenin değerinin yıldız işareti (*) veya soru işareti (?) gibi joker karakterler içerip içermeyeceğini belirtir.