MSFT_SIPLocalNormalizationRuleData

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.

Defines an element that is used by the location profile to normalize a number for external dialing. These rules are used to convert phone numbers entered by users to the E.164 phone number format required by Office Communications Server.

The property values for the MSFT_SIPLocalNormalizationRuleData class map to the settings found in the Add Phone Number Normalization Rule and the Edit Phone Number Normalization Rule 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 Voice Properties dialog box, on the Location Profiles tab, click Add to create a new location profile and set of phone normlaization rules, or select an existing location profile and click Edit.

MSFT_SIPLocalNormalizationRuleData

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_SIPLocalNormalizationRuleData
{
  string Description;
  [key] string InstanceID;
  boolean InternalEnterpriseExtension;
  string[] LocationProfiles;
  string Name;
  string NormalizationRuleDN;
  string Pattern;
  boolean TranslateDeviceDialing;
  string Translation;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPLocalNormalizationRuleData 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 Phone Number Normalization Rule 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 Phone Number Normalization Rule dialog box.

• InternalEnterpriseExtension
  Data type: boolean

  Access type: Read/Write

  Optional: Specifies whether the phone number obtained as a result of applying this rule corresponds to an internal enterprise number.

  The default value is False.

  The InternalEnterpriseExtension property maps to the Internal enterprise extension checkbox in the Phone Number Normalization Rule dialog box.

• LocationProfiles
  Data type: string[]

  Access type: Read-only

  Optional. Specifies a list of distinguished names (DNs) of location profiles to which the normalization rule applies.

  The value of this property is not case-sensitive.

  The LocationProfiles property does not map to the Phone Number Normalization Rule dialog box.

• Name
  Data type: string

  Access type: Read/Write

  Required. The name of an instance of this class.

  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 Phone Number Normalization Rule dialog box.

• NormalizationRuleDN
  Data type: string

  Access type: Read-only

  Optional. The distinguished name (DN) of the normalization rule.

  The value of this property is not case-sensitive.

  The NormalizationRuleDN property does not map to the Phone Number Normalization Rule dialog box.

• Pattern
  Data type: string

  Access type: Read/Write

  Required. The regular expression pattern of the phone number.

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

  The Pattern property maps to the Phone pattern regular expression text box in the Phone Number Normalization Rule dialog box.

• TranslateDeviceDialing
  Data type: boolean

  Access type: Read/Write

  Optional: Specifies whether the rule can be used by a client device for optimized dialing.

  The default value is False.

  The TranslateDeviceDialing property maps to the Use translation when dialing from device checkbox in the Phone Number Normalization Rule dialog box.

• Translation
  Data type: string

  Access type: Read/Write

  Required. The regular expression translation rule.

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

  The Translation property maps to the Translation pattern regular expression text box in the Phone Number Normalization Rule 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, Front End Server, and Mediation Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference