Eenvoudig voorbeeld van lijst, maken, wijzigen en verwijderen
In het volgende voorbeeld ziet u een reeks zeer eenvoudige methoden die de SMS_Package klasse gebruiken om list-, create-, modify- en delete-bewerkingen te demonstreren met behulp van de SMS-provider. Dit is een blik op de structuur van een eenvoudig Configuration Manager-programma: er zijn nuttigere methodefragmenten op andere gebieden van de SDK waarmee specifieke taken worden uitgevoerd.
Belangrijk
Om het codevoorbeeld te vereenvoudigen, worden sommige methoden weggelaten, omdat ze aanvullende informatie (een bestaande pakket-id) nodig hebben. Gebruik de ListPackages methode om de pakket-id op te halen voor gebruik met de ModifyPackage methoden en DeletePackage .
Pakketten weergeven
Een verbinding met de SMS-provider instellen.
Voer een query uit, waarmee een variabele wordt gevuld met een verzameling
SMS_Packageklasse-exemplaren.Inventariseer de verzameling en maak een lijst met de pakketten die door de query worden geretourneerd.
Een pakket maken
Een verbinding met de SMS-provider instellen.
Maak het nieuwe pakketobject met behulp van de
SMS_Packageklasse.Vul de eigenschappen van het nieuwe pakket in.
Sla het pakket op.
Een pakket wijzigen
Een verbinding met de SMS-provider instellen.
Laad het bestaande pakketobject met behulp van de
SMS_Packageklasse.Een pakketeigenschap wijzigen.
Sla het pakket op.
Een pakket verwijderen
Een verbinding met de SMS-provider instellen.
Laad het bestaande pakketobject met behulp van de
SMS_Packageklasse.Verwijder het pakket met behulp van de verwijdermethode.
Voorbeeld
In de volgende voorbeeldmethode ziet u een set zeer eenvoudige methoden die gebruikmaken SMS_Package van klasse om list-, create-, modify- en delete-bewerkingen met behulp van de SMS-provider te demonstreren.
Zie Aanroepen Configuration Manager codefragmenten voor meer informatie over het aanroepen van de voorbeeldcode.
Opmerking
In het onderstaande voorbeeld wordt de aanroepende code ingesloten in de code. De meeste andere voorbeelden in SDK de tonen gewoon een methode met parameters.
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;
}
}
}
}
De voorbeeldmethode heeft de volgende parameters:
| Parameter | Type | Beschrijving |
|---|---|---|
connection |
-Beheerd: WqlConnectionManager |
Een geldige verbinding met de SMS-provider. |
newPackageName |
-Beheerd: String |
De naam van het nieuwe pakket. |
newPackageDescription |
-Beheerd: String |
De beschrijving van het nieuwe pakket. |
existingPackageID |
-Beheerd: String |
Een bestaande pakket-id. Dit is een sleutelwaarde voor de SMS_Package klasse en wordt gebruikt om een specifiek exemplaar van de SMS_Package klasse te retourneren. De methode ListPackages in het bovenstaande voorbeeld retourneert de namen en PackageID's van de huidige pakketexemplaren. |
De code compileren
Voor het C#-voorbeeld is het volgende vereist:
Naamruimten
Systeem
Microsoft. ConfigurationManagement.ManagementProvider
Microsoft. ConfigurationManagement.ManagementProvider.WqlQueryEngine
Vergadering
adminui.wqlqueryengine
microsoft.configurationmanagement.managementprovider
mscorlib
Robuust programmeren
Zie Over Configuration Manager fouten voor meer informatie over foutafhandeling.
Zie ook
Feedback
Binnenkort: Gedurende 2024 worden GitHub Issues uitgefaseerd als het feedbackmechanisme voor inhoud. Dit wordt vervangen door een nieuw feedbacksysteem. Ga voor meer informatie naar: https://aka.ms/ContentUserFeedback.
Feedback verzenden en bekijken voor