CarrierControlSchema schema
The CarrierControlSchema schema defines elements that are used to create the provisioning file in a call to ProvisionFromXmlDocumentAsync and describe all of the settings required to authenticate and provision a subscriber's account on a Mobile Network Operator's (MNO) network. All of the elements are in the namespace http://www.microsoft.com/networking/CarrierControl/v1. Not all elements are in every profile, as some elements are optional.
The following table lists all of the elements in this schema, sorted alphabetically by name.
| Element | Description |
|---|---|
| Activation | Defines information for a subscriber's activation method on a Mobile Network Operator's (MNO) network. |
| ActivationMethod | Defines an instance of the ActivationMethod element from the WWAN schema. |
| Branding | Defines an instance of the Branding element from the WWAN schema. |
| CarrierId | Defines a unique GUID that identifies the Mobile Network Operator (MNO). If the MNO participates in MBAE, this should be their MBAE Carrier ID. Non-MBAE MNOs may generate a GUID as part of their initial configuration. |
| CarrierProvisioning | Defines the properties and settings in a subscriber's carrier provisioning file. CarrierProvisioning is the unique root element of the provisioning file. |
| DefaultProfile | Defines an instance of the DefaultProfile element from the WWAN schema. |
| DelayInDays | Defines the number of days until the next refresh. It must be a positive integer less than 732. |
| DeviceId | Defines a unique device identifier to which this provisioning attempt applies. It must be formatted as \d{15,16} or as ([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2} |
| Extensions | Defines a schema extension point container for future additions. |
| Global | Defines identifying information for this provisioning attempt on a Mobile Network Operator's (MNO) network. |
| MBNProfiles | Defines information for a subscriber's WWAN profiles on a Mobile Network Operator's (MNO) network. |
| Messages | Defines an instance of the Messages element from the WWAN schema. |
| Password | Defines optional password credentials to be presented using HTTP-Auth to log on to the Mobile Network Operator's network when retrieving the provisioning file. |
| Plan | Defines an instance of the Plan element from the Plans schema. |
| Plans | Defines information for a subscriber's connection plans to a Mobile Network Operator's (MNO) network. |
| Provisioning | Defines parameters used to establish trust and refresh settings for future provisioning attempts. |
| PurchaseProfile | Defines an instance of the PurchaseProfile element from the WWAN schema. |
| RefreshParameters | Defines parameters to be used when refreshing the provisioning file contents. |
| RefreshURL | Defines the HTTPS URL where the client can find the updated copy of this provisioning file in the future. This URL will be accessed upon receipt of an SMS/USSD trigger or after the specified DelayInDays . It must be formatted as https://.+ |
| Signature | Defines an instance of the Signature element from the CarrierControlSignatureSchema. |
| SubscriberId | Defines a unique subscriber account identifier to which this provisioning attempt applies. |
| TrustedCertificate | Defines the Subject and Issuer fields from a trustworthy X.509 certificate. |
| TrustedCertificates | Defines a list of X.509 certificates whose signatures should be trusted on future provisioning files. |
| UserName | Defines optional user name credentials to be presented using HTTP-Auth to log on to the Mobile Network Operator's network when retrieving the provisioning file. |
| WLANProfile | Defines an instance of the WLANProfile element from the WLAN schema. |
| WLANProfiles | Defines information for a subscriber's WLAN profiles on a Mobile Network Operator's (MNO) network. |
The full CarrierControlSchema schema is below:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://www.microsoft.com/networking/CarrierControl/v1"
elementFormDefault="qualified"
xmlns="http://www.microsoft.com/networking/CarrierControl/v1"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
xmlns:wwan="http://www.microsoft.com/networking/CarrierControl/WWAN/v1"
xmlns:wlan="http://www.microsoft.com/networking/CarrierControl/WLAN/v1"
xmlns:base="http://www.microsoft.com/networking/CarrierControl/Base/v1"
xmlns:plans="http://www.microsoft.com/networking/CarrierControl/Plans/v1">
<xs:import namespace="http://www.microsoft.com/networking/CarrierControl/WLAN/v1" />
<xs:import namespace="http://www.microsoft.com/networking/CarrierControl/WWAN/v1" />
<xs:import namespace="http://www.microsoft.com/networking/CarrierControl/Base/v1" />
<xs:import namespace="http://www.microsoft.com/networking/CarrierControl/Plans/v1" />
<xs:import namespace="http://www.w3.org/2000/09/xmldsig#" />
<xs:element name="CarrierProvisioning">
<xs:complexType>
<xs:sequence>
<xs:element name="Global">
<xs:complexType>
<xs:sequence>
<xs:element name="CarrierId" type="base:GUID"/>
<xs:element name="SubscriberId" type="base:SubscriberType"/>
<xs:element name="DeviceId" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:pattern value="\d{15,16}"/>
<xs:pattern value="([a-fA-F0-9]{2}:){5}[a-fA-F0-9]{2}"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:any minOccurs="0" maxOccurs="unbounded" namespace="##other"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Activation" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="wwan:ActivationMethod"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="MBNProfiles" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="wwan:DefaultProfile" minOccurs="0"/>
<xs:element ref="wwan:PurchaseProfile" minOccurs="0"/>
<xs:element ref="wwan:Messages" minOccurs="0"/>
<xs:element ref="wwan:Branding" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="WLANProfiles" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="wlan:WLANProfile" maxOccurs="unbounded" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Plans" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element ref="plans:Plan" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Provisioning" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="TrustedCertificates" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="TrustedCertificate" type="base:CertificateDetails" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="RefreshParameters" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="DelayInDays" minOccurs="0">
<xs:simpleType>
<xs:restriction base="xs:positiveInteger">
<xs:maxExclusive value="731"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="RefreshURL">
<xs:simpleType>
<xs:restriction base="xs:anyURI">
<xs:pattern value="https://.+"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="UserName" type="xs:token" minOccurs="0"/>
<xs:element name="Password" type="xs:token" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Extensions" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:any minOccurs="0" maxOccurs="unbounded" namespace="##other"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="ds:Signature" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>