Aracılığıyla paylaş


New-PSRoleCapabilityFile

Oturum yapılandırması aracılığıyla kullanıma sunulacak bir özellik kümesini tanımlayan bir dosya oluşturur.

Sözdizimi

Default EnterprisePublishing

New-PSRoleCapabilityFile
    [-Path] <String>
    [-Guid <Guid>]
    [-Author <String>]
    [-Description <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-ModulesToImport <Object[]>]
    [-VisibleAliases <String[]>]
    [-VisibleCmdlets <Object[]>]
    [-VisibleFunctions <Object[]>]
    [-VisibleExternalCommands <String[]>]
    [-VisibleProviders <String[]>]
    [-ScriptsToProcess <String[]>]
    [-AliasDefinitions <IDictionary[]>]
    [-FunctionDefinitions <IDictionary[]>]
    [-VariableDefinitions <Object>]
    [-EnvironmentVariables <IDictionary>]
    [-TypesToProcess <String[]>]
    [-FormatsToProcess <String[]>]
    [-AssembliesToLoad <String[]>]
    [<CommonParameters>]

Description

New-PSRoleCapabilityFile cmdlet'i, oturum yapılandırma dosyaları aracılığıyla gösterilebilen bir kullanıcı özellikleri kümesini tanımlayan bir dosya oluşturur. Bu, kullanıcılara hangi cmdlet'lerin, işlevlerin ve betiklerin kullanılabilir olduğunu belirlemeyi içerir. Yetenek dosyası, oturum yapılandırma özelliklerinin ve değerlerinin karma tablosunu içeren, insan tarafından okunabilen bir metin dosyasıdır. Dosyanın .psrc dosya adı uzantısı vardır ve birden fazla oturum yapılandırması tarafından kullanılabilir.

New-PSRoleCapabilityFile tüm parametreleri, dosyanın yolunu belirten Path parametresi dışında isteğe bağlıdır. Cmdlet'ini çalıştırdığınızda parametre eklemezseniz, parametre açıklamasında belirtilenler dışında oturum yapılandırma dosyasındaki ilgili anahtar açıklama satırı yapılır. Örneğin, AssembliesToLoad parametresini eklemezseniz oturum yapılandırma dosyasının o bölümü açıklama satırı yapılır.

Rol özelliği dosyasını bir oturum yapılandırmasında kullanmak için, önce dosyayı geçerli bir PowerShell modülü klasörünün RoleCapabilities alt klasörüne yerleştirin. Ardından bir PowerShell Oturum Yapılandırması (.pssc) dosyasındaki RoleDefinitions alanında dosyaya ada göre başvurun.

Bu cmdlet, Windows PowerShell 5.0'da kullanıma sunulmuştur.

Örnekler

Örnek 1: Boş rol yetenek dosyası oluşturma

Bu örnek, varsayılan (boş) değerleri kullanan yeni bir rol özelliği dosyası oluşturur. Dosya daha sonra bu yapılandırma ayarlarını değiştirmek için bir metin düzenleyicisinde düzenlenebilir.

New-PSRoleCapabilityFile -Path ".\ExampleFile.psrc"

Örnek 2: Kullanıcıların hizmetleri ve herhangi bir VDI bilgisayarı yeniden başlatmasına olanak sağlayan bir rol özelliği dosyası oluşturma

Bu örnek, kullanıcıların belirli bir ad desenine uyan hizmetleri ve bilgisayarları yeniden başlatmasını sağlayan örnek bir rol yetenek dosyası oluşturur. Ad filtreleme, ValidatePattern parametresi VDI\d+normal ifadeye ayarlanarak tanımlanır.

$roleParameters = @{
    Path = ".\Maintenance.psrc"
    Author = "User01"
    CompanyName = "Fabrikam Corporation"
    Description = "This role enables users to restart any service and restart any VDI computer."
    ModulesToImport = "Microsoft.PowerShell.Core"
    VisibleCmdlets = "Restart-Service", @{
                      Name = "Restart-Computer"
                      Parameters = @{ Name = "ComputerName"; ValidatePattern = "VDI\d+" }
    }
}
New-PSRoleCapabilityFile @roleParameters

Parametreler

-AliasDefinitions

