ProvisioningAgent ProvisioningAgent ProvisioningAgent ProvisioningAgent Class

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

Syntax

Declaration

public sealed class ProvisioningAgentpublic sealed class ProvisioningAgentPublic NotInheritable Class ProvisioningAgent

Constructors summary

Creates a new instance of a ProvisioningAgent.

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

Methods summary

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

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

Note

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

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 app given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

Constructors

  • ProvisioningAgent()
    ProvisioningAgent()
    ProvisioningAgent()
    ProvisioningAgent()

    Creates a new instance of a ProvisioningAgent.

    Note

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

    For permission to use this API, please reach out to Network Operators API Permissions.

    For technical help with this API, please reach out to Network Operators API Help

    public ProvisioningAgent()public ProvisioningAgent()Public Function ProvisioningAgent() As

Methods

  • CreateFromNetworkAccountId(System.String)
    CreateFromNetworkAccountId(System.String)
    CreateFromNetworkAccountId(System.String)
    CreateFromNetworkAccountId(System.String)

    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 app given privileged access by mobile network operators.

    For permission to use this API, please reach out to Network Operators API Permissions.

    For technical help with this API, please reach out to Network Operators API Help

    public static ProvisioningAgent CreateFromNetworkAccountId(System.String)public static ProvisioningAgent CreateFromNetworkAccountId(System.String)Public Static Function CreateFromNetworkAccountId(System.String) As ProvisioningAgent

    Parameters

    • networkAccountId
      System.String
      System.String
      System.String
      System.String

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

    Returns

  • GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)
    GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)
    GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)
    GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)

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

    Note

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

    For permission to use this API, please reach out to Network Operators API Permissions.

    For technical help with this API, please reach out to Network Operators API Help

    public ProvisionedProfile GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)public ProvisionedProfile GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String)Public Function GetProvisionedProfile(Windows.Networking.NetworkOperators.ProfileMediaType,System.String) As ProvisionedProfile

    Parameters

    Returns

  • ProvisionFromXmlDocumentAsync(System.String)
    ProvisionFromXmlDocumentAsync(System.String)
    ProvisionFromXmlDocumentAsync(System.String)
    ProvisionFromXmlDocumentAsync(System.String)

    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 app given privileged access by mobile network operators.

    For permission to use this API, please reach out to Network Operators API Permissions.

    For technical help with this API, please reach out to Network Operators API Help

    public IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(System.String)public IAsyncOperation<ProvisionFromXmlDocumentResults> ProvisionFromXmlDocumentAsync(System.String)Public Function ProvisionFromXmlDocumentAsync(System.String) As IAsyncOperation( Of ProvisionFromXmlDocumentResults )

    Parameters

    • provisioningXmlDocument
      System.String
      System.String
      System.String
      System.String

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

    Returns

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

    Remarks

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

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

    NameHRESULTDescription
    E_ACCESSDENIED0x80070005LCaller is an operator app, but attempted to provision a different operator’s profiles
    PROVCORE_E_XML_MALFORMED0x82170001Provisioning file is not well-formed XML
    PROVCORE_E_XML_INVALID0x82170002Provisioning file does not conform to schema
    PROVCORE_E_XML_SIGNATURE_INVALID0x82170003Provisioning file signature is invalid
    PROVCORE_E_XML_SIGNATURE_UNTRUSTED0x82170004Signing certificate is not chained to a trusted root CA
    PROVCORE_E_XML_DIGEST_INVALID0x82170005Provisioning file was modified after being signed
    PROVCORE_E_XML_SIGNER_UNTRUSTED0x82170006User did not approve provisioning from this certificate.
    PROVCORE_E_NO_LEAF_CERT0x82170007No leaf certificate was included in XML signature
    PROVCORE_E_SIGNING_CERTIFICATE_INVALID_FOR_SIGNING0x8217000DSigning certificate does not meet requirements (Extended Validation, digital signature usage)
    PROVCORE_E_XML_MISSING_SIGNATURE0x8217000EXML was not signed (and caller was not a mobile broadband operator app)

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Capabilities

networkDataPlanProvisioning

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.StaticAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute

Details

Assembly

Windows.Networking.NetworkOperators.dll