ProvisioningAgent ProvisioningAgent ProvisioningAgent ProvisioningAgent Class

Definition

Namespace:: Windows.Networking.NetworkOperators Windows.Networking.NetworkOperators Windows.Networking.NetworkOperators Windows.Networking.NetworkOperators

Edit

Represents an agent that provisions connectivity and subscription information with a network provider.

Note

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

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : sealed class ProvisioningAgent : IProvisioningAgentpublic sealed class ProvisioningAgent : IProvisioningAgentPublic NotInheritable Class ProvisioningAgent Implements IProvisioningAgent// You can use this class in JavaScript.

Attributes: ActivatableAttribute ContractVersionAttribute DualApiPartitionAttribute StaticAttribute ThreadingAttribute

Windows 10 requirements

Device family	Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities	networkDataPlanProvisioning

Constructors

ProvisioningAgent() ProvisioningAgent() ProvisioningAgent() ProvisioningAgent()

Edit

Creates a new instance of a ProvisioningAgent.

Note

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

public : ProvisioningAgent()public ProvisioningAgent()Public Sub New()// You can use this method in JavaScript.

Additional features and requirements

Device family	Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities	networkDataPlanProvisioning networkDataPlanProvisioning

Methods

CreateFromNetworkAccountId(String) CreateFromNetworkAccountId(String) CreateFromNetworkAccountId(String) CreateFromNetworkAccountId(String)

Edit

Creates a provisioning agent for the mobile device associated with the supplied network account ID.

Note

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

public : static ProvisioningAgent CreateFromNetworkAccountId(PlatForm::String networkAccountId)public static ProvisioningAgent CreateFromNetworkAccountId(String networkAccountId)Public Static Function CreateFromNetworkAccountId(networkAccountId As String) As ProvisioningAgent// You can use this method in JavaScript.

Parameters

networkAccountId: PlatForm::String String String String

The network account ID to use to select the corresponding mobile broadband device to use for the provisioning agent.

Returns

ProvisioningAgent ProvisioningAgent ProvisioningAgent ProvisioningAgent

The provisioning agent for the mobile device associated with the supplied network account ID.

Additional features and requirements

Device family	Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities	networkDataPlanProvisioning

GetProvisionedProfile(ProfileMediaType, String) GetProvisionedProfile(ProfileMediaType, String) GetProvisionedProfile(ProfileMediaType, String) GetProvisionedProfile(ProfileMediaType, String)

Edit

Retrieves cost and plan information associated with the mobile broadband profile.

Note

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

public : ProvisionedProfile GetProvisionedProfile(ProfileMediaType mediaType, PlatForm::String profileName)public ProvisionedProfile GetProvisionedProfile(ProfileMediaType mediaType, String profileName)Public Function GetProvisionedProfile(mediaType As ProfileMediaType, profileName As String) As ProvisionedProfile// You can use this method in JavaScript.

Parameters

mediaType: ProfileMediaType ProfileMediaType ProfileMediaType ProfileMediaType

The media type that the profile belongs to.

profileName: PlatForm::String String String String

The name of the profile that the cost will be applied to.

Returns

ProvisionedProfile ProvisionedProfile ProvisionedProfile ProvisionedProfile

The profile.

Additional features and requirements

Device family	Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities	networkDataPlanProvisioning

ProvisionFromXmlDocumentAsync(String) ProvisionFromXmlDocumentAsync(String) ProvisionFromXmlDocumentAsync(String) ProvisionFromXmlDocumentAsync(String)

Edit

Provisions a device for network connectivity asynchronously, based on the supplied XML document.

Note

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

public : IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(PlatForm::String provisioningXmlDocument)public IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(String provisioningXmlDocument)Public Function ProvisionFromXmlDocumentAsync(provisioningXmlDocument As String) As IAsyncOperation( Of ProvisionFromXmlDocumentResults )// You can use this method in JavaScript.

Parameters

provisioningXmlDocument: PlatForm::String String String String

An instance of CarrierControlSchema that contains the network connectivity provisioning information.

Returns

IAsyncOperation<ProvisionFromXmlDocumentResults> IAsyncOperation<ProvisionFromXmlDocumentResults> IAsyncOperation<ProvisionFromXmlDocumentResults> IAsyncOperation<ProvisionFromXmlDocumentResults>

An asynchronous handler to start the provisioning attempt and track its completion.

Additional features and requirements

Device family	Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities	networkDataPlanProvisioning

Remarks

You can retrieve the results of the provisioning attempt using the ProvisionResultsXml method when the provisioning attempt has completed.

ProvisionFromXmlDocumentAsync returns critical errors as HRESULTs that are then translated into exceptions. The most common HRESULTs returned are listed below:

Name	HRESULT	Description
E_ACCESSDENIED	0x80070005L	Caller is an operator app, but attempted to provision a different operator’s profiles
PROVCORE_E_XML_MALFORMED	0x82170001	Provisioning file is not well-formed XML
PROVCORE_E_XML_INVALID	0x82170002	Provisioning file does not conform to schema
PROVCORE_E_XML_SIGNATURE_INVALID	0x82170003	Provisioning file signature is invalid
PROVCORE_E_XML_SIGNATURE_UNTRUSTED	0x82170004	Signing certificate is not chained to a trusted root CA
PROVCORE_E_XML_DIGEST_INVALID	0x82170005	Provisioning file was modified after being signed
PROVCORE_E_XML_SIGNER_UNTRUSTED	0x82170006	User did not approve provisioning from this certificate.
PROVCORE_E_NO_LEAF_CERT	0x82170007	No leaf certificate was included in XML signature
PROVCORE_E_SIGNING_CERTIFICATE_INVALID_FOR_SIGNING	0x8217000D	Signing certificate does not meet requirements (Extended Validation, digital signature usage)
PROVCORE_E_XML_MISSING_SIGNATURE	0x8217000E	XML was not signed (and caller was not a mobile broadband operator app)