@azure/arm-dns 5.1.1-alpha.20241024.1 → 5.2.0-beta.1

package/src/operationsInterfaces/recordSets.ts

@@ -19,7 +19,7 @@ import {
   RecordSetsCreateOrUpdateResponse,
   RecordSetsDeleteOptionalParams,
   RecordSetsGetOptionalParams,
-  RecordSetsGetResponse
+  RecordSetsGetResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -27,42 +27,42 @@ import {
 export interface RecordSets {
   /**
    * Lists the record sets of a specified type in a DNS zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
-   * @param recordType The type of record sets to enumerate.
+   * @param recordType The type of DNS record in this record set.
    * @param options The options parameters.
    */
   listByType(
     resourceGroupName: string,
     zoneName: string,
     recordType: RecordType,
-    options?: RecordSetsListByTypeOptionalParams
+    options?: RecordSetsListByTypeOptionalParams,
   ): PagedAsyncIterableIterator<RecordSet>;
   /**
    * Lists all record sets in a DNS zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param options The options parameters.
    */
   listByDnsZone(
     resourceGroupName: string,
     zoneName: string,
-    options?: RecordSetsListByDnsZoneOptionalParams
+    options?: RecordSetsListByDnsZoneOptionalParams,
   ): PagedAsyncIterableIterator<RecordSet>;
   /**
    * Lists all record sets in a DNS zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param options The options parameters.
    */
   listAllByDnsZone(
     resourceGroupName: string,
     zoneName: string,
-    options?: RecordSetsListAllByDnsZoneOptionalParams
+    options?: RecordSetsListAllByDnsZoneOptionalParams,
   ): PagedAsyncIterableIterator<RecordSet>;
   /**
    * Updates a record set within a DNS zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param relativeRecordSetName The name of the record set, relative to the name of the zone.
    * @param recordType The type of DNS record in this record set.
@@ -75,15 +75,15 @@ export interface RecordSets {
     relativeRecordSetName: string,
     recordType: RecordType,
     parameters: RecordSet,
-    options?: RecordSetsUpdateOptionalParams
+    options?: RecordSetsUpdateOptionalParams,
   ): Promise<RecordSetsUpdateResponse>;
   /**
-   * Creates or updates a record set within a DNS zone.
-   * @param resourceGroupName The name of the resource group.
+   * Creates or updates a record set within a DNS zone. Record sets of type SOA can be updated but not
+   * created (they are created when the DNS zone is created).
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param relativeRecordSetName The name of the record set, relative to the name of the zone.
-   * @param recordType The type of DNS record in this record set. Record sets of type SOA can be updated
-   *                   but not created (they are created when the DNS zone is created).
+   * @param recordType The type of DNS record in this record set.
    * @param parameters Parameters supplied to the CreateOrUpdate operation.
    * @param options The options parameters.
    */
@@ -93,15 +93,15 @@ export interface RecordSets {
     relativeRecordSetName: string,
     recordType: RecordType,
     parameters: RecordSet,
-    options?: RecordSetsCreateOrUpdateOptionalParams
+    options?: RecordSetsCreateOrUpdateOptionalParams,
   ): Promise<RecordSetsCreateOrUpdateResponse>;
   /**
-   * Deletes a record set from a DNS zone. This operation cannot be undone.
-   * @param resourceGroupName The name of the resource group.
+   * Deletes a record set from a DNS zone. This operation cannot be undone. Record sets of type SOA
+   * cannot be deleted (they are deleted when the DNS zone is deleted).
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param relativeRecordSetName The name of the record set, relative to the name of the zone.
-   * @param recordType The type of DNS record in this record set. Record sets of type SOA cannot be
-   *                   deleted (they are deleted when the DNS zone is deleted).
+   * @param recordType The type of DNS record in this record set.
    * @param options The options parameters.
    */
   delete(
@@ -109,11 +109,11 @@ export interface RecordSets {
     zoneName: string,
     relativeRecordSetName: string,
     recordType: RecordType,
-    options?: RecordSetsDeleteOptionalParams
+    options?: RecordSetsDeleteOptionalParams,
   ): Promise<void>;
   /**
    * Gets a record set.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param relativeRecordSetName The name of the record set, relative to the name of the zone.
    * @param recordType The type of DNS record in this record set.
@@ -124,6 +124,6 @@ export interface RecordSets {
     zoneName: string,
     relativeRecordSetName: string,
     recordType: RecordType,
-    options?: RecordSetsGetOptionalParams
+    options?: RecordSetsGetOptionalParams,
   ): Promise<RecordSetsGetResponse>;
 }

package/src/operationsInterfaces/zones.ts

@@ -7,7 +7,7 @@
  */
 
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
-import { PollerLike, PollOperationState } from "@azure/core-lro";
+import { SimplePollerLike, OperationState } from "@azure/core-lro";
 import {
   Zone,
   ZonesListByResourceGroupOptionalParams,
@@ -19,7 +19,7 @@ import {
   ZonesGetResponse,
   ZoneUpdate,
   ZonesUpdateOptionalParams,
-  ZonesUpdateResponse
+  ZonesUpdateResponse,
 } from "../models";
 
 /// <reference lib="esnext.asynciterable" />
@@ -27,12 +27,12 @@ import {
 export interface Zones {
   /**
    * Lists the DNS zones within a resource group.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param options The options parameters.
    */
   listByResourceGroup(
     resourceGroupName: string,
-    options?: ZonesListByResourceGroupOptionalParams
+    options?: ZonesListByResourceGroupOptionalParams,
   ): PagedAsyncIterableIterator<Zone>;
   /**
    * Lists the DNS zones in all resource groups in a subscription.
@@ -41,7 +41,7 @@ export interface Zones {
   list(options?: ZonesListOptionalParams): PagedAsyncIterableIterator<Zone>;
   /**
    * Creates or updates a DNS zone. Does not modify DNS records within the zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param parameters Parameters supplied to the CreateOrUpdate operation.
    * @param options The options parameters.
@@ -50,46 +50,46 @@ export interface Zones {
     resourceGroupName: string,
     zoneName: string,
     parameters: Zone,
-    options?: ZonesCreateOrUpdateOptionalParams
+    options?: ZonesCreateOrUpdateOptionalParams,
   ): Promise<ZonesCreateOrUpdateResponse>;
   /**
    * Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot
    * be undone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param options The options parameters.
    */
   beginDelete(
     resourceGroupName: string,
     zoneName: string,
-    options?: ZonesDeleteOptionalParams
-  ): Promise<PollerLike<PollOperationState<void>, void>>;
+    options?: ZonesDeleteOptionalParams,
+  ): Promise<SimplePollerLike<OperationState<void>, void>>;
   /**
    * Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot
    * be undone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param options The options parameters.
    */
   beginDeleteAndWait(
     resourceGroupName: string,
     zoneName: string,
-    options?: ZonesDeleteOptionalParams
+    options?: ZonesDeleteOptionalParams,
   ): Promise<void>;
   /**
    * Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param options The options parameters.
    */
   get(
     resourceGroupName: string,
     zoneName: string,
-    options?: ZonesGetOptionalParams
+    options?: ZonesGetOptionalParams,
   ): Promise<ZonesGetResponse>;
   /**
    * Updates a DNS zone. Does not modify DNS records within the zone.
-   * @param resourceGroupName The name of the resource group.
+   * @param resourceGroupName The name of the resource group. The name is case insensitive.
    * @param zoneName The name of the DNS zone (without a terminating dot).
    * @param parameters Parameters supplied to the Update operation.
    * @param options The options parameters.
@@ -98,6 +98,6 @@ export interface Zones {
     resourceGroupName: string,
     zoneName: string,
     parameters: ZoneUpdate,
-    options?: ZonesUpdateOptionalParams
+    options?: ZonesUpdateOptionalParams,
   ): Promise<ZonesUpdateResponse>;
 }

package/src/pagingHelper.ts

@@ -13,11 +13,11 @@ export interface PageInfo {
 const pageMap = new WeakMap<object, PageInfo>();
 
 /**
- * Given a result page from a pageable operation, returns a
- * continuation token that can be used to begin paging from
+ * Given the last `.value` produced by the `byPage` iterator,
+ * returns a continuation token that can be used to begin paging from
  * that point later.
- * @param page A result object from calling .byPage() on a paged operation.
- * @returns The continuation token that can be passed into byPage().
+ * @param page An object from accessing `value` on the IteratorResult from a `byPage` iterator.
+ * @returns The continuation token that can be passed into byPage() during future calls.
  */
 export function getContinuationToken(page: unknown): string | undefined {
   if (typeof page !== "object" || page === null) {
@@ -28,7 +28,7 @@ export function getContinuationToken(page: unknown): string | undefined {
 
 export function setContinuationToken(
   page: unknown,
-  continuationToken: string | undefined
+  continuationToken: string | undefined,
 ): void {
   if (typeof page !== "object" || page === null || !continuationToken) {
     return;