Export (0) Print
Expand All
Expand Minimize

MSFT_SIPPhoneRouteData

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 a normalized number with one or more gateways or phone route usage policies.

The property values for the MSFT_SIPPhoneRouteUsageData class map to the settings found in the Add Route or Edit Route dialog boxes. 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 Routes tab, then either select an existing phone route and click Edit or click New to create a new phone route.

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_SIPPhoneRouteData
{
  string Description;
  string[] GatewayList;
  [key] string InstanceID;
  string Name;
  string PhoneRouteDN;
  string[] PhoneRouteUsages;
  string TargetPhoneNumber;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPPhoneRouteData class has the following properties.

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 text box in the Add Route or the Edit Route dialog box.

GatewayList

Data type: string[]

Access type: Read/Write

Required. Defines an array of the gateways that are designated to handle the target phone number.

The value of this property is not case-sensitive.

The GatewayList property maps to the Gateways list box in the Add Route or the Edit Route 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 Add Route or Edit Route dialog box.

Name

Data type: string

Access type: Read/Write

Required. The name of the phone route.

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

The Name property maps to the Name text box in the Add Route or the Edit Route dialog box.

PhoneRouteDN

Data type: string

Access type: Read-only

Optional. The distinguished name (DN) of the phone route.

The PhoneRouteDN property does not map to the Add Route or Edit Route dialog box.

PhoneRouteUsages

Data type: string[]

Access type: Read/Write

Required. An array of MSFT_SIPPhoneRouteUsageData::PhoneRouteUsageDN values.

The value of this property is not case-sensitive.

The PhoneRouteUsages property maps to the Phone usages list box in the Add Route or the Edit Route dialog box.

TargetPhoneNumber

Data type: string

Access type: Read/Write

Required. The phone number or phone number pattern representing the target phone numbers that can use this route.

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

The TargetPhoneNumber property maps to the Target regular expression text box in the Add Route or the Edit Route 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:
© 2014 Microsoft