Exemple simple de liste, créer, modifier et supprimer

L’exemple suivant montre un ensemble de méthodes très basiques utilisant la classe pour illustrer les SMS_Package opérations de liste, de création, de modification et de suppression à l’aide du fournisseur SMS. Il s’agit d’un aperçu de la structure d’un programme Configuration Manager de base – il existe des extraits de méthode plus utiles dans d’autres domaines du Kit de développement logiciel (SDK) qui accomplissent des tâches spécifiques.

Vers la liste des packages

1. Établissez une connexion au fournisseur SMS.

2. Exécutez une requête qui remplit une variable avec une collection d’instances de SMS_Package classe.

3. Énumérer dans la collection et lister les packages retournés par la requête.

Pour créer un package

1. Établissez une connexion au fournisseur SMS.

2. Créez le nouvel objet de package à l’aide de la SMS_Package classe.

3. Remplissez les propriétés du nouveau package.

4. Enregistrez le colis.

Pour modifier un package

1. Établissez une connexion au fournisseur SMS.

2. Chargez l’objet de package existant à l’aide de la SMS_Package classe.

3. Modifier une propriété de package.

4. Enregistrez le colis.

Pour supprimer un package

1. Établissez une connexion au fournisseur SMS.

2. Chargez l’objet de package existant à l’aide de la SMS_Package classe.

3. Supprimez le package à l’aide de la méthode delete.

Exemple

L’exemple de méthode suivant montre un ensemble de méthodes très basiques utilisant SMS_Package une classe pour illustrer les opérations de liste, de création, de modification et de suppression à l’aide du fournisseur SMS.

Pour plus d’informations sur l’appel de l’exemple de code, consultez Appel d’extraits de code de Configuration Manager.

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

    }
}

L’exemple de méthode contient les paramètres suivants :

Compilation du code

L’exemple C# requiert :

Espaces de noms

Système

Microsoft.ConfigurationManagement.ManagementProvider

Microsoft.ConfigurationManagement.ManagementProvider.WqlQueryEngine

Assembly

adminui.wqlqueryengine

Microsoft.ConfigurationManagement.ManagementProvider

mscorlib

Programmation robuste

Pour plus d’informations sur la gestion des erreurs, voir À propos des erreurs du Configuration Manager.

Voir aussi

Présentation de la distribution de logicielsSMS_Package classe WMI Server