What is the administration service in Configuration Manager?

Applies to: Configuration Manager (current branch)

The SMS Provider provides API interoperability access over HTTPS, called the administration service. The administration service is a representational state transfer (REST) API based on the Open Data (OData) v4 protocol.

Tip

This feature was first introduced in version 1810 as a pre-release feature. Beginning with version 1906, it's no longer a pre-release feature.

The administration service currently has two layers or routes:

  • Administration service > WMI > SQL: https://<SMSProviderFQDN>/AdminService/wmi/<ClassName>

    The WMI route supports both GET and POST commands to over 700 classes.

  • Administration service > OData/SQL: https://<SMSProviderFQDN>/AdminService/v1.0/<ClassName>

    This versioned route (v1.0) supports new Configuration Manager functionality.

The <ClassName> value is a valid Configuration Manager class name. The administration service class names are case-sensitive. Make sure to use the proper capitalization. For example, SMS_Site.

Note

In Configuration Manager version 1810, this class name didn't include the SMS_ prefix. In version 1902 and later, for better consistency, the administration service class names are the same as the WMI class names.

Scenarios

Configuration Manager natively uses the administration service for the following features:

In addition, you can develop custom solutions with the administration service, for example:

Prerequisites

Configure the following prerequisites on the server that hosts the SMS Provider role:

  • Enable Windows server role Web Server (IIS)

  • Install the .NET Framework version 4.5 or later.

    Note

    Configuration Manager version 1810 requires .NET 4.5.2 or later.

  • Enable secure HTTPS communication with a trusted certificate. For more information, see Enable secure HTTPS communication.

To access the administration service, your user account needs to be an administrative user in Configuration Manager. If you access the administration service via a cloud management gateway, you need to have an account in Azure Active Directory (Azure AD).

Next steps