Get-Help
PowerShell komutları ve kavramları hakkındaki bilgileri görüntüler.
Syntax
Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Full]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Get-Help
[[-Name] <String>]
-Detailed
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Get-Help
[[-Name] <String>]
-Examples
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Get-Help
[[-Name] <String>]
-Parameter <String[]>
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Get-Help
[[-Name] <String>]
-Online
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]
Description
cmdlet'i, cmdlet'ler Get-Help
, işlevler, Ortak Bilgi Modeli (CIM) komutları, iş akışları, sağlayıcılar, diğer adlar ve betikler dahil olmak üzere PowerShell kavramları ve komutları hakkındaki bilgileri görüntüler.
PowerShell cmdlet'i için yardım almak için, cmdlet adını yazın Get-Help
, örneğin: Get-Help Get-Process
.
PowerShell'deki kavramsal yardım makaleleri about_Comparison_Operators gibiabout_ başlar. Tüm about_ makaleleri görmek için yazın Get-Help about_*
. Belirli bir makaleyi görmek için gibi Get-Help about_Comparison_Operators
yazınGet-Help about_<article-name>
.
PowerShell sağlayıcısıyla ilgili yardım almak için sağlayıcı adını yazın Get-Help
. Örneğin, Sertifika sağlayıcısıyla ilgili yardım almak için yazın Get-Help Certificate
.
Ayrıca, bir kerede bir ekran metin görüntüleyen veya man
yazabilirsinizhelp
. Veya , <cmdlet-name> -?
ile aynıdır Get-Help
, ancak yalnızca cmdlet'ler için çalışır.
Get-Help
bilgisayarınızdaki yardım dosyalarından görüntülediği yardım içeriğini alır. Yardım dosyaları olmadan, Get-Help
cmdlet'ler hakkında yalnızca temel bilgileri görüntüler. Bazı PowerShell modülleri yardım dosyalarını içerir. PowerShell 3.0'da başlayarak, Windows işletim sistemiyle birlikte gelen modüller yardım dosyalarını içermez. PowerShell 3.0'da bir modülün yardım dosyalarını indirmek veya güncelleştirmek için cmdlet'ini Update-Help
kullanın.
PowerShell yardım belgelerini Microsoft Docs çevrimiçi olarak da görüntüleyebilirsiniz. Bir yardım dosyasının çevrimiçi sürümünü almak için Online parametresini kullanın, örneğin: Get-Help Get-Process -Online
. Tüm PowerShell belgelerini okumak için Microsoft Docs PowerShell Belgeleri'ne bakın.
Ardından bir yardım makalesinin tam adını veya yardım makalesine özgü bir sözcüğü yazarsanız Get-Help
, Get-Help
makalenin içeriğini görüntüler. Bir komut diğer adının tam adını belirtirseniz, Get-Help
özgün komutun yardımını görüntüler. Birkaç yardım makalesi başlığında görünen bir sözcük veya sözcük deseni girerseniz, Get-Help
eşleşen başlıkların listesini görüntüler. Herhangi bir yardım makalesi başlığında görünmeyen bir metin girerseniz, Get-Help
içeriğinde bu metni içeren makalelerin listesini görüntüler.
Get-Help
desteklenen tüm diller ve yerel ayarlar için yardım makaleleri alabilir. Get-Help
önce Windows için yerel ayar kümesinde, ardından pt-BR için pt gibi üst yerel ayarda ve ardından bir geri dönüş yerel ayarında yardım dosyalarını arar. PowerShell 3.0'dan başlayarak, Get-Help
geri dönüş yerel ayarında yardım bulamazsa, hata iletisi döndürmeden veya otomatik oluşturulan yardımı görüntülemeden önce İngilizce, en-US yardım makalelerini arar.
Komut söz dizimi diyagramında görüntülenen simgeler Get-Help
hakkında bilgi için bkz. about_Command_Syntax.
Gerekli ve Konum gibi parametre öznitelikleri hakkında bilgi için bkz. about_Parameters.
Not
PowerShell 3.0 ve PowerShell 4.0'da, Get-Help
modül geçerli oturuma aktarılmadığı sürece modüllerde Hakkında makaleleri bulunamaz. Bu bilinen bir sorundur. Bir modüldeki Hakkında makalelerini almak için, cmdlet'ini kullanarak veya modülde Import-Module
bulunan bir cmdlet'i çalıştırarak modülü içeri aktarın.
Örnekler
Örnek 1: Cmdlet hakkında temel yardım bilgilerini görüntüleme
Bu örneklerde cmdlet'i hakkında Format-Table
temel yardım bilgileri görüntülenir.
Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?
Get-Help <cmdlet-name>
cmdlet'in en basit ve varsayılan söz dizimidir Get-Help
. Name parametresini atlayabilirsiniz.
Söz dizimi <cmdlet-name> -?
yalnızca cmdlet'ler için çalışır.
Örnek 2: Temel bilgileri bir kerede bir sayfa görüntüleme
Bu örnekler, cmdlet'i hakkındaki Format-Table
temel yardım bilgilerini birer birer görüntüler.
help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paging
help
, cmdlet'i dahili olarak çalıştıran Get-Help
ve sonucu bir kerede bir sayfa görüntüleyen bir işlevdir.
man
işlevi için help
bir diğer addır.
Get-Help Format-Table
nesnesini işlem hattına gönderir. Out-Host -Paging
işlem hattından çıkışı alır ve her seferinde bir sayfa görüntüler. Daha fazla bilgi için bkz. Out-Host.
Örnek 3: Cmdlet için daha fazla bilgi görüntüleme
Bu örneklerde cmdlet hakkında Format-Table
daha ayrıntılı yardım bilgileri görüntülenir.
Get-Help Format-Table -Detailed
Get-Help Format-Table -Full
Detailed 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ı, örneklerini, giriş ve çıkış nesnesi türlerini ve ek notları içeren tam görünümünü görüntüler.
Detailed ve Full parametreleri yalnızca bilgisayarda yardım dosyalarının yüklü olduğu komutlar için geçerlidir. Parametreler kavramsal (about_) yardım makaleleri için etkili değildir.
Örnek 4: Parametreleri kullanarak cmdlet'in seçili bölümlerini görüntüleme
Bu örneklerde cmdlet yardımının Format-Table
seçili bölümleri görüntülenir.
Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupBy
Örnekler parametresi, yardım dosyasının NAME ve SYNOPSIS bölümlerini ve tüm Örnekleri görüntüler. Örnekler parametresi bir anahtar parametresi olduğundan Örnek sayı 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ını görüntüler.
ParametreGroupBy gibi bir parametre adı belirttiğinde, bu parametreyle ilgili bilgiler gösterilir.
Bu parametreler kavramsal (about_) yardım makaleleri için etkili değildir.
Örnek 5: Yardımın çevrimiçi sürümünü görüntüleme
Bu örnekte, varsayılan web tarayıcınızda cmdlet için yardım makalesinin Format-Table
çevrimiçi sürümü görüntülenir.
Get-Help Format-Table -Online
Örnek 6: Yardım sistemi hakkında yardım görüntüleme
Get-Help
Parametresiz cmdlet, PowerShell yardım sistemi hakkındaki bilgileri görüntüler.
Get-Help
Örnek 7: Kullanılabilir yardım makalelerini görüntüleme
Bu örnekte, bilgisayarınızda bulunan tüm yardım makalelerinin listesi görüntülenir.
Get-Help *
Örnek 8: Kavramsal makalelerin listesini görüntüleme
Bu örnekte, PowerShell yardımındaki kavramsal makalelerin listesi görüntülenir. Tüm bu makaleler about_ karakterleriyle başlar. Belirli bir yardım dosyasını görüntülemek için , Get-Help \<about_article-name\>
örneğin yazın Get-Help about_Signing
.
Yalnızca bilgisayarınızda yardım dosyalarının yüklü olduğ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 . Update-Help.
Get-Help about_*
Örnek 9: cmdlet yardımındaki bir sözcük için Arama
Bu örnekte, cmdlet yardım makalesinde sözcük arama gösterilmektedir.
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
için yardım bilgilerini almak için Add-Member
Tam parametresini kullanır. MamlCommandHelpInfo nesnesi işlem hattına gönderilir. Out-String
nesneyi dizeye dönüştürmek için Stream parametresini kullanır. Select-String
Dizede Clixml araması yapmak için Pattern parametresini kullanır.
Örnek 10: Sözcük içeren makalelerin listesini görüntüleme
Bu örnekte uzaktan iletişim sözcüğünü içeren makalelerin listesi görüntülenir.
Herhangi bir makale başlığında görünmeyen bir sözcük girdiğinizde, Get-Help
söz konusu sözcüğü içeren makalelerin 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 özgü yardımı görüntüleme
Bu örnekte için Get-Item
sağlayıcıya özgü yardım almanın iki yolu gösterilmektedir. Bu komutlar, PowerShell SQL Server sağlayıcısının Get-Item
DataCollection düğümünde cmdlet'in 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 Path parametresini kullanırGet-Help
.
Sağlayıcının yolu belirtildiğinden, komutu herhangi bir yol konumundan çalıştırabilirsiniz.
İkinci örnek, SQL Server sağlayıcısının yoluna gitmek için kullanırSet-Location
. Sağlayıcıya özgü yardımı almak için Get-Help
bu konumdan Path parametresi gerekli değildir.
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: Betik için yardım görüntüleme
Bu örnek için MyScript.ps1 script
yardım alır. İşlevleriniz ve betikleriniz için yardım yazma hakkında bilgi için bkz. about_Comment_Based_Help.
Get-Help -Name C:\PS-Test\MyScript.ps1
Parametreler
-Category
Yalnızca belirtilen kategorideki öğeler ve diğer adları için yardım görüntüler. Kavramsal makaleler HelpFile kategorisindedir.
Bu parametre için kabul edilebilir değerler şunlardır:
- Diğer ad
- Cmdlet
- Sağlayıcı
- Genel
- SSS
- Sözlük
- Helpfile
- ScriptCommand
- İşlev
- Filtre
- ExternalScript
- Tümü
- DefaultHelp
- İş akışı
- DscResource
- Sınıf
- Yapılandırma
Type: | String[] |
Accepted values: | Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 (About_) yardımı görüntülemeleri üzerinde hiçbir etkisi yoktur.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Detailed
Temel yardım görünümüne parametre açıklamaları ve örnekler ekler. Bu parametre yalnızca yardım dosyaları bilgisayarda yüklü olduğunda geçerlidir. Kavramsal (About_) yardımın ekranları üzerinde hiçbir etkisi yoktur.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Examples
Yalnızca adı, özetleri ve örnekleri görüntüler. Yalnızca örnekleri görüntülemek için yazın (Get-Help \<cmdlet-name\>).Examples
.
Bu parametre yalnızca yardım dosyaları bilgisayarda yüklü olduğunda geçerlidir. Kavramsal (About_) yardımın ekranları üzerinde hiçbir etkisi yoktur.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Full
Bir cmdlet için yardım makalesinin tamamını görüntüler. Tam , parametre açıklamalarını ve özniteliklerini, örnekleri, giriş ve çıkış nesnesi türlerini ve ek notları içerir.
Bu parametre yalnızca yardım dosyaları bilgisayarda yüklü olduğunda geçerlidir. Kavramsal (About_) yardımın ekranları üzerinde hiçbir etkisi yoktur.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Functionality
Belirtilen işlevselliğe sahip öğeler için yardım görüntüler. İşlevselliği girin. Joker karakterlere izin verilir. Bu parametrenin kavramsal (About_) yardımı görüntülemeleri üzerinde hiçbir etkisi yoktur.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Name
Belirtilen komut veya kavram hakkında yardım alır. cmdlet'inin, işlevin, sağlayıcının, betiğin veya iş akışının adını girin; örneğin Get-Member
, gibi about_Objects
kavramsal bir makale adı veya gibi ls
bir diğer ad girin. Cmdlet ve sağlayıcı adlarında joker karakterlere izin verilir, ancak işlev yardımı ve betik yardımı makalelerinin adlarını bulmak için joker karakterler kullanamazsınız.
Ortam değişkeninde listelenen $env:Path
bir yolda yer almayan bir betik için yardım almak için betiğin yolunu ve dosya adını yazın.
Bir yardım makalesinin tam adını girerseniz makale Get-Help
içeriğini görüntüler.
Birkaç yardım makalesi başlığında görünen bir sözcük veya sözcük deseni girerseniz, Get-Help
eşleşen başlıkların 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 listesini görüntüler.
gibi about_Objects
kavramsal makalelerin adları, PowerShell'in İngilizce olmayan sürümlerinde bile İngilizce girilmelidir.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-Online
Varsayılan tarayıcıda bir yardım makalesinin çevrimiçi sürümünü görüntüler. Bu parametre yalnızca cmdlet, işlev, iş akışı ve betik yardımı makaleleri için geçerlidir. Uzak oturumda IleGet-Help
Online parametresini kullanamazsınız.
Yazdığınız yardım makalelerinde bu özelliği destekleme hakkında bilgi için bkz. about_Comment_Based_Help ve Çevrimiçi Yardımı Destekleme ve PowerShell Cmdlet'leri için Yardım Yazma.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Parameter
Yalnızca belirtilen parametrelerin ayrıntılı açıklamalarını görüntüler. Joker karakterlere izin verilir. Bu parametrenin kavramsal (About_) yardımı görüntülemeleri üzerinde hiçbir etkisi yoktur.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Path
Cmdlet'in belirtilen sağlayıcı yolunda 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ş sürümünü alır. Bu parametre yalnızca bir sağlayıcı cmdlet'i hakkında yardım için ve yalnızca sağlayıcı, yardım dosyasında sağlayıcı cmdlet'i yardım makalesinin özel bir sürümünü içerdiğ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ı yolu için özel cmdlet yardımını görmek için sağlayıcı yolu konumuna gidin ve bir komut girin veya herhangi bir Get-Help
yol konumundan path parametresiniGet-Help
kullanarak sağlayıcı yolunu belirtin. Ö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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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 kuruluşta oynadığı rolü girin. Bazı cmdlet'ler bu parametrenin değerine göre yardım dosyalarında farklı metinler görüntüler. Bu parametrenin çekirdek cmdlet'ler için yardım üzerinde hiçbir etkisi yoktur.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
Girişler
None
nesneleri işlem hattından adresine Get-Help
gönderemezsiniz.
Çıkışlar
ExtendedCmdletHelpInfo
Yardım dosyası olmayan bir komut üzerinde çalıştırırsanız Get-Help
, Get-Help
otomatik oluşturulan yardımı temsil eden bir ExtendedCmdletHelpInfo nesnesi döndürür.
Kavramsal bir yardım makalesi alırsanız, Get-Help
bunu dize olarak döndürür.
MamlCommandHelpInfo
Yardım dosyası içeren bir komut alırsanız, Get-Help
MamlCommandHelpInfo nesnesini döndürür.
Notlar
PowerShell 3.0, yardım dosyalarını içermez. Okuyan yardım dosyalarını Get-Help
indirmek ve yüklemek için cmdlet'ini Update-Help
kullanın. PowerShell ile birlikte gelen temel komutlar ve yüklediğiniz tüm modüller için yardım dosyalarını indirmek ve yüklemek için cmdlet'ini kullanabilirsiniz Update-Help
. Ayrıca, bilgisayarınızdaki yardımın hiçbir zaman eskimeyecek şekilde yardım dosyalarını güncelleştirmek için de kullanabilirsiniz.
Windows PowerShell Kullanmaya Başlama bölümünden başlayarak PowerShell çevrimiçi ile birlikte gelen komutlarla ilgili yardım makalelerini de okuyabilirsiniz.
Get-Help
Windows işletim sistemi için yerel ayar kümesinde veya bu yerel ayarın geri dönüş dilinde yardım görüntüler. Birincil veya geri dönüş 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 için Denetim Masası'da Bölge ve Dil'i kullanarak ayarları değiştirin. Windows 10, Ayarlar, Saat & Dili.
Yardımın tam görünümü, parametreler hakkında bilgi tablosu içerir. Tablo aşağıdaki alanları içerir:
Gerekli. Parametrenin gerekli (true) veya isteğe bağlı (false) olup olmadığını gösterir.
Konum. Parametrenin adlandırılmış mı yoksa konumsal mı (sayısal) olduğunu gösterir. Konum parametreleri komutunda belirtilen bir yerde görünmelidir.
Named , 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 gösterir, ancak ad atlandığında, parametrenin sayıyla belirtilen yerde olması gerekir. Örneğin,
2
parametre adı atlandığında parametresinin komuttaki ikinci veya yalnızca adlandırılmamış parametre olması gerektiğini gösterir. Parametre adı kullanıldığında, parametre komutun herhangi bir yerinde görünebilir.Varsayılan değer. Parametreyi komuta dahil etmezseniz PowerShell'in kullandığı parametre değeri veya varsayılan davranış.
İşlem hattı girişini kabul eder. İşlem hattı aracılığıyla parametreye nesne gönderip gönderemeyeceğinizi (true) veya gönderemeyeceğinizi (false) gösterir. Özellik Adı ile, işlem hattına alınan nesnenin parametre adıyla aynı ada sahip bir özelliğe sahip olması gerektiği anlamına gelir.
Joker karakterleri kabul eder. Parametrenin değerinin yıldız işareti () veya soru işareti
?
(*
) gibi joker karakterler içerip içeremeyeceğini gösterir.