Einfaches Beispiel für Auflisten, Erstellen, Ändern und Löschen

Artikel
04/04/2023

Das folgende Beispiel zeigt eine Reihe von sehr einfachen Methoden, die die SMS_Package -Klasse verwenden, um Listen-, Create-, Modify- und Delete-Vorgänge mithilfe des SMS-Anbieters zu veranschaulichen. Dies ist ein Blick auf die Struktur eines grundlegenden Configuration Manager-Programms – es gibt nützlichere Methodenausschnitte in anderen Bereichen des SDK, die bestimmte Aufgaben ausführen.

Wichtig

Zur Vereinfachung des Codebeispiels werden einige Methoden auskommentiert, da sie zusätzliche Informationen (einen vorhandenen Paketbezeichner) benötigen. Verwenden Sie die ListPackages -Methode, um den Paketbezeichner für die Verwendung mit den ModifyPackage Methoden und DeletePackage abzurufen.

So listen Sie Pakete auf

Richten Sie eine Verbindung mit dem SMS-Anbieter ein.
Führen Sie eine Abfrage aus, die eine Variable mit einer Auflistung von SMS_Package Klasseninstanzen auffüllt.
Listen Sie die Auflistung auf, und listen Sie die pakete auf, die von der Abfrage zurückgegeben werden.

So erstellen Sie ein Paket

Richten Sie eine Verbindung mit dem SMS-Anbieter ein.
Erstellen Sie das neue Paketobjekt mithilfe der SMS_Package -Klasse.
Füllen Sie die neuen Paketeigenschaften auf.
Speichern Sie das Paket.

So ändern Sie ein Paket

Richten Sie eine Verbindung mit dem SMS-Anbieter ein.
Laden Sie das vorhandene Paketobjekt mithilfe der SMS_Package -Klasse.
Ändern sie eine Paketeigenschaft.
Speichern Sie das Paket.

So löschen Sie ein Paket

Richten Sie eine Verbindung mit dem SMS-Anbieter ein.
Laden Sie das vorhandene Paketobjekt mithilfe der SMS_Package -Klasse.
Löschen Sie das Paket mithilfe der Delete-Methode.

Beispiel

Die folgende Beispielmethode zeigt eine Reihe von sehr einfachen Methoden, die die -Klasse verwenden SMS_Package , um Listen-, Create-, Modify- und Delete-Vorgänge mithilfe des SMS-Anbieters zu veranschaulichen.

Informationen zum Aufrufen des Beispielcodes finden Sie unter Aufrufen von Configuration Manager Codeausschnitten.

Hinweis

Im folgenden Beispiel wird der aufrufende Code in den Code eingebettet. Die meisten anderen Beispiele im SDK zeigen einfach eine Methode mit Parametern an.


using System;  
using System.Collections.Generic;  
using System.Linq;  
using System.Text;  
using System.Threading.Tasks;  

// Added the below Configuration Manager DLL references to support basic SMS Provider operations:  
//    C:\Program Files (x86)\Microsoft Endpoint Manager\AdminConsole\bin\Microsoft.ConfigurationManagement.ManagementProvider.dll  
//    C:\Program Files (x86)\Microsoft Endpoint Manager\AdminConsole\bin\AdminUI.WqlQueryEngine.dll  
// Added the below Configuration Manager namespaces to support basic SMS Provider operations:  
      using Microsoft.ConfigurationManagement.ManagementProvider;                    
      using Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine;     

