Package version:

Interface Zones

Interface representing a Zones.

interface Zones {
    beginDelete(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, zoneName: string, options?: ZonesDeleteOptionalParams): Promise<void>;
    createOrUpdate(resourceGroupName: string, zoneName: string, parameters: Zone, options?: ZonesCreateOrUpdateOptionalParams): Promise<Zone>;
    get(resourceGroupName: string, zoneName: string, options?: ZonesGetOptionalParams): Promise<Zone>;
    list(options?: ZonesListOptionalParams): PagedAsyncIterableIterator<Zone>;
    listByResourceGroup(resourceGroupName: string, options?: ZonesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Zone>;
    update(resourceGroupName: string, zoneName: string, parameters: ZoneUpdate, options?: ZonesUpdateOptionalParams): Promise<Zone>;
}

Methods

  • Deletes a DNS zone. WARNING: All DNS records in the zone will also be deleted. This operation cannot be undone.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • zoneName: string

      The name of the DNS zone (without a terminating dot).

    • Optionaloptions: ZonesDeleteOptionalParams

      The options parameters.

    Returns 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.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • zoneName: string

      The name of the DNS zone (without a terminating dot).

    • Optionaloptions: ZonesDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

  • Creates or updates a DNS zone. Does not modify DNS records within the zone.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • zoneName: string

      The name of the DNS zone (without a terminating dot).

    • parameters: Zone

      Parameters supplied to the CreateOrUpdate operation.

    • Optionaloptions: ZonesCreateOrUpdateOptionalParams

      The options parameters.

    Returns Promise<Zone>

  • Gets a DNS zone. Retrieves the zone properties, but not the record sets within the zone.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • zoneName: string

      The name of the DNS zone (without a terminating dot).

    • Optionaloptions: ZonesGetOptionalParams

      The options parameters.

    Returns Promise<Zone>

  • Updates a DNS zone. Does not modify DNS records within the zone.

    Parameters

    • resourceGroupName: string

      The name of the resource group. The name is case insensitive.

    • zoneName: string

      The name of the DNS zone (without a terminating dot).

    • parameters: ZoneUpdate

      Parameters supplied to the Update operation.

    • Optionaloptions: ZonesUpdateOptionalParams

      The options parameters.

    Returns Promise<Zone>