Prosty przykład listy, tworzenia, modyfikowania i usuwania

Artykuł
04/04/2023

W poniższym przykładzie przedstawiono zestaw bardzo podstawowych metod używających SMS_Package klasy do zademonstrowania operacji List, Create, Modify i Delete przy użyciu dostawcy programu SMS. Jest to spojrzenie na strukturę podstawowego programu Configuration Manager — w innych obszarach zestawu SDK istnieją bardziej przydatne fragmenty kodu metody, które umożliwiają wykonywanie określonych zadań.

Ważna

Aby uprościć przykład kodu, niektóre metody są skomentowane, ponieważ wymagają dodatkowych informacji (istniejącego identyfikatora pakietu). Użyj metody , ListPackages aby uzyskać identyfikator pakietu do użycia z ModifyPackage metodami i DeletePackage .

Aby wyświetlić listę pakietów

Skonfiguruj połączenie z dostawcą programu SMS.
Uruchom zapytanie, które wypełnia zmienną kolekcją wystąpień SMS_Package klas.
Wylicz za pomocą kolekcji i wyświetl listę pakietów zwróconych przez zapytanie.

Aby utworzyć pakiet

Skonfiguruj połączenie z dostawcą programu SMS.
Utwórz nowy obiekt pakietu przy użyciu SMS_Package klasy .
Wypełnij nowe właściwości pakietu.
Zapisz pakiet.

Aby zmodyfikować pakiet

Skonfiguruj połączenie z dostawcą programu SMS.
Załaduj istniejący obiekt pakietu przy użyciu SMS_Package klasy .
Modyfikowanie właściwości pakietu.
Zapisz pakiet.

Aby usunąć pakiet

Skonfiguruj połączenie z dostawcą programu SMS.
Załaduj istniejący obiekt pakietu przy użyciu SMS_Package klasy .
Usuń pakiet przy użyciu metody delete.

Przykład

Poniższa przykładowa metoda pokazuje zestaw bardzo podstawowych metod używających SMS_Package klasy do zademonstrowania operacji Lista, Tworzenie, Modyfikowanie i Usuwanie przy użyciu dostawcy programu SMS.

Aby uzyskać informacje na temat wywoływania przykładowego kodu, zobacz Wywoływanie fragmentów kodu Configuration Manager.

Uwaga

Poniższy przykład osadza kod wywołujący w kodzie. W większości innych przykładów w zestawie SDK wystarczy pokazać metodę z parametrami.


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;  
            }  
        }  

    }  
}

Przykładowa metoda ma następujące parametry:

Parametr	Wpisać	Opis
`connection`	-Zarządzane: `WqlConnectionManager`	Prawidłowe połączenie z dostawcą programu SMS.
`newPackageName`	-Zarządzane: `String`	Nazwa nowego pakietu.
`newPackageDescription`	-Zarządzane: `String`	Opis nowego pakietu.
`existingPackageID`	-Zarządzane: `String`	Istniejący identyfikator pakietu. Jest to wartość klucza `SMS_Package` dla klasy i służy do zwracania określonego `SMS_Package` wystąpienia klasy. Metoda ListPackages w powyższym przykładzie zwraca nazwy i identyfikatory PackageID bieżących wystąpień pakietu.

Kompilowanie kodu

Przykład języka C# wymaga:

Obszary nazw

System

Microsoft. ConfigurationManagement.ManagementProvider

Microsoft. ConfigurationManagement.ManagementProvider.WqlQueryEngine

Zestawu

adminui.wqlqueryengine

microsoft.configurationmanagement.managementprovider

Mscorlib

Niezawodne programowanie

Aby uzyskać więcej informacji na temat obsługi błędów, zobacz Informacje o błędach Configuration Manager.

Zobacz też

Omówienie dystrybucji oprogramowania SMS_Package Server WMI Class (Klasa WMI serwera)