Freigeben über

SPCmdlet-Member

  • Artikel

Stellt eine abstrakte Basisklasse für alle benutzerdefinierten Cmdlets, die geschrieben werden, in der SharePoint-Bereitstellungen, Bereitstellung einheitliches Verhalten für alle SharePoint-Cmdlets verwendet werden.

Der SPCmdlet-Typ macht die folgenden Member verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode SPCmdlet Wenn Sie in der abgeleiteten Klasse überschrieben, initialisiert dieser Konstruktor eine neue Instanz der abgeleiteten Klasse.

Oben

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft AssignmentCollection Dient zum Abrufen oder Festlegen des SPAssignmentCollection -Objekts, das die Cmdlet-Pipelines für die Verwendung mit dem letzten Befehl übergeben wird.
Öffentliche Eigenschaft CommandOrigin (Geerbt von InternalCommand.)
Öffentliche Eigenschaft CommandRuntime (Geerbt von Cmdlet.)
Geschützte Eigenschaft ConfirmationMessage Dient zum Abrufen oder festlegen eine Nachricht, die mit der Benutzer zur Bestätigung aufgefordert wird.
Öffentliche Eigenschaft CurrentPSTransaction (Geerbt von Cmdlet.)
Geschützte Eigenschaft DisposeOutputObjects Dient zum Abrufen oder Festlegen eines booleschen Werts, das angibt, ob die Basisklasse Ausgabe-Objekte verwerfen wird, nachdem sie ausgegeben wurde, haben.
Öffentliche Eigenschaft Events (Geerbt von PSCmdlet.)
Geschützte Eigenschaft Fields Eine Eigenschaftensammlung, die die öffentlichen Eigenschaften des Cmdlets enthält.
Öffentliche Eigenschaft Host (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft InvokeCommand (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft InvokeProvider (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft JobRepository (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft MyInvocation (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft ParameterSetName (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft SessionState (Geerbt von PSCmdlet.)
Öffentliche Eigenschaft Stopping (Geerbt von Cmdlet.)

Oben

Methoden

  Name Beschreibung
Geschützte Methode BeginProcessing Legt beginnen Markierungen für die Ausführung des Cmdlets, während der Verarbeitungsschritte wie Protokollierung und Berechtigung Überprüfungen durchgeführt werden. Diese Methode wird einmal am Anfang des Cmd Ausführung aufgerufen. (Überschreibt CmdletBeginProcessing().)
Öffentliche Methode CurrentProviderLocation (Geerbt von PSCmdlet.)
Geschützte Methode EndProcessing Bietet eine Möglichkeit zum Hinzufügen von Nachbearbeitung Funktionalität für das Cmdlet. (Überschreibt CmdletEndProcessing().)
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode Finalize (Geerbt von Object.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Geschützte Methode GetProp<T> Ruft das Objekt aus der Fields-Eigenschaft, die der angegebene Feldname zugeordnet ist.
Geschützte Methode GetPropV<S> Ruft die Struktur aus Fields -Eigenschaft, die der angegebene Feldname zugeordnet ist.
Öffentliche Methode GetResolvedProviderPathFromPSPath (Geerbt von PSCmdlet.)
Öffentliche Methode GetResourceString (Geerbt von Cmdlet.)
Geschützte Methode GetSwitch Ruft ein SwitchParameter -Objekt, wenn eine gefunden wird.
Öffentliche Methode GetType (Geerbt von Object.)
Öffentliche Methode GetUnresolvedProviderPathFromPSPath (Geerbt von PSCmdlet.)
Öffentliche Methode GetVariableValue(String) (Geerbt von PSCmdlet.)
Öffentliche Methode GetVariableValue(String, Object) (Geerbt von PSCmdlet.)
Geschützte Methode InternalBeginProcessing Diese Methode führt innerhalb der BeginProcessing() -Methode und vor der Pipeline-Parameter auf-Methode festgelegt werden, und daher bietet eine Möglichkeit für Benutzer, die BeginProcessing() -Methode Programmfunktionen hinzu.
Geschützte Methode InternalDispose Liefert erbende Klassen Bereinigungscode, um Objekte verwerfen, die mithilfe der Methods InternalValidate(), ConfirmationMessageoder InternalProcessRecord() erstellt wurden.
Geschützte Methode InternalEndProcessing Diese Methode innerhalb der EndProcessing() -Methode ausgeführt wird, und daher bietet eine Möglichkeit für Benutzer, die EndProcessing() -Methode nach Abschluss der Ausführung des Cmdlets Programmfunktionen hinzuzufügen.
Geschützte Methode InternalProcessRecord Bietet eine Möglichkeit für Benutzer, die Funktion ProcessRecord() Programmfunktionen hinzuzufügen.
Geschützte Methode InternalStopProcessing Bietet eine Möglichkeit für Benutzer, die Funktion StopProcessing() Programmfunktionen hinzuzufügen.
Geschützte Methode InternalValidate Bietet eine Möglichkeit zum Validieren von Benutzereingaben während der Ausführung der ProcessRecord() -Methode.
Öffentliche Methode Invoke (Geerbt von Cmdlet.)
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Geschützte Methode ProcessRecord Der Datensatz-Verarbeitungsfunktionalität für das Cmdlet bietet und protokolliert Einträge für die Ausführung von jedem Datensatz. Diese Methode wird einmal für jedes weitergeleitete Objekt aufgerufen (d. h., für jeden Datensatz). (Überschreibt CmdletProcessRecord().)
Geschützte Methode RequireLocalFarmExist Dient zum Abrufen oder Festlegen eines booleschen Werts, das angibt, ob eine lokale Farm vorhanden sein muss, bevor das Cmdlet ausgeführt werden kann.
Geschützte Methode RequireUserFarmAdmin Gibt an, ob ein Cmdlet auf Farmebene Administratorrechte zum Ausführen von benötigen.
Geschützte Methode RequireUserMachineAdmin Gibt an, ob ein Cmdlet Administratorrechte auf dem Computer, auf denen er ausgeführt wird.
Geschützte Methode SetProp Nur zur internen Verwendung. Verwenden Sie nicht.
Öffentliche Methode ShouldContinue(String, String) (Geerbt von Cmdlet.)
Öffentliche Methode ShouldContinue(String, String, Boolean, Boolean) (Geerbt von Cmdlet.)
Öffentliche Methode ShouldProcess(String) (Geerbt von Cmdlet.)
Öffentliche Methode ShouldProcess(String, String) (Geerbt von Cmdlet.)
Öffentliche Methode ShouldProcess(String, String, String) (Geerbt von Cmdlet.)
Öffentliche Methode ShouldProcess(String, String, String, ShouldProcessReason) (Geerbt von Cmdlet.)
Geschützte Methode SkipProcessCurrentRecord Bietet eine Möglichkeit zum Beenden der Verarbeitung eines bestimmten Datensatzes und zum Überspringen diesen Datensatzes zum nächsten.
Geschützte Methode StopProcessing Beendet tragen Verarbeitung in Fällen, in denen der Benutzer das Cmdlet asynchron beendet. Diese Methode wird von PowerShell aufgerufen, wenn der Benutzer die Tasten Strg + C. eintritt (Überschreibt CmdletStopProcessing().)
Öffentliche Methode ThrowTerminatingError(ErrorRecord) (Geerbt von Cmdlet.)
Geschützte Methode ThrowTerminatingError(Exception, ErrorCategory, Object) Gibt die Details eines Fehlers Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei.
Geschützte Methode ThrowTerminatingError(Exception, ErrorCategory, Object, String) Gibt die Details eines Fehlers Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei.
Öffentliche Methode ToString (Geerbt von Object.)
Öffentliche Methode TransactionAvailable (Geerbt von Cmdlet.)
Öffentliche Methode WriteCommandDetail (Geerbt von Cmdlet.)
Öffentliche Methode WriteDebug (Geerbt von Cmdlet.)
Öffentliche Methode WriteError(ErrorRecord) (Geerbt von Cmdlet.)
Geschützte Methode WriteError(Exception, ErrorCategory, Object) Gibt die Details der Fehler nicht zum Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei.
Geschützte Methode WriteError(Exception, ErrorCategory, Object, String) Gibt die Details der Fehler nicht zum Abbruch auf dem Bildschirm als Fehlermeldung und protokolliert die Details in der Protokolldatei.
Öffentliche Methode WriteObject(Object) (Geerbt von Cmdlet.)
Öffentliche Methode WriteObject(Object, Boolean) (Geerbt von Cmdlet.)
Öffentliche Methode WriteProgress(ProgressRecord) (Geerbt von Cmdlet.)
Geschützte Methode WriteProgress(String, String) Schreibt Fortschrittsinformationen auf dem Bildschirm zu im Zusammenhang mit dem Cmdlet ausführen.
Geschützte Methode WriteProgress(String, String, Int32) Schreibt Fortschrittsinformationen auf dem Bildschirm zu im Zusammenhang mit dem Cmdlet ausführen.
Geschützte Methode WriteResult Zeigt eine Objektinstanz und schreibt sie auf dem Konsolenbildschirm oder in der Pipeline Cmdlet.
Öffentliche Methode WriteVerbose (Geerbt von Cmdlet.)
Öffentliche Methode WriteWarning(String) (Geerbt von Cmdlet.)
Geschützte Methode WriteWarning(String, String) Bietet eine Möglichkeit zum Anzeigen von dem Benutzer einer Warnmeldung angezeigt.

Oben

Siehe auch

Referenz

SPCmdlet Klasse

Microsoft.SharePoint.PowerShell-Namespace