//  
// A set of very basic methods using the SMS_Package class to demonstrate List, Create, Modify and Delete operations using the SMS Provider.  
//   
// Note: To simplify the code example, some methods are commented out, as they need additional information (an existing package identifier).   
// Use the ListPackages method to obtain the package identifier for use with the ModifyPackage and DeletePackage methods.   
//  
namespace BasicApp  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            // Setup Objects  
            SnippetClass BasicCMAppSnippets = new SnippetClass();  

            // Setup a connection to the SMS Provider.  
            // Passing in <server name>, <domain\\account>, <password>.   
            WqlConnectionManager WMIConnection = BasicCMAppSnippets.Connect("CMLABSERVER", "CMLABSERVER\\cmlabuser", "password");  

            // List all packages (instances of SMS_Package).  
            BasicCMAppSnippets.ListPackages(WMIConnection);  

            // Create a new package.  
            // Note: This is not a useful package (too few properties), just a demonstration of creating a Configuration Manager object.  
            BasicCMAppSnippets.CreatePackage(WMIConnection, "New Package", "This is the new package.");  

            // Modifies a specific package (instance of SMS_Package).  
            // A valid PackageID needs to be passed to the ModifyPackage method - replace "ABC00000".  
            //BasicCMAppSnippets.ModifyPackage(WMIConnection, "ABC00000");  

            // Deletes a specific package (instance of SMS_Package).  
            // A valid PackageID needs to be passed to the DeletePackage method - replace "ABC00000".  
            //BasicCMAppSnippets.DeletePackage(WMIConnection, "ABC00000");  

            // Delay to keep the console output visible.  
            Console.ReadLine();  
        }  
    }  

    class SnippetClass  
    {  
        public WqlConnectionManager Connect(string serverName, string userName, string userPassword)  
        {  
            try  
            {  
                SmsNamedValuesDictionary namedValues = new SmsNamedValuesDictionary();  
                WqlConnectionManager connection = new WqlConnectionManager(namedValues);  
                if (System.Net.Dns.GetHostName().ToUpper() == serverName.ToUpper())  
                {  
                    connection.Connect(serverName);  
                }  
                else  
                {  
                    connection.Connect(serverName, userName, userPassword);  
                }  
                return connection;  
            }  
            catch (SmsException ex)  
            {  
                Console.WriteLine("Failed to connect. Error: " + ex.Message);  
                return null;  

            }  
            catch (UnauthorizedAccessException ex)  
            {  
                Console.WriteLine("Failed to authenticate. Error:" + ex.Message);  
                throw;  
            }  
        }  

        public void ListPackages(WqlConnectionManager connection)  
        {  
            try  
            {  
                // This query selects all packages (instances of SMS_Package).  
                string query = "SELECT * FROM SMS_Package";  

                // Run query, which populates 'listOfPackages' with a collection of package objects.   
                IResultObject listOfPackages = connection.QueryProcessor.ExecuteQuery(query);  

                // Output header for list of distribution points.  
                Console.WriteLine(" ");   
                Console.WriteLine("List of packages:  ");  
                Console.WriteLine("-------------------");  

                // Enumerate through the collection of objects returned by the query.  
                foreach (IResultObject package in listOfPackages)  
                {  
                    // Output the package name for each package object.  
                    Console.WriteLine("Package ID: {0} Package Name: {1}", package["PackageID"].StringValue, package["Name"].StringValue);    
                }  
            }  
            catch (SmsException ex)  
            {  
                Console.WriteLine("Failed to list packages. Error: " + ex.Message);  
                throw;  
            }  
        }  

        public void CreatePackage(WqlConnectionManager connection, string newPackageName, string newPackageDescription)  
        {  
            try  
            {  
                // Create new package object.  
                IResultObject newPackage = connection.CreateInstance("SMS_Package");  

                // Populate new package properties.  
                newPackage["Name"].StringValue = newPackageName;  
                newPackage["Description"].StringValue = newPackageDescription;  

                // Save the new package and the new package properties.  
                newPackage.Put();  
                // The key value 'PackageID' is created on the put, so getting the package object to output the unique 'PackageID' ('Name' is not guaranteed to be unique).   
                newPackage.Get();  

                // Output new package name.  
                Console.WriteLine("Created Package ID: {0} Package Name: {1}", newPackage["PackageID"].StringValue, newPackage["Name"].StringValue);    
            }  
            catch (SmsException ex)  
            {  
                Console.WriteLine("Failed to create package. Error: " + ex.Message);  
                throw;  
            }  
        }  

        public void ModifyPackage(WqlConnectionManager connection, string existingPackageID)  
        {  
            try  
            {  
                // Get the specific package instance to modify (PackageID is a key value).   
                IResultObject packageToModify = connection.GetInstance(@"SMS_Package.PackageID='" + existingPackageID + "'");  

                // Modify a package properties (in this case description).  
                packageToModify["Description"].StringValue = "This package has been modified. " + packageToModify["Description"].StringValue;  

                // Save the new package and the new package properties.  
                packageToModify.Put();  
            }  
            catch (SmsException ex)  
            {  
                Console.WriteLine("Failed to delete package. Error: " + ex.Message);  
                throw;  
            }  
        }  

        public void DeletePackage(WqlConnectionManager connection, string existingPackageID)  
        {  
            try  
            {                  
                // Get the specific package instance to delete (PackageID is a key value).   
                IResultObject packageToDelete = connection.GetInstance(@"SMS_Package.PackageID='" + existingPackageID + "'");  

                // Output package ID and name being deleted.  
                Console.WriteLine("Deleting Package ID: {0} Package Name: {1}", packageToDelete["PackageID"].StringValue, packageToDelete["Name"].StringValue);       

                // Delete the package.  
                packageToDelete.Delete();             
            }  
            catch (SmsException ex)  
            {  
                Console.WriteLine("Failed to delete package. Error: " + ex.Message);  
                throw;  
            }  
        }  

    }  
}

Die Beispielmethode verfügt über die folgenden Parameter:

Parameter	Typ	Beschreibung
`connection`	-Verwalteten: `WqlConnectionManager`	Eine gültige Verbindung mit dem SMS-Anbieter.
`newPackageName`	-Verwalteten: `String`	Der Name des neuen Pakets.
`newPackageDescription`	-Verwalteten: `String`	Die Beschreibung für das neue Paket.
`existingPackageID`	-Verwalteten: `String`	Ein vorhandener Paketbezeichner. Dies ist ein Schlüsselwert für die `SMS_Package` -Klasse und wird verwendet, um eine bestimmte Instanz der `SMS_Package` -Klasse zurückzugeben. Die ListPackages-Methode im obigen Beispiel gibt die Namen und PackageIDs der aktuellen Paketinstanzen zurück.

Kompilieren des Codes

Für das C#-Beispiel ist Folgendes erforderlich:

Namespaces

System

Microsoft. ConfigurationManagement.ManagementProvider

Microsoft. ConfigurationManagement.ManagementProvider.WqlQueryEngine

Assembly

adminui.wqlqueryengine

microsoft.configurationmanagement.managementprovider

Mscorlib

Robuste Programmierung

Weitere Informationen zur Fehlerbehandlung finden Sie unter Informationen zu Configuration Manager Fehlern.

Siehe auch

Übersicht über die Softwareverteilung SMS_Package WMI-Serverklasse