Jednoduchý příklad výpisu, vytvoření, úpravy a odstranění

Článek
04/04/2023

Následující příklad ukazuje sadu velmi základních metod, které používají SMS_Package třídu k předvedení operací List, Create, Modify a Delete pomocí poskytovatele serveru SMS. Toto je pohled na strukturu základního programu Configuration Manager – v jiných oblastech sady SDK, které provádí konkrétní úlohy, existují užitečnější fragmenty metod.

Důležité

Pro zjednodušení příkladu kódu jsou některé metody zakomentovány, protože potřebují další informace (existující identifikátor balíčku). Použijte metodu ListPackages k získání identifikátoru balíčku pro použití s metodami ModifyPackage a DeletePackage .

Zobrazení seznamu balíčků

Nastavte připojení k poskytovateli serveru SMS.
Spusťte dotaz, který naplní proměnnou kolekcí SMS_Package instancí třídy.
Vytvořte výčet prostřednictvím kolekce a vypište balíčky vrácené dotazem.

Vytvoření balíčku

Nastavte připojení k poskytovateli serveru SMS.
Vytvořte nový objekt balíčku pomocí SMS_Package třídy .
Naplňte nové vlastnosti balíčku.
Uložte balíček.

Úprava balíčku

Nastavte připojení k poskytovateli serveru SMS.
Načtěte existující objekt balíčku pomocí SMS_Package třídy .
Úprava vlastnosti balíčku
Uložte balíček.

Odstranění balíčku

Nastavte připojení k poskytovateli serveru SMS.
Načtěte existující objekt balíčku pomocí SMS_Package třídy .
Odstraňte balíček pomocí metody delete.

Příklad

Následující ukázková metoda ukazuje sadu velmi základních metod pomocí SMS_Package třídy k předvedení operací List, Create, Modify a Delete pomocí poskytovatele serveru SMS.

Informace o volání ukázkového kódu najdete v tématu Volání Configuration Manager fragmentů kódu.

Poznámka

Následující příklad vloží kód volání do kódu. Většina ostatních příkladů v sadě SDK jednoduše ukazuje metodu s parametry.


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

    }  
}

Ukázková metoda má následující parametry:

Parametr	Typ	Popis
`connection`	-Spravované: `WqlConnectionManager`	Platné připojení k poskytovateli serveru SMS.
`newPackageName`	-Spravované: `String`	Název nového balíčku.
`newPackageDescription`	-Spravované: `String`	Popis nového balíčku
`existingPackageID`	-Spravované: `String`	Identifikátor existujícího balíčku. Toto je hodnota klíče pro `SMS_Package` třídu a slouží k vrácení konkrétní instance `SMS_Package` třídy. Metoda ListPackages ve výše uvedené ukázce vrátí názvy a Id balíčků aktuálních instancí balíčků.

Kompilace kódu

Příklad jazyka C# vyžaduje:

Obory názvů

Systému

Microsoft. ConfigurationManagement.ManagementProvider

Microsoft. ConfigurationManagement.ManagementProvider.WqlQueryEngine

Sestavení

adminui.wqlqueryengine

microsoft.configurationmanagement.managementprovider

Mscorlib

Robustní programování

Další informace o zpracování chyb najdete v tématu Informace o chybách Configuration Manager.

Viz taky

Přehled distribuce softwaru SMS_Package serverová třída služby WMI

Sdílet prostřednictvím