Windows-based Hosting::CreateResourceRecord

  • Article

The CreateResourceRecord procedure creates a resource record for a specified zone on a specified DNS server.

Arguments

The CreateResourceRecord procedure has the following input parameters.

Input Argument Description

<userName>

Authentication credentials for the target DNS server. Only required when using Basic Authentication to talk to the DNS Provider Client.

<password>

Authentication credentials for the target DNS server. Only required when using Basic Authentication to talk to the DNS Provider Client.

<org>

The Lightweight Directory Access Protocol (LDAP) path of the owning organization.

<preferredDomainController>

The name of the preferred domain controller.

<serverIdentifier>

A string containing IP address or FQDN of the DNS server.

<zoneName>

The name of the DNS zone to create (i.e. fabrikam.com).

<rrType>

The DNS record type (e.g. MicrosoftDNS_AType, or MicrosoftDNS_MXType).

<properties/property[@name="MailExchange"]>

FQDN specifying a host willing to act as a mail exchange for the owner name.

<properties>

The tree for passing in properties of the resource record. These properties are valid for each resource record type. Properties specific to each type are listed below.

<properties/property[@name="ContainerName"]>

The name of the container for the zone, cache, or roothints instance that contains this resource record (RR), for example fabrikam.com.

<properties/property[@name="OwnerName"]>

The owner name for the resource record. This is generally the entire name of the record (i.e. www.fabrikam.com).

<properties/property[@name="TTL"]>

The time, in seconds, that the resource record can be cached by a DNS resolver, for example 60.

MicrosoftDNS_AType Parameter

properties/property[@name="IPAddress"] - A string representing the IPv4 address of the host (i.e. 192.168.0.2).

MicrosoftDNS_CNAMEType Parameter

properties/property[@name="PrimaryName"] - The primary name of the CNAME resource record. This should be the fully-qualified name of the A record with which this alias should be associated (for example, a CNAME record with an OwnerName of smtp.fabrikam.com might have a PrimaryName of mail.fabrikam.com).

MicrosoftDNS_MXType Parameters

properties/property[@name="Preference"] - Preference is given to this resource record among others at the same owner. Lower values are preferred.

<debugLevel>/<@logging>

Controls the level of detail provided [ high | medium | low ].

Output Arguments

The CreateResourceRecord procedure has no return values.

Remarks

Security

The CreateResourceRecord procedure has the following security requirements:

  • The caller is impersonated.

  • The caller is tested for OrgCreator permissions.

Process Steps

The following step occurs when creating a resource record with the CreateResourceRecord procedure of the Managed Windows-based Hosting Namespace:

  • Call DNS Provider:CreateResourceRecord

Sample Code

Example XML Request

The following is an example of an XML request for the CreateResourceRecord procedure of the Managed Windows-based Hosting Namespace:

<request> 
        <data> 
                <org>LDAP://ou=WbHOrg2,ou=WbHReseller,ou=hosting, 
                dc=fabrikam,dc=com</org> 
                <preferredDomainController>AD01-WH.fabrikam.Com 
                </preferredDomainController> 
                <serverIdentifier>10.18.0.20</serverIdentifier> 
                <userName>fabrikam\administrator</userName> 
                <password>!Zam*ps1</password> 
                <zoneName>myDomain.com</zoneName> 
                <rrType>MicrosoftDNS_AType</rrType> 
                <debugLevel logging="high" check-only="on" /> 
                <properties> 
                        <property name="ContainerName">myDomain.com</property> 
                        <property name="OwnerName">www5.myDomain.com</property> 
                        <property name="IPAddress">10.18.0.20</property> 
                        <property name="TTL">2400</property> 
                </properties> 
        </data> 
        <procedure> 
                <execute namespace="Windows-based Hosting"  
                procedure="CreateResourceRecord"> 
                <before source="data" destination="executeData" mode="merge" /> 
                <before source="executeData" destination="data" mode="insert" /> 
                </execute> 
        </procedure> 
</request>

Applies To

Managed Windows-based Hosting Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0

See also

Tasks

Windows-based Hosting::DeleteResourceRecord