Fields

Article
05/13/2021

Defines values that describe the subscriber's plan and data usage.

Element hierarchy

<Message>: <Fields>

Syntax

<Fields>

  <!-- Child elements -->
  ( Usage
  | UsagePercentage
  | UsageOverage
  | UsageOveragePercentage
  | UsageTimestamp
  )?,
  DataLimit?,
  OverDataLimit?,
  Congested?,
  InboundBandwidth?,
  OutboundBandwidth?,
  PlanType?,
  RefreshProvisioning?,
  ActivationComplete?

</Fields>

Key

? optional (zero or one)

Attributes and Elements

Attributes

None.

Child Elements

Child Element	Description
ActivationComplete	If true, the subscription has been activated, and the machine should immediately attempt to connect. Otherwise, false.
Congested	If true, the subscriber's connection is in a state of congestion. Otherwise, it is either not supported by the MNO or false.
DataLimit	Defines a value representing the data limit in MB for a capped plan. Must be a value from 0 to 2^32nd.
InboundBandwidth	Defines a value representing the effective link speed of the subscriber’s inbound connection.
OutboundBandwidth	Defines a value representing the effective link speed of the subscriber’s outbound connection.
OverDataLimit	Defines whether a subscriber has consumed more bytes than the data limit for their plan.
PlanType	Defines the type of plan currently in use by the subscriber.
RefreshProvisioning	If true, the network configuration has been updated, and the machine should attempt to retrieve a new provisioning file during the next available maintenance window. Otherwise, false.
Usage	Defines the number of bytes the subscriber has consumed against their data limit. If absent, it is inferred by: UsagePercentage times DataLimit UsagePercentage times DataLimit UsageOverage plus DataLimit (UsageOveragePercentage times DataLimit) plus DataLimit UsageOverage plus (UsageOverage divided by (UsageOveragePercentage - 100) ) UsageOverage plus DataLimit
UsageOverage	Defines the number of bytes the subscriber has consumed over their data limit.
UsageOveragePercentage	Defines the percentage over the data limit a subscriber has consumed.
UsagePercentage	Defines the percentage of the data limit a subscriber has consumed.
UsageTimestamp	Defines a validity date and time of the usage information.

Parent Elements

Parent Element	Description
Message	Defines a MNO formatted message that contains the parsing rules necessary for Windows 8 to parse the message.

Remarks

Values include rules for inferring the value if absent. If any value referenced in a rule is not specified, skip the rule. If all rules are skipped, no value is set.

Requirements

	Value
Namespace	`http://www.microsoft.com/networking/CarrierControl/WWAN/v1`