Microsoft.Azure.Commands.Dns.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-AzureRmDnsRecordConfig</command:name> <maml:description> <maml:para>Adds a DNS record to a local record set object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureRmDnsRecordConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-AzureRmDnsRecordConfig cmdlet adds a Domain Name System (DNS) record to a RecordSet object. The RecordSet object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service.</maml:para> <maml:para>SOA records are created when a DNS zone is created, and are removed when the DNS zone is deleted. You cannot add or remove SOA records, but you can edit them.</maml:para> <maml:para>You can pass the RecordSet object to this cmdlet as a parameter or by using the pipeline operator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server name for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer resource (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server name for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer resource (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to edit.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> <dev:type> <maml:name>DnsRecordSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a RecordSet object to this cmdlet. This is an offline representation of the RecordSet, and changes to it do not change DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the modified RecordSet object. In addition, the object passed in is modified directly.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Add an A record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds an A record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Add an AAAA record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds an AAAA record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Add a CNAME record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: PS C:\> Get-AzureRmDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds a CNAME record to an existing record set. Because a CNAME record set can contain at most one record, it must initially be an empty record set, or existing records must be removed using Remove-AzureRmDnsRecordConfig.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Add an MX record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds an MX record to an existing record set. The record name "@" indicates a record set at the zone apex.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Add an NS record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: PS C:\> Get-AzureRmDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds an NS record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Add a PTR record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa PS C:\> Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds a PTR record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7: Add an SRV record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds an SRV record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 8: Add a TXT record to a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com PS C:\> Add-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example adds a TXT record to an existing record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">This topic displays help topics for the Azure DNS Cmdlets. </maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> Azure PowerShell is a command-line shell and scripting language designed to help information technology (IT) professionals automate system administration tasks. To install the latest Azure PowerShell version and associate it with your Azure subscription, see <maml:navigationLink> <maml:linkText>How to install and configure Azure PowerShell</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink>. For more information about Azure Resource Manager cmdlets, see <maml:navigationLink> <maml:linkText>Using Azure PowerShell with Azure Resource Manager</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink>. </maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">The following table contains links to the topics for the Azure DNS Cmdlets:</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">cmdlet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Description</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Add-AzureRmDnsRecordConfig</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Adds a DNS record to a local record set object.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureRmDnsRecordSet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets a DNS record set.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Get-AzureRmDnsZone</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Gets a DNS zone.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureRmDnsRecordConfig</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a new DNS record local object.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureRmDnsRecordSet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a DNS record set.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">New-AzureRmDnsZone</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Creates a new DNS zone.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureRmDnsRecordConfig</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes a DNS record from a local record set object.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureRmDnsRecordSet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Deletes a DNS record set.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Remove-AzureRmDnsZone</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Removes a DNS zone.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-AzureRmDnsRecordSet</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Updates a DNS record set.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Set-AzureRmDnsZone</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">Updates the properties of a DNS zone.</maml:para><maml:para xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets: ◠Get-Help <cmdlet name> -Detailed ◠Get-Help <cmdlet name> -Examples ◠Get-Help <cmdlet name> -Full </maml:para>Azure Resource Manager Cmdlets<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDnsRecordSet</command:name> <maml:description> <maml:para>Gets a DNS record set.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmDnsRecordSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDnsRecordSet cmdlet gets the Domain Name System (DNS) record set with the specified name and type, in the specified zone. </maml:para> <maml:para>If you do not specify the Name or RecordType parameters, this cmdlet returns all record sets of the specified type in the zone. If you specify the RecordType parameter but not the Name parameter, this cmdlet returns all record sets of the specified record type.</maml:para> <maml:para>You can use the pipeline operator to pass a DnsZone object to this cmdlet, or you can pass a DnsZone object as the Zone parameter, or alternatively you can specify the zone and resource group by name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to get. If you do not specify the Name parameter, all record sets of the specified type are returned. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record that this cmdlet gets.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SOA -- SRV -- TXT </maml:para> <maml:para>If you do not specify the RecordType parameter, you must also omit the Name parameter. This cmdlet then returns all record sets in the zone (of all names and types).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RecordType]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone that contains the record set that this cmdlet gets. Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to get. If you do not specify the Name parameter, all record sets of the specified type are returned. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record that this cmdlet gets.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SOA -- SRV -- TXT </maml:para> <maml:para>If you do not specify the RecordType parameter, you must also omit the Name parameter. This cmdlet then returns all record sets in the zone (of all names and types).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RecordType]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone. The zone name must also be specified, using the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DnsZone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone that contains the record set to get. The resource group containing the zone must also be specified, using the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to get. If you do not specify the Name parameter, all record sets of the specified type are returned. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record that this cmdlet gets.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SOA -- SRV -- TXT </maml:para> <maml:para>If you do not specify the RecordType parameter, you must also omit the Name parameter. This cmdlet then returns all record sets in the zone (of all names and types).</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">RecordType]</command:parameterValue> <dev:type> <maml:name>RecordType]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone. The zone name must also be specified, using the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DnsZone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone that contains the record set that this cmdlet gets. Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> <dev:type> <maml:name>DnsZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone that contains the record set to get. The resource group containing the zone must also be specified, using the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a DnsZone object to this cmdlet. The DnsZone object represents the zone in which to look for the RecordSet object.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns one or more objects that represents the record sets that are found. There will be at most one RecordSet returned if the Name and RecordType parameters are specified, otherwise multiple RecordSet objects are returned as an array.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get record sets with a specified name and type</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A </dev:code> <dev:remarks> <maml:para>This command gets the record set of record type A named www in the specified resource group and zone, and then stores it in the $RecordSet variable. Because the Name and RecordType parameters are specified, only one RecordSet object is returned.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get record sets of a specified type</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A </dev:code> <dev:remarks> <maml:para>This command gets an array of all record sets of record type A in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all record sets in a zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSets = Get-AzureRmDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" </dev:code> <dev:remarks> <maml:para>This command gets an array of all record sets in the zone named myzone.com in the resource group named MyResourceGroup, and then stores them in the $RecordSets variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get all record sets in a zone, using a DnsZone object</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" PS C:\> $RecordSets = Get-AzureRmDnsRecordSet –Zone $Zone </dev:code> <dev:remarks> <maml:para>This example is equivalent to Example 3 above. This time, the zone is specified using a zone object.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDnsZone</command:name> <maml:description> <maml:para>Gets a DNS zone.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureRmDnsZone</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDnsZone cmdlet gets a Domain Name System (DNS) zone from the specified resource group. If you specify the Name parameter, a single DnsZone object is returned. If you do not specify the Name parameter, an array containing all of the zones in the specified resource group is returned. You can use the DnsZone object to update the zone, for example you can add RecordSet objects to it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to get.</maml:para> <maml:para>If you do not specify a value for the Name parameter, this cmdlet gets all DNS zones in the specified resource group. If you also omit the ResourceGroupName parameter, this cmdlet gets all DNS zones in the current Azure subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the DNS zone to get.</maml:para> <maml:para>If you do not specify the ResourceGroupName, then you must also omit the Name parameter. In this case, this cmdlet gets all DNS zones in the current Azure subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to get.</maml:para> <maml:para>If you do not specify a value for the Name parameter, this cmdlet gets all DNS zones in the specified resource group. If you also omit the ResourceGroupName parameter, this cmdlet gets all DNS zones in the current Azure subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the DNS zone to get.</maml:para> <maml:para>If you do not specify the ResourceGroupName, then you must also omit the Name parameter. In this case, this cmdlet gets all DNS zones in the current Azure subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not allow you to pipe input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns an object that represents the DNS zone. If the zone name is not specified, an array of zone objects is returned.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Zone = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" </dev:code> <dev:remarks> <maml:para>This example gets the DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get all of the zones in a resource group</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Zones = Get-AzureRmDnsZone -ResourceGroupName "MyResourceGroup" </dev:code> <dev:remarks> <maml:para>This example gets all of the DNS zones in the specified resource group, and then stores it in the $Zones variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get all of the zones in a subscription</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Zones = Get-AzureRmDnsZone </dev:code> <dev:remarks> <maml:para>This example gets all of the DNS zones in the current Azure subscription, and then stores them in the $Zones variable.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDnsRecordConfig</command:name> <maml:description> <maml:para>Creates a new DNS record local object. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRmDnsRecordConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDnsRecordConfig cmdlet creates a local DnsRecord object. An array of these objects is passed to the New-AzureRmDnsRecordSet cmdlet using the DnsRecords parameter to specify the records to create in the record set. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server name for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer resource (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server name for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer resource (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None.</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description></maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name></maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description></maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a RecordSet of type A</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records # When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) # To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, # then call New-AzureRmDnsRecordSet, as follows: PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a RecordSet of type AAAA</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Create a RecordSet of type CNAME</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Create a RecordSet of type MX</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named www in the zone myzone.com. The record set is of type MX and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Create a RecordSet of type NS</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named ns1 in the zone myzone.com. The record set is of type NS and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Create a RecordSet of type PTR</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig –Ptrdname www.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named 4 in the zone 3.2.1.in-addr.arpa. The record set is of type PTR and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7: Create a RecordSet of type SRV</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named _sip._tcp in the zone myzone.com. The record set is of type SRV and has a TTL of 1 hour (3600 seconds). It contains a single DNS record, pointing to the IP address 2001.2.3.4.</maml:para> <maml:para>The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 8: Create a RecordSet of type TXT</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named text in the zone myzone.com. The record set is of type TXT and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDnsRecordSet</command:name> <maml:description> <maml:para>Creates a DNS record set.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRmDnsRecordSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDnsRecordSet cmdlet creates a new Domain Name System (DNS) record set with the specified name and type in the specified zone. A RecordSet object is a set of DNS records with the same name and type. Note that the name is relative to the zone and not the fully qualified name. </maml:para> <maml:para>The DnsRecords parameter specifies the records in the record set. This parameter takes an array of DNS records, constructed using New-AzureRmDnsRecordConfig. </maml:para> <maml:para>You can use the pipeline operator to pass a DnsZone object to this cmdlet, or you can pass a DnsZone object as the Zone parameter, or alternatively you can specify the zone by name. </maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> <maml:para>If a matching RecordSet already exists (same name and record type), you must specify the Overwrite parameter, otherwise the cmdlet will not create a new RecordSet . </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>DnsRecords</maml:name> <maml:description> <maml:para>Specifies the array of DNS records to include in the record set. You can use the New-AzureRmDnsRecordConfig cmdlet to create DNS record objects. See the examples for more information. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DnsRecordBase[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies an array of metadata to associate with the RecordSet. Metadata is specified using name-value pairs that are represented as hash tables, for example @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"}).</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that this cmdlet overwrites the specified RecordSet if it already exists. </maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record to create.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are created automatically when the zone is created and cannot be created manually.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">A</command:parameterValue> <command:parameterValue required="true" variableLength="false">AAAA</command:parameterValue> <command:parameterValue required="true" variableLength="false">CNAME</command:parameterValue> <command:parameterValue required="true" variableLength="false">MX</command:parameterValue> <command:parameterValue required="true" variableLength="false">NS</command:parameterValue> <command:parameterValue required="true" variableLength="false">PTR</command:parameterValue> <command:parameterValue required="true" variableLength="false">SOA</command:parameterValue> <command:parameterValue required="true" variableLength="false">SRV</command:parameterValue> <command:parameterValue required="true" variableLength="false">TXT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone. You must also specify the ZoneName parameter to specify the zone name.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the Time to Live (TTL) for the DNS RecordSet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the zone in which to create the RecordSet. You must also specify the resource group containing the zone using the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>DnsRecords</maml:name> <maml:description> <maml:para>Specifies the array of DNS records to include in the record set. You can use the New-AzureRmDnsRecordConfig cmdlet to create DNS record objects. See the examples for more information. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DnsRecordBase[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies an array of metadata to associate with the RecordSet. Metadata is specified using name-value pairs that are represented as hash tables, for example @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"}).</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that this cmdlet overwrites the specified RecordSet if it already exists. </maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record to create.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are created automatically when the zone is created and cannot be created manually.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">A</command:parameterValue> <command:parameterValue required="true" variableLength="false">AAAA</command:parameterValue> <command:parameterValue required="true" variableLength="false">CNAME</command:parameterValue> <command:parameterValue required="true" variableLength="false">MX</command:parameterValue> <command:parameterValue required="true" variableLength="false">NS</command:parameterValue> <command:parameterValue required="true" variableLength="false">PTR</command:parameterValue> <command:parameterValue required="true" variableLength="false">SOA</command:parameterValue> <command:parameterValue required="true" variableLength="false">SRV</command:parameterValue> <command:parameterValue required="true" variableLength="false">TXT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the Time to Live (TTL) for the DNS RecordSet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DnsZone in which to create the RecordSet. Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>DnsRecords</maml:name> <maml:description> <maml:para>Specifies the array of DNS records to include in the record set. You can use the New-AzureRmDnsRecordConfig cmdlet to create DNS record objects. See the examples for more information. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="true">DnsRecordBase[]</command:parameterValue> <dev:type> <maml:name>DnsRecordBase[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Metadata</maml:name> <maml:description> <maml:para>Specifies an array of metadata to associate with the RecordSet. Metadata is specified using name-value pairs that are represented as hash tables, for example @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"}).</maml:para> <maml:para></maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates that this cmdlet overwrites the specified RecordSet if it already exists. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record to create.</maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are created automatically when the zone is created and cannot be created manually.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordType</command:parameterValue> <dev:type> <maml:name>RecordType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone. You must also specify the ZoneName parameter to specify the zone name.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ttl</maml:name> <maml:description> <maml:para>Specifies the Time to Live (TTL) for the DNS RecordSet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue> <dev:type> <maml:name>UInt32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DnsZone in which to create the RecordSet. Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> <dev:type> <maml:name>DnsZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the zone in which to create the RecordSet. You must also specify the resource group containing the zone using the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone and resource group by passing in a DNS Zone object using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a DnsZone object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns a RecordSet object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>You can use the Confirm parameter to control whether this cmdlet prompts you for confirmation. By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a RecordSet of type A</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records # When creating a RecordSet containing a single record, the above sequence can also be condensed into a single line: PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords (New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4) # To create a record set containing multiple records, use New-AzureRmDnsRecordConfig to add each record to the $Records array, # then call New-AzureRmDnsRecordSet, as follows: PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 1.2.3.4 PS C:\> $Records += New-AzureRmDnsRecordConfig -IPv4Address 5.6.7.8 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Create a RecordSet of type AAAA</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Ipv6Address 2001:db8::1 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type AAAA and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Create a RecordSet of type CNAME</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Cname www.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This example creates a RecordSet named www in the zone myzone.com. The record set is of type CNAME and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Create a RecordSet of type MX</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named www in the zone myzone.com. The record set is of type MX and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Create a RecordSet of type NS</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Nsdname ns1-01.azure-dns.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named ns1 in the zone myzone.com. The record set is of type NS and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Create a RecordSet of type PTR</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig –Ptrdname www.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named 4 in the zone 3.2.1.in-addr.arpa. The record set is of type PTR and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7: Create a RecordSet of type SRV</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named _sip._tcp in the zone myzone.com. The record set is of type SRV and has a TTL of 1 hour (3600 seconds). It contains a single DNS record, pointing to the IP address 2001.2.3.4.</maml:para> <maml:para>The service (sip) and the protocol (tcp) are specified as part of the record set name, not as part of the record data.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 8: Create a RecordSet of type TXT</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig -Value "This is a TXT Record" PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named text in the zone myzone.com. The record set is of type TXT and has a TTL of 1 hour (3600 seconds). It contains a single DNS record.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 9: Create a RecordSet at the zone apex</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig –Ipv4Address 1.2.3.4 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet at the apex (or root) of the zone myzone.com. To do this, the record set name is specified as "@" (including the double-quotes).</maml:para> <maml:para>You cannot create CNAME records at the apex of a zone. This is a constraint of the DNS standards; it is not a limitation of Azure DNS.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 10: Create a wildcard Record Set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $Records = @() PS C:\> $Records += New-AzureRmDnsRecordConfig –Ipv4Address 1.2.3.4 PS C:\> $RecordSet = New-AzureRmDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords $Records </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named * in the zone myzone.com. This is a wildcard record set.</maml:para> <maml:para>To create a RecordSet using only one line of PowerShell, or to create a record set with multiple records, see Example 1.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 11: Create an empty record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords @() </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet named www in the zone myzone.com. The record set is of type A and has a TTL of 1 hour (3600 seconds). This is an empty record set, which acts as a placeholder to which you can later add records.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 12: Create a record set and suppress all confirmation</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = New-AzureRmDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" –DnsRecords (New-AzureRmDnsRecordConfig –Ipv4Address 1.2.3.4) –Confirm:$False –Overwrite </dev:code> <dev:remarks> <maml:para>This command creates a RecordSet. The Overwrite parameter ensures that this record set overwrites any pre-existing record set with the same name and type (existing records in that record set are lost). The Confirm parameter with a value of $False suppresses the confirmation prompt.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDnsZone</command:name> <maml:description> <maml:para>Creates a new DNS zone.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureRmDnsZone</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDnsZone cmdlet creates a new Domain Name System (DNS) zone in the specified resource group. You must specify a unique DNS zone name for the Name parameter or the cmdlet will return an error. After the zone is created, use the New-AzureRmDnsRecordSet cmdlet to create record sets in the zone.</maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies an array of tags to associate with the DNS zone. Tags are name-value pairs represented as hash tables, for example, @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group in which to create the zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group in which to create the zone.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies an array of tags to associate with the DNS zone. Tags are name-value pairs represented as hash tables, for example, @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You cannot pipe input to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns an object that represents the new DNS zone.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>You can use the Confirm parameter to control whether this cmdlet prompts you for confirmation. By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Create a DNS zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$Zone = New-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" </dev:code> <dev:remarks> <maml:para>This command creates a new DNS zone named myzone.com in the specified resource group, and then stores it in the $Zone variable. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDnsRecordConfig</command:name> <maml:description> <maml:para>Removes a DNS record from a local record set object.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmDnsRecordConfig</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDnsRecordConfig cmdlet removes a Domain Name System (DNS) record from a record set. The RecordSet object is an offline object, and changes to it do not change the DNS responses until after you run the Set-AzureRmDnsRecordSet cmdlet to persist the change to the Microsoft Azure DNS service.</maml:para> <maml:para>To remove a record, all the fields for that record type must match exactly. You cannot add or remove SOA records. SOA records are automatically created when a DNS zone is created and automatically deleted when the DNS zone is deleted.</maml:para> <maml:para>You can pass the RecordSet object to this cmdlet as a parameter or by using the pipeline operator.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordConfig</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Cname</maml:name> <maml:description> <maml:para>Specifies the domain name for a canonical name (CNAME) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Exchange</maml:name> <maml:description> <maml:para>Specifies the mail exchange server name for a mail exchange (MX) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv4Address</maml:name> <maml:description> <maml:para>Specifies an IPv4 address for an A record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ipv6Address</maml:name> <maml:description> <maml:para>Specifies an IPv6 address for an AAAA record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Nsdname</maml:name> <maml:description> <maml:para>Specifies the name server for a name server (NS) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies the port for a service (SRV) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:description> <maml:para>Specifies the preference for an MX record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:description> <maml:para>Specifies the priority for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Ptrdname</maml:name> <maml:description> <maml:para>Specifies the target domain name of a pointer (PTR) record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object that contains the record to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> <dev:type> <maml:name>DnsRecordSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:description> <maml:para>Specifies the target for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value for a TXT record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:description> <maml:para>Specifies the weight for an SRV record.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">UInt16</command:parameterValue> <dev:type> <maml:name>UInt16</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a DnsRecordSet object to this cmdlet. This is an offline representation of the record set and updates to it do not change DNS responses until after you run Set-AzureRmDnsRecordSet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns the modified RecordSet object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove an A record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes an A record from an existing record set. If this is the only record in the record set, the result will be an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove an AAAA record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes an AAAA record from an existing record set. If this is the only record in the record set, the result will be an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Remove a CNAME record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Cname contoso.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes a CNAME record from an existing record set. Because a CNAME record set can contain at most one record, the result is an empty record set.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Remove an MX record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes an MX record from an existing record set. The record name "@" indicates a record set at the zone apex. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Remove an NS record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes an NS record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Remove a PTR record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa PS C:\> Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzureRmDnsRecordConfig -Ptrdname www.contoso.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes a PTR record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet. </maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 7: Remove an SRV record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes an SRV record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 8: Remove a TXT record from a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: PS C:\> Get-AzureRmDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzureRmDnsRecordConfig -Value "This is a TXT Record" | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>This example removes a TXT record from an existing record set. If this is the only record in the record set, the result is an empty record set. To remove a record set entirely, see Remove-AzureRmDnsRecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Add-AzureRmDnsRecordConfig</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDnsRecordSet</command:name> <maml:description> <maml:para>Deletes a record set.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmDnsRecordSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDnsRecordSet cmdlet deletes the specified record set from the specified zone. You cannot delete SOA or name server (NS) records that are automatically created at the zone apex.</maml:para> <maml:para>You can pass a RecordSet object to this cmdlet by using the pipeline operator or as a parameter. To identify a record set by name and type without using a RecordSet object, you must pass the zone as a DnsZone object to this cmdlet by using the pipeline operator or as a parameter, or alternatively you can specify the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> <maml:para>When specifying the record set using a RecordSet object, the record set is not deleted if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. You can suppress this by using the Overwrite parameter, which deletes the record set regardless of concurrent changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to remove. When specifying the record set by name, the DNS zone must be specified using either the Zone parameter or the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>Alternatively, the record set can be specified using a RecordSet object, passed using the RecordSet parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record. </maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are deleted automatically when the zone is deleted. You cannot manually delete SOA records.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">A</command:parameterValue> <command:parameterValue required="true" variableLength="false">AAAA</command:parameterValue> <command:parameterValue required="true" variableLength="false">CNAME</command:parameterValue> <command:parameterValue required="true" variableLength="false">MX</command:parameterValue> <command:parameterValue required="true" variableLength="false">NS</command:parameterValue> <command:parameterValue required="true" variableLength="false">PTR</command:parameterValue> <command:parameterValue required="true" variableLength="false">SOA</command:parameterValue> <command:parameterValue required="true" variableLength="false">SRV</command:parameterValue> <command:parameterValue required="true" variableLength="false">TXT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone that contains the RecordSet to delete. This parameter is applicable only when specifying the record set using the Name parameter.</maml:para> <maml:para>Alternatively, you can specify the record set using either the RecordSet parameter, or the Name, ZoneName, and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to remove. When specifying the record set by name, the DNS zone must be specified using either the Zone parameter or the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>Alternatively, the record set can be specified using a RecordSet object, passed using the RecordSet parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record. </maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are deleted automatically when the zone is deleted. You cannot manually delete SOA records.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">A</command:parameterValue> <command:parameterValue required="true" variableLength="false">AAAA</command:parameterValue> <command:parameterValue required="true" variableLength="false">CNAME</command:parameterValue> <command:parameterValue required="true" variableLength="false">MX</command:parameterValue> <command:parameterValue required="true" variableLength="false">NS</command:parameterValue> <command:parameterValue required="true" variableLength="false">PTR</command:parameterValue> <command:parameterValue required="true" variableLength="false">SOA</command:parameterValue> <command:parameterValue required="true" variableLength="false">SRV</command:parameterValue> <command:parameterValue required="true" variableLength="false">TXT</command:parameterValue> </command:parameterValueGroup> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone that contains the RecordSet to delete. This parameter is applicable only when the record set and DNS zone are specified using the Name and ZoneName parameters.</maml:para> <maml:para>Alternatively, you can specify the record set using either the RecordSet parameter, or the Name and Zone parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the zone that contains the RecordSet to delete. You must also specify the Name and ResourceGroupName parameters. </maml:para> <maml:para>Alternatively, the record set can be specified using either the RecordSet parameter, or the Name and Zone parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specifying the record set using a RecordSet object, the record set is not deleted if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. This can be suppressed using the Overwrite parameter, which deletes the record set regardless of concurrent changes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to remove.</maml:para> <maml:para>Alternatively, the record set can be specified using the Name and Zone parameters, or using the Name, ZoneName, and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the RecordSet to remove. When specifying the record set by name, the DNS zone must be specified using either the Zone parameter or the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>Alternatively, the record set can be specified using a RecordSet object, passed using the RecordSet parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specifying the record set using a RecordSet object, the record set is not deleted if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. This can be suppressed using the Overwrite parameter, which deletes the record set regardless of concurrent changes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet object to remove.</maml:para> <maml:para>Alternatively, the record set can be specified using the Name and Zone parameters, or using the Name, ZoneName, and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> <dev:type> <maml:name>DnsRecordSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>Specifies the type of DNS record. </maml:para> <maml:para> Valid values are: -- A -- AAAA -- CNAME -- MX -- NS -- PTR -- SRV -- TXT </maml:para> <maml:para>SOA records are deleted automatically when the zone is deleted. You cannot manually delete SOA records.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">RecordType</command:parameterValue> <dev:type> <maml:name>RecordType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the resource group that contains the DNS zone that contains the RecordSet to delete. This parameter is applicable only when the record set and DNS zone are specified using the Name and ZoneName parameters.</maml:para> <maml:para>Alternatively, you can specify the record set using either the RecordSet parameter, or the Name and Zone parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone that contains the RecordSet to delete. This parameter is applicable only when specifying the record set using the Name parameter.</maml:para> <maml:para>Alternatively, you can specify the record set using either the RecordSet parameter, or the Name, ZoneName, and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> <dev:type> <maml:name>DnsZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ZoneName</maml:name> <maml:description> <maml:para>Specifies the name of the zone that contains the RecordSet to delete. You must also specify the Name and ResourceGroupName parameters. </maml:para> <maml:para>Alternatively, the record set can be specified using either the RecordSet parameter, or the Name and Zone parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a RecordSet object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>You can use the Confirm parameter to control whether this cmdlet prompts you for confirmation. By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet </dev:code> <dev:remarks> <maml:para>The first command gets the specified record set, and then stores it in the $RecordSet variable.The second command removes the record set in $RecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Remove a record set and suppress all confirmation</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\> $RecordSet = Get-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" PS C:\> Remove-AzureRmDnsRecordSet -RecordSet $RecordSet –Confirm:$False –Overwrite # Alternatively, the record set can be removed as follows. In this case, # because the record set is specified by name rather than by object, the # Overwrite parameter is not applicable. PS C:\> Remove-AzureRmDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" –Confirm:$False </dev:code> <dev:remarks> <maml:para>The first command gets the specified record set.</maml:para> <maml:para>The second command deletes the record set, even if it has changed in the meantime. Confirmation prompts are suppressed.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDnsZone</command:name> <maml:description> <maml:para>Removes a DNS zone from a resource group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureRmDnsZone</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDnsZone cmdlet permanently deletes a Domain Name System (DNS) zone from a specified resource group. All record sets contained in the zone are also deleted.</maml:para> <maml:para>You can pass a DnsZone object using the Name parameter or by using the pipeline operator, or alternatively you can specify the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> <maml:para>When specifying the zone using a DnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in Azure DNS since the local DnsZone object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). This provides protection for concurrent zone changes. This can be suppressed using the Overwrite parameter, which deletes the zone regardless of concurrent changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone that this cmdlet removes. You must also specify the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the DNS zone using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the zone to remove. You must also specify the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the DNS zone using a DnsZone object, passed via either the pipeline or the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specifying the zone using a DnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in Azure DNS since the local DnsZone object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). This provides protection for concurrent zone changes.</maml:para> <maml:para>This can be suppressed using the Overwrite parameter, which deletes the zone regardless of concurrent changes.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone to delete. The DnsZone object passed can also be passed via the pipeline.</maml:para> <maml:para>Alternatively, you can specify the DNS zone to delete by using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:description> <maml:para>This parameter is deprecated for this cmdlet. It will be removed in a future release. </maml:para> <maml:para>To control whether this cmdlet prompts you for confirmation, use the Confirm parameter. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone that this cmdlet removes. You must also specify the ResourceGroupName parameter.</maml:para> <maml:para>Alternatively, you can specify the DNS zone using the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When specifying the zone using a DnsZone object (passed via the pipeline or Zone parameter), the zone is not deleted if it has been changed in Azure DNS since the local DnsZone object was retrieved (only operations directly on the DNS zone resource count as changes, operations on record sets within the zone do not). This provides protection for concurrent zone changes.</maml:para> <maml:para>This can be suppressed using the Overwrite parameter, which deletes the zone regardless of concurrent changes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the zone to remove. You must also specify the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the DNS zone using a DnsZone object, passed via either the pipeline or the Zone parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone to delete. The DnsZone object passed can also be passed via the pipeline.</maml:para> <maml:para>Alternatively, you can specify the DNS zone to delete by using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> <dev:type> <maml:name>DnsZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a DnsZone object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not generate any output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>Due to the potentially high impact of deleting a DNS zone, by default, this cmdlet prompts for confirmation if the $ConfirmPreference Windows PowerShell variable has any value other than None. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Remove a zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" </dev:code> <dev:remarks> <maml:para>This command removes the zone named myzone.com from the resource group named MyResourceGroup.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmDnsRecordSet</command:name> <maml:description> <maml:para>Updates a DNS record set.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRmDnsRecordSet</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmDnsRecordSet cmdlet updates a record set in the Azure DNS service from a local RecordSet object. </maml:para> <maml:para>You can pass a RecordSet object as a parameter or by using the pipeline operator. </maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> <maml:para>The record set is not updated if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. You can suppress this behavior using the Overwrite parameter, which updates the record set regardless of concurrent changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmDnsRecordSet</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates to update the record set regardless of concurrent changes.</maml:para> <maml:para>The record set will not be updated if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. To suppress this behavior, you can use the Overwrite parameter, which results in the record set being updated regardless of concurrent changes.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>Indicates to update the record set regardless of concurrent changes.</maml:para> <maml:para>The record set will not be updated if it has been changed in Azure DNS since the local RecordSet object was retrieved. This provides protection for concurrent changes. To suppress this behavior, you can use the Overwrite parameter, which results in the record set being updated regardless of concurrent changes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>RecordSet</maml:name> <maml:description> <maml:para>Specifies the RecordSet to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsRecordSet</command:parameterValue> <dev:type> <maml:name>DnsRecordSet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pass a RecordSet object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsRecordSet</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns an object that represents the updated RecordSet object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>You can use the Confirm parameter to control whether this cmdlet prompts you for confirmation. By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update a record set</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A PS C:\> Add-AzureRmDnsRecordConfig –RecordSet $RecordSet -Ipv4Address 172.16.0.0 PS C:\> Add-AzureRmDnsRecordConfig –RecordSet $RecordSet -Ipv4Address 172.31.255.255 PS C:\> Set-AzureRmDnsRecordSet –RecordSet $RecordSet # These cmdlets can also be piped: PS C:\> Get-AzureRmDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzureRmDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzureRmDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzureRmDnsRecordSet </dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureRmDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. </maml:para> <maml:para>The second and third commands are off-line operations to add two A records to the record set.</maml:para> <maml:para>The final command uses the Set-AzureRmDnsRecordSet cmdlet to commit the update.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Update an SOA record</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$RecordSet = Get-AzureRmDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone PS C:\> $RecordSet.Records[0].Email = "admin.myzone.com" PS C:\> Set-AzureRmDnsRecordSet -RecordSet $RecordSet </dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureRmDnsRecordset cmdlet to get the specified record set, and then stores it in the $RecordSet variable. </maml:para> <maml:para>The second command updates the specified SOA record in $RecordSet.</maml:para> <maml:para>The final command uses the Set-AzureRmDnsRecordSet cmdlet to propagate the update in $RecordSet.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsRecordSet</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command><command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmDnsZone</command:name> <maml:description> <maml:para>Updates the properties of a DNS zone. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureRmDnsZone</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmDnsZone cmdlet updates the specified DNS zone in the Azure DNS service. This cmdlet does not update the record sets in the zone. </maml:para> <maml:para>You can pass a DnsZone object as a parameter or by using the pipeline operator, or alternatively you can specify the ZoneName and ResourceGroupName parameters.</maml:para> <maml:para>You can use the Confirm parameter and $ConfirmPreference Windows PowerShell variable to control whether the cmdlet prompts you for confirmation.</maml:para> <maml:para>When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides protection for concurrent changes. You can suppress this behavior with the Overwrite parameter, which updates the zone regardless of concurrent changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies an array of tags to associate with the DNS zone. Tags are name-value pairs that are represented as hashtables, for instance, @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the zone to update. You must also specify the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone using a DnsZone object with the Zone parameter or the pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmDnsZone</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides protection for concurrent changes. You can suppress this behavior with the Overwrite parameter, which updates the zone regardless of concurrent changes.</maml:para> </maml:description> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone to update.</maml:para> <maml:para>Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the DNS zone to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Overwrite</maml:name> <maml:description> <maml:para>When passing a DNS zone as an object (using the Zone object or via the pipeline), it is not updated if it has been changed in Azure DNS since the local DnsZone object was retrieved. This provides protection for concurrent changes. You can suppress this behavior with the Overwrite parameter, which updates the zone regardless of concurrent changes.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="none"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of the resource group that contains the zone to update. You must also specify the ZoneName parameter.</maml:para> <maml:para>Alternatively, you can specify the zone using a DnsZone object with the Zone parameter or the pipeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true(ByPropertyName)" position="named" aliases="Tags"> <maml:name>Tag</maml:name> <maml:description> <maml:para>Specifies an array of tags to associate with the DNS zone. Tags are name-value pairs that are represented as hashtables, for instance, @(@{"Name"="dept"; "Value"="shopping"}, @{"Name"="env"; "Value"="production"})</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true(ByValue)" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:description> <maml:para>Specifies the DNS zone to update.</maml:para> <maml:para>Alternatively, you can specify the zone using the ZoneName and ResourceGroupName parameters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DnsZone</command:parameterValue> <dev:type> <maml:name>DnsZone</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>none</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>false</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>You can pipe a DnsZone object to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.Dns.DnsZone</maml:name> <maml:uri></maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet returns a DnsZone object that represents the updated DNS zone with a new Etag.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>You can use the Confirm parameter to control whether this cmdlet prompts you for confirmation. By default, the cmdlet prompts you for confirmation if the $ConfirmPreference Windows PowerShell variable has a value of Medium or lower. </maml:para> <maml:para>If you specify Confirm or Confirm:$True, this cmdlet prompts you for confirmation before it runs. If you specify Confirm:$False, the cmdlet does not prompt you for confirmation. </maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1: Update a DNS zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>$Zone = Get-AzureRmDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" PS C:\> $Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) PS C:\> Set-AzureRmDnsZone -Zone $Zone </dev:code> <dev:remarks> <maml:para>The first command gets the zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. </maml:para> <maml:para>The second command updates the tags for $Zone.</maml:para> <maml:para>The final command commits the change.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Update tags for a zone</maml:title> <maml:introduction> <maml:para></maml:para> </maml:introduction> <dev:code> PS C:\>Set-AzureRmDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) </dev:code> <dev:remarks> <maml:para>This command updates the tags for the zone named myzone.com without first explicitly getting the zone.</maml:para> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDnsZone</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |