MSFT_SIPPhoneRouteUsageData class

MSFT_SIPPhoneRouteUsageData

Associates one or more phone route usage policies with a phone route, which is used to enforce dialing policies.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

class MSFT_SIPPhoneRouteUsageData
{
  boolean DefaultUsage;
  string Description;
  [key] string InstanceID;
  string[] PhoneRoutes;
  string PhoneRouteUsageDN;
  string UsageAttribute;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPPhoneRouteUsageData class has the following properties.

• DefaultUsage
  Data type: boolean

  Access type: Read-only

  Required. Indicates whether this is the default usage policy to apply to users (or to users whose policy has been deleted).

• Description
  Data type: string

  Access type: Read/Write

  Optional. A description of the property settings that are specified by a particular instance of this class.

  The value of this property is not case-sensitive. The maximum length of the string is 1024 characters.

• InstanceID
  Data type: [key] string

  Access type: Read-only

  Optional. A GUID value that uniquely identifies an instance of this class.

  The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

• PhoneRoutes
  Data type: string[]

  Access type: Read-only

  Optional. The list of routes that refer to this usage policy.

• PhoneRouteUsageDN
  Data type: string

  Access type: Read-only

  Optional. The distinguished name of the phone route usage object in Active Directory.

• UsageAttribute
  Data type: string

  Access type: Read/Write

  Required. The unique name identifying the phone usage category, for example "Local calls" or "Premium calls".

  The value of this property is not case-sensitive. The maximum length of the string is 256 characters.

Remarks

This class gets and sets information at the following level(s): AD.

Instances of this class support the following interface methods:

• Provider::DeleteInstance();

• Provider::EnumerateInstances();

• Provider::GetObject();

• Provider::PutInstance();

  Where PutInstance() supports the following flag(s):

  • WBEM_FLAG_CREATE_ONLY
  • WBEM_FLAG_UPDATE_ONLY
  • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server.
Namespace: Defined in \root\cimv2.

See Also

Communications Server WMI Reference