From c513ced418f3cffe392ce142fa51c4feb3713faa Mon Sep 17 00:00:00 2001 From: "evan1126@" Date: Mon, 14 Feb 2022 16:12:22 +0800 Subject: [PATCH] Split Az.Dns Examples --- src/Dns/Dns/help/Add-AzDnsRecordConfig.md | 82 +++++++-------- src/Dns/Dns/help/Get-AzDnsRecordSet.md | 20 ++-- src/Dns/Dns/help/Get-AzDnsZone.md | 14 +-- src/Dns/Dns/help/New-AzDnsRecordConfig.md | 76 +++++++------- src/Dns/Dns/help/New-AzDnsRecordSet.md | 100 +++++++++---------- src/Dns/Dns/help/New-AzDnsZone.md | 30 +++--- src/Dns/Dns/help/Remove-AzDnsRecordConfig.md | 82 +++++++-------- src/Dns/Dns/help/Remove-AzDnsRecordSet.md | 16 +-- src/Dns/Dns/help/Remove-AzDnsZone.md | 6 +- src/Dns/Dns/help/Set-AzDnsRecordSet.md | 22 ++-- src/Dns/Dns/help/Set-AzDnsZone.md | 26 ++--- 11 files changed, 237 insertions(+), 237 deletions(-) diff --git a/src/Dns/Dns/help/Add-AzDnsRecordConfig.md b/src/Dns/Dns/help/Add-AzDnsRecordConfig.md index 418107096826..8f950ec759c0 100644 --- a/src/Dns/Dns/help/Add-AzDnsRecordConfig.md +++ b/src/Dns/Dns/help/Add-AzDnsRecordConfig.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: CD119EBE-E1A4-4E9D-B3BA-FDAF89BF0DDB @@ -77,107 +77,107 @@ You can pass the **RecordSet** object to this cmdlet as a parameter or by using ## EXAMPLES ### Example 1: Add an A record to a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: -PS C:\> Get-AzDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name www -RecordType A -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet ``` This example adds an A record to an existing record set. ### Example 2: Add an AAAA record to a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: -PS C:\> Get-AzDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name www -RecordType AAAA -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet ``` This example adds an AAAA record to an existing record set. ### Example 3: Add a CNAME record to a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: -PS C:\> Get-AzDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name www -RecordType CNAME -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet ``` 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-AzDnsRecordConfig. ### Example 4: Add an MX record to a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: -PS C:\> Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet ``` This example adds an MX record to an existing record set. The record name "@" indicates a record set at the zone apex. ### Example 5: Add an NS record to a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # You can also pipe the above sequence: -PS C:\> Get-AzDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name abc -RecordType NS -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Nsdname ns1.myzone.com | Set-AzDnsRecordSet ``` This example adds an NS record to an existing record set. ### Example 6: Add a PTR record to a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa -PS C:\> Add-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa +Add-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name 4 -RecordType PTR -ResouceGroupName MyResourceGroup -ZoneName 3.2.1.in-addr.arpa | Add-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet ``` This example adds a PTR record to an existing record set. ### Example 7: Add an SRV record to a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name _sip._tcp -RecordType SRV -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet ``` This example adds an SRV record to an existing record set. ### Example 8: Add a TXT record to a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com +Add-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name text -RecordType TXT -ResouceGroupName MyResourceGroup -ZoneName myzone.com | Add-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet ``` This example adds a TXT record to an existing record set. diff --git a/src/Dns/Dns/help/Get-AzDnsRecordSet.md b/src/Dns/Dns/help/Get-AzDnsRecordSet.md index 0ac7a57459b2..4c17e598c342 100644 --- a/src/Dns/Dns/help/Get-AzDnsRecordSet.md +++ b/src/Dns/Dns/help/Get-AzDnsRecordSet.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: 40179CF3-7896-4C45-BC18-4CB653B245B6 @@ -34,31 +34,31 @@ You can use the pipeline operator to pass a **DnsZone** object to this cmdlet, o ## EXAMPLES ### Example 1: Get record sets with a specified name and type -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A +```powershell +$RecordSet = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -Name "www" -RecordType A ``` 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. ### Example 2: Get record sets of a specified type -``` -PS C:\>$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A +```powershell +$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -RecordType A ``` 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. ### Example 3: Get all record sets in a zone -``` -PS C:\>$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +```powershell +$RecordSets = Get-AzDnsRecordSet -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" ``` 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. ### Example 4: Get all record sets in a zone, using a DnsZone object -``` -PS C:\> $Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $RecordSets = Get-AzDnsRecordSet -Zone $Zone +```powershell +$Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +$RecordSets = Get-AzDnsRecordSet -Zone $Zone ``` This example is equivalent to Example 3 above. diff --git a/src/Dns/Dns/help/Get-AzDnsZone.md b/src/Dns/Dns/help/Get-AzDnsZone.md index dad5786d5746..6f4111948a8e 100644 --- a/src/Dns/Dns/help/Get-AzDnsZone.md +++ b/src/Dns/Dns/help/Get-AzDnsZone.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: B831ABE6-348C-4DD6-9295-18D23A1FDF63 @@ -33,22 +33,22 @@ You can use the **DnsZone** object to update the zone, for example you can add * ## EXAMPLES ### Example 1: Get a zone -``` -PS C:\> $Zone = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" +```powershell +$Zone = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" ``` This example gets the DNS zone named myzone.com from the specified resource group, and then stores it in the $Zone variable. ### Example 2: Get all of the zones in a resource group -``` -PS C:\> $Zones = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" +```powershell +$Zones = Get-AzDnsZone -ResourceGroupName "MyResourceGroup" ``` This example gets all of the DNS zones in the specified resource group, and then stores it in the $Zones variable. ### Example 3: Get all of the zones in a subscription -``` -PS C:\> $Zones = Get-AzDnsZone +```powershell +$Zones = Get-AzDnsZone ``` This example gets all of the DNS zones in the current Azure subscription, and then stores them in the $Zones variable. diff --git a/src/Dns/Dns/help/New-AzDnsRecordConfig.md b/src/Dns/Dns/help/New-AzDnsRecordConfig.md index 3ff4da541f16..e4ab91977410 100644 --- a/src/Dns/Dns/help/New-AzDnsRecordConfig.md +++ b/src/Dns/Dns/help/New-AzDnsRecordConfig.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: AD97BCAF-69BA-4C16-8B57-AB243D796B71 @@ -68,22 +68,22 @@ An array of these objects is passed to the New-AzDnsRecordSet cmdlet using the * ## EXAMPLES ### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -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-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) # To create a record set containing multiple records, use New-AzDnsRecordConfig to add each record to the $Records array, # then call New-AzDnsRecordSet, as follows: -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -91,10 +91,10 @@ The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single DNS record. ### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -103,10 +103,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -115,10 +115,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named www in the zone myzone.com. @@ -127,10 +127,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com +$RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named ns1 in the zone myzone.com. @@ -139,10 +139,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records ``` This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. @@ -151,10 +151,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. @@ -164,10 +164,10 @@ The service (sip) and the protocol (tcp) are specified as part of the record set To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named text in the zone myzone.com. diff --git a/src/Dns/Dns/help/New-AzDnsRecordSet.md b/src/Dns/Dns/help/New-AzDnsRecordSet.md index dfd0fb1d8a23..facc1ff3c2a4 100644 --- a/src/Dns/Dns/help/New-AzDnsRecordSet.md +++ b/src/Dns/Dns/help/New-AzDnsRecordSet.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: 45DF71E0-77E1-4D20-AD09-2C06680F659F @@ -54,22 +54,22 @@ If a matching **RecordSet** already exists (same name and record type), you must ## EXAMPLES ### Example 1: Create a RecordSet of type A -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -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-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -IPv4Address 1.2.3.4) # To create a record set containing multiple records, use New-AzDnsRecordConfig to add each record to the $Records array, # then call New-AzDnsRecordSet, as follows: -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 -PS C:\> $Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +$Records = @() +$Records += New-AzDnsRecordConfig -IPv4Address 1.2.3.4 +$Records += New-AzDnsRecordConfig -IPv4Address 5.6.7.8 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -77,10 +77,10 @@ The record set is of type A and has a TTL of 1 hour (3600 seconds). It contains a single DNS record. ### Example 2: Create a RecordSet of type AAAA -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv6Address 2001:db8::1 +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType AAAA -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -89,10 +89,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 3: Create a RecordSet of type CNAME -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Cname www.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Cname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType CNAME -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This example creates a **RecordSet** named www in the zone myzone.com. @@ -101,10 +101,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 4: Create a RecordSet of type MX -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "mail" -RecordType MX -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Exchange "mail.microsoft.com" -Preference 5 +$RecordSet = New-AzDnsRecordSet -Name "mail" -RecordType MX -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named www in the zone myzone.com. @@ -113,10 +113,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 5: Create a RecordSet of type NS -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Nsdname ns1-01.azure-dns.com +$RecordSet = New-AzDnsRecordSet -Name "ns1" -RecordType NS -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named ns1 in the zone myzone.com. @@ -125,10 +125,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 6: Create a RecordSet of type PTR -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ptrdname www.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "4" -RecordType PTR -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "3.2.1.in-addr.arpa" -DnsRecords $Records ``` This command creates a **RecordSet** named 4 in the zone 3.2.1.in-addr.arpa. @@ -137,10 +137,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 7: Create a RecordSet of type SRV -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target sipservice.contoso.com +$RecordSet = New-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named _sip._tcp in the zone myzone.com. @@ -150,10 +150,10 @@ The service (sip) and the protocol (tcp) are specified as part of the record set To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 8: Create a RecordSet of type TXT -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Value "This is a TXT Record" -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Value "This is a TXT Record" +$RecordSet = New-AzDnsRecordSet -Name "text" -RecordType TXT -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named text in the zone myzone.com. @@ -162,10 +162,10 @@ It contains a single DNS record. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 9: Create a RecordSet at the zone apex -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "@" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** at the apex (or root) of the zone myzone.com. @@ -175,10 +175,10 @@ This is a constraint of the DNS standards; it is not a limitation of Azure DNS. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 10: Create a wildcard Record Set -``` -PS C:\> $Records = @() -PS C:\> $Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 -PS C:\> $RecordSet = New-AzDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records +```powershell +$Records = @() +$Records += New-AzDnsRecordConfig -Ipv4Address 1.2.3.4 +$RecordSet = New-AzDnsRecordSet -Name "*" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords $Records ``` This command creates a **RecordSet** named * in the zone myzone.com. @@ -186,8 +186,8 @@ This is a wildcard record set. To create a **RecordSet** using only one line of pn_PowerShell_short, or to create a record set with multiple records, see Example 1. ### Example 11: Create an empty record set -``` -PS C:\>$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords @() +```powershell +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords @() ``` This command creates a **RecordSet** named www in the zone myzone.com. @@ -195,8 +195,8 @@ 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. ### Example 12: Create a record set and suppress all confirmation -``` -PS C:\>$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite +```powershell +$RecordSet = New-AzDnsRecordSet -Name "www" -RecordType A -ResourceGroupName "MyResourceGroup" -TTL 3600 -ZoneName "myzone.com" -DnsRecords (New-AzDnsRecordConfig -Ipv4Address 1.2.3.4) -Confirm:$False -Overwrite ``` This command creates a **RecordSet**. diff --git a/src/Dns/Dns/help/New-AzDnsZone.md b/src/Dns/Dns/help/New-AzDnsZone.md index 6677b3987129..08d0ee261a79 100644 --- a/src/Dns/Dns/help/New-AzDnsZone.md +++ b/src/Dns/Dns/help/New-AzDnsZone.md @@ -47,26 +47,26 @@ whether the cmdlet prompts you for confirmation. ## EXAMPLES ### Example 1: Create a DNS zone -``` -PS C:\>$Zone = New-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +```powershell +$Zone = New-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" ``` This command creates a new DNS zone named myzone.com in the specified resource group, and then stores it in the $Zone variable. ### Example 2: Create a Private DNS zone by specifying virtual network IDs -``` -PS C:\>$ResVirtualNetworkId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testresgroup/providers/Microsoft.Network/virtualNetworks/resvnet" -PS C:\>$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetworkId @($ResVirtualNetworkId) +```powershell +$ResVirtualNetworkId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testresgroup/providers/Microsoft.Network/virtualNetworks/resvnet" +$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetworkId @($ResVirtualNetworkId) ``` This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with an associated resolution virtual network (specifying its ID), and then stores it in the $Zone variable. ### Example 3: Create a Private DNS zone by specifying virtual network objects -``` -PS C:\>$ResVirtualNetwork = Get-AzVirtualNetwork -Name "resvnet" -ResourceGroupName "testresgroup" -PS C:\>$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetwork @($ResVirtualNetwork) +```powershell +$ResVirtualNetwork = Get-AzVirtualNetwork -Name "resvnet" -ResourceGroupName "testresgroup" +$Zone = New-AzDnsZone -Name "myprivatezone.com" -ResourceGroupName "MyResourceGroup" -ZoneType Private -ResolutionVirtualNetwork @($ResVirtualNetwork) ``` This command creates a new Private DNS zone named myprivatezone.com in the specified resource group with @@ -74,8 +74,8 @@ an associated resolution virtual network (referred to by $ResVirtualNetwork vari in the $Zone variable. ### Example 4: Create a DNS zone with delegation by specifying parent zone name -``` -PS C:\>$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneName "zone.com" +```powershell +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneName "zone.com" ``` This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores @@ -83,8 +83,8 @@ in the $Zone variable. It also adds delegation in the parent DNS zone named zone.com residing in the same subscription and resource group as child zone. ### Example 5: Create a DNS zone with delegation by specifying parent zone id -``` -PS C:\>$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneId "/subscriptions/**67e2/resourceGroups/other-rg/providers/Microsoft.Network/dnszones/zone.com" +```powershell +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZoneId "/subscriptions/**67e2/resourceGroups/other-rg/providers/Microsoft.Network/dnszones/zone.com" ``` This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores @@ -92,9 +92,9 @@ in the $Zone variable. It also adds delegation in the parent DNS zone named zone.com in resource group other-rg provided subscription is same as that of child zone created. ### Example 6: Create a DNS zone with delegation by specifying parent zone object -``` -PS C:\>$PZone = New-AzDnsZone -Name "zone.com" -ResourceGroupName "MyResourceGroup" -PS C:\>$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZone @($PZone) +```powershell +$PZone = New-AzDnsZone -Name "zone.com" -ResourceGroupName "MyResourceGroup" +$Zone = New-AzDnsZone -Name "mychild.zone.com" -ResourceGroupName "MyResourceGroup" -ParentZone @($PZone) ``` This command creates a new child DNS zone named mychild.zone.com in the specified resource group and stores diff --git a/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md b/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md index f2c67c71b291..0da23b894534 100644 --- a/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md +++ b/src/Dns/Dns/help/Remove-AzDnsRecordConfig.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: D1A2326C-CD41-45A6-B37A-FC6176193B01 @@ -78,14 +78,14 @@ You can pass the **RecordSet** object to this cmdlet as a parameter or by using ## EXAMPLES ### Example 1: Remove an A record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 1.2.3.4 +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "www" -RecordType A -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv4Address 1.2.3.4 | Set-AzDnsRecordSet ``` This example removes an A record from an existing record set. @@ -93,14 +93,14 @@ If this is the only record in the record set, the result will be an empty record To remove a record set entirely, see Remove-AzDnsRecordSet. ### Example 2: Remove an AAAA record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Ipv6Address 2001:DB80:4009:1803::1005 +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "www" -RecordType AAAA -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Ipv6Address 2001:DB80:4009:1803::1005 | Set-AzDnsRecordSet ``` This example removes an AAAA record from an existing record set. @@ -108,28 +108,28 @@ If this is the only record in the record set, the result will be an empty record To remove a record set entirely, see Remove-AzDnsRecordSet. ### Example 3: Remove a CNAME record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Cname contoso.com +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "www" -RecordType CNAME -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Cname contoso.com | Set-AzDnsRecordSet ``` 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. ### Example 4: Remove an MX record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "@" -RecordType MX -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Exchange mail.microsoft.com -Preference 5 | Set-AzDnsRecordSet ``` This example removes an MX record from an existing record set. @@ -138,14 +138,14 @@ 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-AzDnsRecordSet. ### Example 5: Remove an NS record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -Nsdname ns1.myzone.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "abc" -RecordType NS -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Nsdname "ns1.myzone.com" | Set-AzDnsRecordSet ``` This example removes an NS record from an existing record set. @@ -153,14 +153,14 @@ 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-AzDnsRecordSet. ### Example 6: Remove a PTR record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa -PS C:\> Remove-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName 3.2.1.in-addr.arpa +Remove-AzDnsRecordConfig -Ptrdname www.contoso.com -RecordSet $RecordSet +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "4" -RecordType PTR -ResouceGroupName "MyResourceGroup" -ZoneName "3.2.1.in-addr.arpa" | Remove-AzDnsRecordConfig -Ptrdname www.contoso.com | Set-AzDnsRecordSet ``` This example removes a PTR record from an existing record set. @@ -168,14 +168,14 @@ 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-AzDnsRecordSet. ### Example 7: Remove an SRV record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Priority 0 -Weight 5 -Port 8080 -Target target.example.com +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "_sip._tcp" -RecordType SRV -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Priority 0 -Weight 5 -Port 8080 -Target target.example.com | Set-AzDnsRecordSet ``` This example removes an SRV record from an existing record set. @@ -183,14 +183,14 @@ 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-AzDnsRecordSet. ### Example 8: Remove a TXT record from a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordConfig -RecordSet $RecordSet -Value "This is a TXT Record" +Set-AzDnsRecordSet -RecordSet $RecordSet # The above sequence can also be piped: -PS C:\> Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet +Get-AzDnsRecordSet -Name "text" -RecordType TXT -ResouceGroupName "MyResourceGroup" -ZoneName "myzone.com" | Remove-AzDnsRecordConfig -Value "This is a TXT Record" | Set-AzDnsRecordSet ``` This example removes a TXT record from an existing record set. diff --git a/src/Dns/Dns/help/Remove-AzDnsRecordSet.md b/src/Dns/Dns/help/Remove-AzDnsRecordSet.md index 742294834619..cfc91b37a6cd 100644 --- a/src/Dns/Dns/help/Remove-AzDnsRecordSet.md +++ b/src/Dns/Dns/help/Remove-AzDnsRecordSet.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: 505562A4-30BC-44E7-94EF-579763B8D794 @@ -44,23 +44,23 @@ You can suppress this by using the *Overwrite* parameter, which deletes the reco ## EXAMPLES ### Example 1: Remove a record set -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" -PS C:\> Remove-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -ResourceGroupName "MyResourceGroup" -ZoneName "myzone.com" +Remove-AzDnsRecordSet -RecordSet $RecordSet ``` 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. ### Example 2: Remove a record set and suppress all confirmation -``` -PS C:\> $RecordSet = Get-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> Remove-AzDnsRecordSet -RecordSet $RecordSet -Confirm:$False -Overwrite +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" +Remove-AzDnsRecordSet -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-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False +Remove-AzDnsRecordSet -Name "www" -ZoneName "myzone.com" -ResourceGroupName "MyResourceGroup" -Confirm:$False ``` The first command gets the specified record set. diff --git a/src/Dns/Dns/help/Remove-AzDnsZone.md b/src/Dns/Dns/help/Remove-AzDnsZone.md index fa98f12bda9b..9a67ab933aa5 100644 --- a/src/Dns/Dns/help/Remove-AzDnsZone.md +++ b/src/Dns/Dns/help/Remove-AzDnsZone.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: A8E230A0-5057-40BC-81CD-6D397A503A84 @@ -37,8 +37,8 @@ This can be suppressed using the *Overwrite* parameter, which deletes the zone r ## EXAMPLES ### Example 1: Remove a zone -``` -PS C:\>Remove-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +```powershell +Remove-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" ``` This command removes the zone named myzone.com from the resource group named MyResourceGroup. diff --git a/src/Dns/Dns/help/Set-AzDnsRecordSet.md b/src/Dns/Dns/help/Set-AzDnsRecordSet.md index 7d259ec5d78d..49dc07b99118 100644 --- a/src/Dns/Dns/help/Set-AzDnsRecordSet.md +++ b/src/Dns/Dns/help/Set-AzDnsRecordSet.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: 99E6C4DD-11AF-4DC0-848B-39811240BE06 @@ -29,15 +29,15 @@ You can suppress this behavior using the *Overwrite* parameter, which updates th ## EXAMPLES ### Example 1: Update a record set -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 -PS C:\> Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.16.0.0 +Add-AzDnsRecordConfig -RecordSet $RecordSet -Ipv4Address 172.31.255.255 +Set-AzDnsRecordSet -RecordSet $RecordSet # These cmdlets can also be piped: -PS C:\> Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzDnsRecordSet +Get-AzDnsRecordSet -ResourceGroupName MyResourceGroup -ZoneName myzone.com -Name www -RecordType A | Add-AzDnsRecordConfig -Ipv4Address 172.16.0.0 | Add-AzDnsRecordConfig -Ipv4Address 172.31.255.255 | Set-AzDnsRecordSet ``` The first command uses the Get-AzDnsRecordSet cmdlet to get the specified record set, and then stores it in the $RecordSet variable. @@ -45,10 +45,10 @@ The second and third commands are off-line operations to add two A records to th The final command uses the **Set-AzDnsRecordSet** cmdlet to commit the update. ### Example 2: Update an SOA record -``` -PS C:\>$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone -PS C:\> $RecordSet.Records[0].Email = "admin.myzone.com" -PS C:\> Set-AzDnsRecordSet -RecordSet $RecordSet +```powershell +$RecordSet = Get-AzDnsRecordSet -Name "@" -RecordType SOA -Zone $Zone +$RecordSet.Records[0].Email = "admin.myzone.com" +Set-AzDnsRecordSet -RecordSet $RecordSet ``` The first command uses the **Get-AzDnsRecordset** cmdlet to get the specified record set, and then stores it in the $RecordSet variable. diff --git a/src/Dns/Dns/help/Set-AzDnsZone.md b/src/Dns/Dns/help/Set-AzDnsZone.md index 3d8e5dc54789..7b8ed4001d74 100644 --- a/src/Dns/Dns/help/Set-AzDnsZone.md +++ b/src/Dns/Dns/help/Set-AzDnsZone.md @@ -1,4 +1,4 @@ ---- +--- external help file: Microsoft.Azure.PowerShell.Cmdlets.Dns.dll-Help.xml Module Name: Az.Dns ms.assetid: E37ADC54-A37B-41BF-BE94-9E4052C234BB @@ -50,10 +50,10 @@ which updates the zone regardless of concurrent changes. ## EXAMPLES ### Example 1: Update a DNS zone -``` -PS C:\>$Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" -PS C:\> $Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) -PS C:\> Set-AzDnsZone -Zone $Zone +```powershell +$Zone = Get-AzDnsZone -Name "myzone.com" -ResourceGroupName "MyResourceGroup" +$Zone.Tags = @(@{"Name"="Dept"; "Value"="Electrical"}) +Set-AzDnsZone -Zone $Zone ``` The first command gets the zone named myzone.com from the specified resource group, and then stores @@ -62,26 +62,26 @@ The second command updates the tags for $Zone. The final command commits the change. ### Example 2: Update tags for a zone -``` -PS C:\>Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) +```powershell +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myzone.com" -Tag @(@{"Name"="Dept"; "Value"="Electrical"}) ``` This command updates the tags for the zone named myzone.com without first explicitly getting the zone. ### Example 3: Associating a private zone with a virtual network by specifying its ID -``` -PS C:\>$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" -PS C:\>Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetworkId @($vnet.Id) +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetworkId @($vnet.Id) ``` This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network by specifying its ID. ### Example 4: Associating a private zone with a virtual network by specifying the network object. -``` -PS C:\>$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" -PS C:\>Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetwork @($vnet) +```powershell +$vnet = Get-AzVirtualNetwork -ResourceGroupName "MyResourceGroup" -Name "myvnet" +Set-AzDNSZone -ResourceGroupName "MyResourceGroup" -Name "myprivatezone.com" -RegistrationVirtualNetwork @($vnet) ``` This command associates the Private DNS zone myprivatezone.com with the virtual network myvnet as a registration network