This documentation is archived and is not being maintained.

MSFT_SIPPhoneRouteUsageData

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

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

The property values for the MSFT_SIPPhoneRouteUsageData class map to the settings found on the Phone Usages tab of the Office Communications Server Voice Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking Forest, pointing to Properties, and then clicking Voice Properties. In the Office Communications Server Voice Properties dialog box, click the Phone Usages tab.

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.

Syntax


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.

The DefaultUsage property does not map to the Office Communications Server Voice Properties dialog box.

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.

The Description property maps to the Description setting in the Office Communications Server Voice Properties dialog box.

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}".

The InstanceID property does not map to the Office Communications Server Voice Properties dialog box.

PhoneRoutes

Data type: string[]

Access type: Read-only

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

The PhoneRoutes property does not map to the Office Communications Server Voice Properties dialog box.

PhoneRouteUsageDN

Data type: string

Access type: Read-only

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

The PhoneRouteUsageDN property does not map to the Office Communications Server Voice Properties dialog box.

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.

The UsageAttribute property maps to the Name setting in the Office Communications Server Voice Properties dialog box.

Remarks

This class gets and sets information at the following level: Active Directory.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server and Front End Server.

Namespace: Defined in \root\cimv2.

Show: