ESimProfile Class

Definition

Namespace:

Windows.Networking.NetworkOperators

A class that represents an eSIM profile, which is a subscriber identity associated with a mobile network operator (MNO).

Note

This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.

public ref class ESimProfile sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 393216)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class ESimProfile final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 393216)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class ESimProfile

Public NotInheritable Class ESimProfile

Inheritance

Object Platform::Object IInspectable ESimProfile

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10, version 1803 (introduced in 10.0.17134.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v6.0)
App capabilities	Microsoft.eSIMManagement_8wekyb3d8bbwe

Properties

Class	Gets the class of the eSIM profile (either Operational, Test, or Provisioning). Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
Id	Gets the identification number (an ICCID) of the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
Nickname	Gets the nickname of the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
Policy	Gets the policy for the eSIM profile, regarding whether the profile can be disabled and/or deleted, and whether the policy is enterprise-managed. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderIcon	Gets a memory buffer containing the icon of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderId	Gets the identifier (an MCC/MNC tuple) of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
ProviderName	Gets the name of the mobile network operator (MNO) provider for the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
State	Gets the state of the eSIM profile, which indicates the presence and enabled status of the profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.

Methods

DisableAsync()	Asynchronously disables the eSIM profile so that it's no longer in use. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
EnableAsync()	Asynchronously enables the eSIM profile so that it's in use. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.
SetNicknameAsync(String)	Asynchronously sets the nickname of the eSIM profile. Note This functionality is available only to mobile operator apps and UWP apps given privileged access by mobile network operators. If you want to use this API and publish your app to the Microsoft Store, then you'll need to request special approval to use the custom capability Microsoft.eSIMManagement_8wekyb3d8bbwe. For more info, see Custom capabilities.