Belirtilen diğer adları rol yetenek dosyasını kullanan oturumlara ekler. Aşağıdaki anahtarlara sahip bir karma tablo girin:

  • Adı. Diğer adın adı. Bu anahtar gereklidir.
  • Değer. Diğer adın temsil ettiği komut. Bu anahtar gereklidir.
  • Açıklama. Diğer adı açıklayan bir metin dizesi. Bu anahtar isteğe bağlıdır.
  • Seçenekler. Diğer ad seçenekleri. Bu anahtar isteğe bağlıdır. Varsayılan değer Yok değeridir. Bu parametre için kabul edilebilir değerler şunlardır: None, ReadOnly, Constant, Private veya AllScope.

Örneğin: @{Name="hlp";Value="Get-Help";Description="Gets help";Options="ReadOnly"}

Parametre özellikleri

Tür:

IDictionary[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-AssembliesToLoad

Rol yetenek dosyasını kullanan oturumlara yüklenecek derlemeleri belirtir.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Author

Rol yetenek dosyasını oluşturan kullanıcıyı belirtir.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-CompanyName

Rol yetenek dosyasını oluşturan şirketi tanımlar. Varsayılan değer Bilinmiyor'dur.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

Rol yeteneği dosyası için bir telif hakkı belirtir. Bu parametreyi atlarsanız, New-PSRoleCapabilityFileAuthor parametresinin değerini kullanarak bir telif hakkı bildirimi oluşturur.

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False
(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Description

Rol özelliği dosyası için bir açıklama belirtir.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-EnvironmentVariables

Bu rol yetenek dosyasını kullanıma sunan oturumlar için ortam değişkenlerini belirtir. Anahtarların ortam değişkeni adları ve değerlerin ortam değişkeni değerleri olduğu bir karma tablo girin.

Örneğin: EnvironmentVariables=@{TestShare="\\\\Server01\TestShare"}

Parametre özellikleri

Tür:IDictionary
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-FormatsToProcess

Rol özelliği dosyasını kullanan oturumlarda çalışan biçimlendirme dosyalarını (.ps1xml) belirtir. Bu parametrenin değeri, biçimlendirme dosyalarının tam veya mutlak yolu olmalıdır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-FunctionDefinitions

Belirtilen işlevleri rol özelliğini kullanıma sunan oturumlara ekler. Aşağıdaki anahtarlara sahip bir karma tablo girin:

  • Adı. İşlevin adı. Bu anahtar gereklidir.
  • Komut Dosyası Bloğu. İşlev gövdesi. Bir betik bloğu girin. Bu anahtar gereklidir.
  • Seçenekler. İşlev seçenekleri. Bu anahtar isteğe bağlıdır. Varsayılan değer Yok değeridir. Bu parametre için kabul edilebilir değerler şunlardır: None, ReadOnly, Constant, Private veya AllScope.

Örneğin:

@{Name="Get-PowerShellProcess";ScriptBlock={Get-Process powershell};Options="AllScope"}

Parametre özellikleri

Tür:

IDictionary[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Guid

Rol özelliği dosyası için benzersiz bir tanımlayıcı belirtir. Bu parametreyi atlarsanız, New-PSRoleCapabilityFile dosya için bir GUID oluşturur. PowerShell'de yeni bir GUID oluşturmak için [guid]::NewGuid()yazın.

Parametre özellikleri

Tür:Guid
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-ModulesToImport

Rol yetenek dosyasını kullanan oturumlara otomatik olarak içeri aktarılan modülleri belirtir. Varsayılan olarak, listelenen modüllerdeki tüm komutlar görünür. VisibleCmdlet'ler veyaVisibleFunctions ile kullanıldığında, belirtilen modüllerden görünen komutlar kısıtlanabilir.

Bu parametrenin değerinde kullanılan her modül bir dize veya karma tabloyla temsil edilebilir. Modül dizesi yalnızca modülün adından oluşur. Modül karma tablosu ModuleName, ModuleVersionve GUID anahtarlarını içerebilir. Yalnızca ModuleName anahtarı gereklidir.

Örneğin, aşağıdaki değer bir dize ve karma tablodan oluşur. Dizelerin ve karma tabloların herhangi bir sırayla birleşimi geçerli olur.

"TroubleshootingPack", @{ModuleName="PSDiagnostics"; ModuleVersion="1.0.0.0";GUID="c61d6278-02a3-4618-ae37-a524d40a7f44"}

Parametre özellikleri

Tür:

Object[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Path

Rol yeteneği dosyasının yolunu ve dosya adını belirtir. Dosyanın .psrc bir dosya adı uzantısı olmalıdır.

Parametre özellikleri

Tür:String
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:0
Zorunlu:True
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-ScriptsToProcess

Rol yetenek dosyasını kullanan oturumlara eklenecek betikleri belirtir. Betiklerin yolunu ve dosya adlarını girin. Bu parametrenin değeri, betik dosyası adlarının tam veya mutlak yolu olmalıdır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-TypesToProcess

Rol özelliği dosyasını kullanan oturumlara eklenecek tür dosyalarını (.ps1xml) belirtir. Dosya adlarını yazın. Bu parametrenin değeri, dosya adlarının türü için tam veya mutlak bir yol olmalıdır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VariableDefinitions

Rol yetenek dosyasını kullanan oturumlara eklenecek değişkenleri belirtir. Aşağıdaki anahtarlara sahip bir karma tablo girin:

  • Adı. Değişkenin adı. Bu anahtar gereklidir.
  • Değer. Değişken değeri. Bu anahtar gereklidir.

Örneğin: @{Name="WarningPreference";Value="SilentlyContinue"}

Parametre özellikleri

Tür:Object
Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VisibleAliases

Oturumdaki diğer adları bu parametrenin değerinde belirtilen diğer adlarla ve AliasDefinition parametresinde tanımladığınız diğer adlarla sınırlar. Joker karakterler desteklenir. Varsayılan olarak, PowerShell altyapısı tarafından tanımlanan tüm diğer adlar ve modüllerin dışarı aktardığı tüm diğer adlar oturumda görünür.

Örneğin, kullanılabilir diğer adları gm ve gcm ile sınırlamak için şu söz dizimini kullanın: VisibleAliases="gcm", "gp"

Rol yeteneği dosyasına Visible parametresi eklendiğinde, PowerShell Import-Module cmdlet'ini ve ipmo diğer adını oturumdan kaldırır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VisibleCmdlets

Oturumdaki cmdlet'leri bu parametrenin değerinde belirtilenlerle sınırlar. Joker karakterler ve Modül Nitelenmiş Adları desteklenir.

Varsayılan olarak, oturum dışarı aktarmadaki modüllerin tüm cmdlet'leri oturumda görünür. Oturuma hangi modüllerin ve ek eklentilerin içeri aktarılacağını belirlemek için SessionType ve ModulesToImport parametrelerini kullanın. ModulesToImport cmdlet'ini kullanıma sunan modül yoksa New-PSRoleCapabilityFile uygun modülü yüklemeye çalışır.

Oturum yapılandırma dosyasına herhangi bir Visible parametresi eklendiğinde, PowerShell Import-Module cmdlet'ini ve ipmo diğer adını oturumdan kaldırır.

Parametre özellikleri

Tür:

Object[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VisibleExternalCommands

Oturumda yürütülebilecek dış ikili dosyaları, betikleri ve komutları bu parametrenin değerinde belirtilenlerle sınırlar.

Varsayılan olarak, bu oturumda hiçbir dış komut görünmez.

Oturum yapılandırma dosyasına herhangi bir Visible parametresi eklendiğinde, PowerShell Import-Module cmdlet'ini ve ipmo diğer adını oturumdan kaldırır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VisibleFunctions

Oturumdaki işlevleri bu parametrenin değerinde belirtilenlerle ve FunctionDefinitions parametresinde tanımladığınız işlevlerle sınırlar. Joker karakterler desteklenir.

Varsayılan olarak, oturumdaki modüller tarafından dışarı aktarılan tüm işlevler bu oturumda görünür. Oturuma hangi modüllerin içeri aktarılacağını belirlemek için SessionType ve ModulesToImport parametrelerini kullanın.

Oturum yapılandırma dosyasına herhangi bir Visible parametresi eklendiğinde, PowerShell Import-Module cmdlet'ini ve ipmo diğer adını oturumdan kaldırır.

Parametre özellikleri

Tür:

Object[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-VisibleProviders

Oturumdaki PowerShell sağlayıcılarını bu parametrenin değerinde belirtilenlerle sınırlar. Joker karakterler desteklenir.

Varsayılan olarak, oturumdaki bir modül tarafından dışarı aktarılan tüm sağlayıcılar oturumda görünür. Oturuma hangi modüllerin içeri aktarılacağını belirlemek için SessionType ve ModulesToImport parametrelerini kullanın.

Oturum yapılandırma dosyasına herhangi bir Visible parametresi eklendiğinde, PowerShell Import-Module cmdlet'ini ve ipmo diğer adını oturumdan kaldırır.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.