@azure/arm-privatedns package

Classes

Interfaces

ARecord	An A record.
AaaaRecord	An AAAA record.
CloudError	An error response from the service.
CloudErrorBody	An error response from the service.
CnameRecord	A CNAME record.
MxRecord	An MX record.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateDnsManagementClientOptionalParams	Optional parameters for the client.
PrivateZone	Describes a Private DNS zone.
PrivateZoneProperties	Represents the properties of the Private DNS zone.
PrivateZonesCreateOrUpdateOptionalParams	Optional parameters.
PrivateZonesDeleteOptionalParams	Optional parameters.
PrivateZonesGetOptionalParams	Optional parameters.
PrivateZonesListByResourceGroupOptionalParams	Optional parameters.
PrivateZonesListOptionalParams	Optional parameters.
PrivateZonesOperations	Interface representing a PrivateZones operations.
PrivateZonesUpdateOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
PtrRecord	A PTR record.
RecordSet	Describes a DNS record set (a collection of DNS records with the same name and type) in a Private DNS zone.
RecordSetProperties	Represents the properties of the records in the record set.
RecordSetsCreateOrUpdateOptionalParams	Optional parameters.
RecordSetsDeleteOptionalParams	Optional parameters.
RecordSetsGetOptionalParams	Optional parameters.
RecordSetsListByTypeOptionalParams	Optional parameters.
RecordSetsListOptionalParams	Optional parameters.
RecordSetsOperations	Interface representing a RecordSets operations.
RecordSetsUpdateOptionalParams	Optional parameters.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SoaRecord	An SOA record.
SrvRecord	An SRV record.
SubResource	Reference to another subresource.
SystemData	Metadata pertaining to creation and last modification of the resource.
TxtRecord	A TXT record.
VirtualNetworkLink	Describes a link to virtual network for a Private DNS zone.
VirtualNetworkLinkProperties	Represents the properties of the Private DNS zone.
VirtualNetworkLinksCreateOrUpdateOptionalParams	Optional parameters.
VirtualNetworkLinksDeleteOptionalParams	Optional parameters.
VirtualNetworkLinksGetOptionalParams	Optional parameters.
VirtualNetworkLinksListOptionalParams	Optional parameters.
VirtualNetworkLinksOperations	Interface representing a VirtualNetworkLinks operations.
VirtualNetworkLinksUpdateOptionalParams	Optional parameters.

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
ProvisioningState	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Failed Canceled
RecordType	Type of RecordType
ResolutionPolicy	The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response. KnownResolutionPolicy can be used interchangeably with ResolutionPolicy, this enum contains the known values that the service supports. Known values supported by the service Default NxDomainRedirect
VirtualNetworkLinkState	The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored. KnownVirtualNetworkLinkState can be used interchangeably with VirtualNetworkLinkState, this enum contains the known values that the service supports. Known values supported by the service InProgress Completed

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCreatedByType	The kind of entity that created the resource.
KnownProvisioningState	The provisioning state of the resource. This is a read-only property and any attempt to set this value will be ignored.
KnownResolutionPolicy	The resolution policy on the virtual network link. Only applicable for virtual network links to privatelink zones, and for A,AAAA,CNAME queries. When set to 'NxDomainRedirect', Azure DNS resolver falls back to public resolution if private dns query resolution results in non-existent domain response.
KnownVersions	The available API versions.
KnownVirtualNetworkLinkState	The status of the virtual network link to the Private DNS zone. Possible values are 'InProgress' and 'Done'. This is a read-only property and any attempt to set this value will be ignored.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PrivateDnsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(PrivateDnsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PrivateDnsManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: PrivateDnsManagementClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-privatedns package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(PrivateDnsManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type