Egyszerű példa listára, létrehozásra, módosításra és törlésre

2023-04-04

Az alábbi példa nagyon alapszintű metódusokat mutat be, amelyek a osztály használatával mutatják be a SMS_Package List, Create, Modify és Delete műveleteket az SMS Provider használatával. Ez egy alapszintű Configuration Manager-program struktúráját vizsgálja – az SDK más területein is vannak hasznosabb metódusrészletek, amelyek konkrét feladatokat végeznek el.

Fontos

A példakód egyszerűsítése érdekében egyes metódusok megjegyzéseket fűznek hozzá, mivel további információkra (egy meglévő csomagazonosítóra) van szükségük. A metódussal ListPackages szerezze be a csomagazonosítót a és DeletePackage metódusokkal ModifyPackage való használathoz.

Csomagok listázása

Állítson be egy kapcsolatot az SMS-szolgáltatóval.
Futtasson egy lekérdezést, amely feltölt egy változót osztálypéldányok gyűjteményével SMS_Package .
Számbavétel a gyűjteményen keresztül, és a lekérdezés által visszaadott csomagok listázása.

Csomag létrehozása

Állítson be egy kapcsolatot az SMS-szolgáltatóval.
Hozza létre az új csomagobjektumot a SMS_Package osztály használatával.
Töltse ki az új csomag tulajdonságait.
Mentse a csomagot.

Csomag módosítása

Állítson be egy kapcsolatot az SMS-szolgáltatóval.
Töltse be a meglévő csomagobjektumot a SMS_Package osztály használatával.
Csomagtulajdonság módosítása.
Mentse a csomagot.

Csomag törlése

Állítson be egy kapcsolatot az SMS-szolgáltatóval.
Töltse be a meglévő csomagobjektumot a SMS_Package osztály használatával.
Törölje a csomagot a delete metódussal.

Példa

Az alábbi példametódus nagyon alapszintű metódusokat mutat be, amelyek osztály használatával SMS_Package mutatják be a List, Create, Modify és Delete műveleteket az SMS Provider használatával.

A mintakód meghívásával kapcsolatos információkért lásd: Configuration Manager Kódrészletek hívása.

Megjegyzés:

Az alábbi példa beágyazza a hívó kódot a kódba. Az SDK-ban a legtöbb más példa egyszerűen egy paraméterekkel rendelkező metódust mutat be.


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

    }
}

A példametódus a következő paraméterekkel rendelkezik:

Paraméter	Típus	Leírás
`connection`	-Kezelt: `WqlConnectionManager`	Érvényes kapcsolat az SMS-szolgáltatóval.
`newPackageName`	-Kezelt: `String`	Az új csomag neve.
`newPackageDescription`	-Kezelt: `String`	Az új csomag leírása.
`existingPackageID`	-Kezelt: `String`	Egy meglévő csomagazonosító. Ez a `SMS_Package` osztály kulcsértéke, és az osztály egy adott példányát `SMS_Package` adja vissza. A fenti mintában szereplő ListPackages metódus az aktuális csomagpéldányok nevét és PackageID azonosítóját adja vissza.

A kód fordítása

A C#-példához a következőre van szükség:

Névterek

Rendszer

Microsoft.ConfigurationManagement.ManagementProvider

Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine

Összeszerelés

adminui.wqlqueryengine

microsoft.configurationmanagement.managementprovider

mscorlib

Robusztus programozás

A hibakezeléssel kapcsolatos további információkért lásd: A Configuration Manager hibák ismertetése.

Lásd még

A szoftverterjesztés áttekintése SMS_Package kiszolgálói WMI-osztályban