MSFT_SIPPhoneRouteData class

MSFT_SIPPhoneRouteData

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

• 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.

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

• 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.

• PhoneRouteDN
  Data type: string

  Access type: Read-only

  Optional. The distinguished name of the phone route.

• 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.

• TargetPhoneNumber
  Data type: string

  Access type: Read/Write

  Required. The phone number or phone number pattern representing the target phone number(s) that can use this route.

  The value of this property is case-sensitive. The maximum length of the string is 1024 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