@azure/arm-dnsresolver package
Classes
| DnsResolverManagementClient |
Interfaces
| CloudError |
An error message |
| CloudErrorBody |
The body of an error message |
| DnsForwardingRuleset |
Describes a DNS forwarding ruleset. |
| DnsForwardingRulesetPatch |
Describes a DNS forwarding ruleset PATCH operation. |
| DnsForwardingRulesetProperties |
Represents the properties of a DNS forwarding ruleset. |
| DnsForwardingRulesetsCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsDeleteOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsGetOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsListByResourceGroupOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsListByVirtualNetworkOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsListOptionalParams |
Optional parameters. |
| DnsForwardingRulesetsOperations |
Interface representing a DnsForwardingRulesets operations. |
| DnsForwardingRulesetsUpdateOptionalParams |
Optional parameters. |
| DnsResolver |
Describes a DNS resolver. |
| DnsResolverDomainList |
Describes a DNS resolver domain list. |
| DnsResolverDomainListBulk |
Describes a DNS resolver domain list for bulk UPLOAD or DOWNLOAD operations. |
| DnsResolverDomainListBulkProperties |
Describes DNS resolver domain list properties for bulk UPLOAD or DOWNLOAD operations. |
| DnsResolverDomainListPatch |
Describes a DNS resolver domain list for PATCH operation. |
| DnsResolverDomainListPatchProperties |
Represents the updatable properties of a DNS resolver domain list. |
| DnsResolverDomainListProperties |
Represents the properties of a DNS resolver domain list. |
| DnsResolverDomainListsBulkOptionalParams |
Optional parameters. |
| DnsResolverDomainListsCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsResolverDomainListsDeleteOptionalParams |
Optional parameters. |
| DnsResolverDomainListsGetOptionalParams |
Optional parameters. |
| DnsResolverDomainListsListByResourceGroupOptionalParams |
Optional parameters. |
| DnsResolverDomainListsListOptionalParams |
Optional parameters. |
| DnsResolverDomainListsOperations |
Interface representing a DnsResolverDomainLists operations. |
| DnsResolverDomainListsUpdateOptionalParams |
Optional parameters. |
| DnsResolverManagementClientOptionalParams |
Optional parameters for the client. |
| DnsResolverPatch |
Describes a DNS resolver for PATCH operation. |
| DnsResolverPoliciesCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsResolverPoliciesDeleteOptionalParams |
Optional parameters. |
| DnsResolverPoliciesGetOptionalParams |
Optional parameters. |
| DnsResolverPoliciesListByResourceGroupOptionalParams |
Optional parameters. |
| DnsResolverPoliciesListByVirtualNetworkOptionalParams |
Optional parameters. |
| DnsResolverPoliciesListOptionalParams |
Optional parameters. |
| DnsResolverPoliciesOperations |
Interface representing a DnsResolverPolicies operations. |
| DnsResolverPoliciesUpdateOptionalParams |
Optional parameters. |
| DnsResolverPolicy |
Describes a DNS resolver policy. |
| DnsResolverPolicyPatch |
Describes a DNS resolver policy for PATCH operation. |
| DnsResolverPolicyProperties |
Represents the properties of a DNS resolver policy. |
| DnsResolverPolicyVirtualNetworkLink |
Describes a DNS resolver policy virtual network link. |
| DnsResolverPolicyVirtualNetworkLinkPatch |
Describes a DNS resolver policy virtual network link for PATCH operation. |
| DnsResolverPolicyVirtualNetworkLinkProperties |
Represents the properties of a DNS resolver policy virtual network link. |
| DnsResolverPolicyVirtualNetworkLinksCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsResolverPolicyVirtualNetworkLinksDeleteOptionalParams |
Optional parameters. |
| DnsResolverPolicyVirtualNetworkLinksGetOptionalParams |
Optional parameters. |
| DnsResolverPolicyVirtualNetworkLinksListOptionalParams |
Optional parameters. |
| DnsResolverPolicyVirtualNetworkLinksOperations |
Interface representing a DnsResolverPolicyVirtualNetworkLinks operations. |
| DnsResolverPolicyVirtualNetworkLinksUpdateOptionalParams |
Optional parameters. |
| DnsResolverProperties |
Represents the properties of a DNS resolver. |
| DnsResolversCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsResolversDeleteOptionalParams |
Optional parameters. |
| DnsResolversGetOptionalParams |
Optional parameters. |
| DnsResolversListByResourceGroupOptionalParams |
Optional parameters. |
| DnsResolversListByVirtualNetworkOptionalParams |
Optional parameters. |
| DnsResolversListOptionalParams |
Optional parameters. |
| DnsResolversOperations |
Interface representing a DnsResolvers operations. |
| DnsResolversUpdateOptionalParams |
Optional parameters. |
| DnsSecurityRule |
Describes a DNS security rule. |
| DnsSecurityRuleAction |
The action to take on DNS requests that match the DNS security rule. |
| DnsSecurityRulePatch |
Describes a DNS security rule for PATCH operation. |
| DnsSecurityRulePatchProperties |
Represents the updatable properties of a DNS security rule. |
| DnsSecurityRuleProperties |
Represents the properties of a DNS security rule. |
| DnsSecurityRulesCreateOrUpdateOptionalParams |
Optional parameters. |
| DnsSecurityRulesDeleteOptionalParams |
Optional parameters. |
| DnsSecurityRulesGetOptionalParams |
Optional parameters. |
| DnsSecurityRulesListOptionalParams |
Optional parameters. |
| DnsSecurityRulesOperations |
Interface representing a DnsSecurityRules operations. |
| DnsSecurityRulesUpdateOptionalParams |
Optional parameters. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| ForwardingRule |
Describes a forwarding rule within a DNS forwarding ruleset. |
| ForwardingRulePatch |
Describes a forwarding rule for PATCH operation. |
| ForwardingRulePatchProperties |
Represents the updatable properties of a forwarding rule within a DNS forwarding ruleset. |
| ForwardingRuleProperties |
Represents the properties of a forwarding rule within a DNS forwarding ruleset. |
| ForwardingRulesCreateOrUpdateOptionalParams |
Optional parameters. |
| ForwardingRulesDeleteOptionalParams |
Optional parameters. |
| ForwardingRulesGetOptionalParams |
Optional parameters. |
| ForwardingRulesListOptionalParams |
Optional parameters. |
| ForwardingRulesOperations |
Interface representing a ForwardingRules operations. |
| ForwardingRulesUpdateOptionalParams |
Optional parameters. |
| InboundEndpoint |
Describes an inbound endpoint for a DNS resolver. |
| InboundEndpointPatch |
Describes an inbound endpoint for a DNS resolver for PATCH operation. |
| InboundEndpointProperties |
Represents the properties of an inbound endpoint for a DNS resolver. |
| InboundEndpointsCreateOrUpdateOptionalParams |
Optional parameters. |
| InboundEndpointsDeleteOptionalParams |
Optional parameters. |
| InboundEndpointsGetOptionalParams |
Optional parameters. |
| InboundEndpointsListOptionalParams |
Optional parameters. |
| InboundEndpointsOperations |
Interface representing a InboundEndpoints operations. |
| InboundEndpointsUpdateOptionalParams |
Optional parameters. |
| IpConfiguration |
IP configuration. |
| OutboundEndpoint |
Describes an outbound endpoint for a DNS resolver. |
| OutboundEndpointPatch |
Describes an outbound endpoint for a DNS resolver for PATCH operation. |
| OutboundEndpointProperties |
Represents the properties of an outbound endpoint for a DNS resolver. |
| OutboundEndpointsCreateOrUpdateOptionalParams |
Optional parameters. |
| OutboundEndpointsDeleteOptionalParams |
Optional parameters. |
| OutboundEndpointsGetOptionalParams |
Optional parameters. |
| OutboundEndpointsListOptionalParams |
Optional parameters. |
| OutboundEndpointsOperations |
Interface representing a OutboundEndpoints operations. |
| OutboundEndpointsUpdateOptionalParams |
Optional parameters. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| 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. |
| SubResource |
Reference to another ARM resource. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TargetDnsServer |
Describes a server to forward the DNS queries to. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| VirtualNetworkDnsForwardingRuleset |
Reference to DNS forwarding ruleset and associated virtual network link. |
| VirtualNetworkLink |
Describes a virtual network link. |
| VirtualNetworkLinkPatch |
Describes a virtual network link for PATCH operation. |
| VirtualNetworkLinkPatchProperties |
Represents the updatable properties of the virtual network link. |
| VirtualNetworkLinkProperties |
Represents the properties of a virtual network link. |
| VirtualNetworkLinkSubResourceProperties |
The reference to the virtual network link that associates between the DNS forwarding ruleset and virtual network. |
| VirtualNetworkLinksCreateOrUpdateOptionalParams |
Optional parameters. |
| VirtualNetworkLinksDeleteOptionalParams |
Optional parameters. |
| VirtualNetworkLinksGetOptionalParams |
Optional parameters. |
| VirtualNetworkLinksListOptionalParams |
Optional parameters. |
| VirtualNetworkLinksOperations |
Interface representing a VirtualNetworkLinks operations. |
| VirtualNetworkLinksUpdateOptionalParams |
Optional parameters. |
Type Aliases
| Action |
The action type in requests for bulk upload or download of a DNS resolver domain list. Known values supported by the serviceUpload |
| ActionType |
The type of action to take. Known values supported by the serviceAllow |
| 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. Known values supported by the serviceUser: The entity was created by a user. |
| DnsResolverState |
The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored. Known values supported by the serviceConnected |
| DnsSecurityRuleState |
The state of DNS security rule. Known values supported by the serviceEnabled |
| ForwardingRuleState |
The state of forwarding rule. Known values supported by the serviceEnabled |
| IpAllocationMethod |
Private IP address allocation method. Known values supported by the serviceStatic |
| ManagedDomainList |
Describes Managed Domain List options for DNS security rules. Known values supported by the serviceAzureDnsThreatIntel: Domain list managed by Azure DNS Threat Intelligence. |
| ProvisioningState |
The current provisioning state of the resource. Known values supported by the serviceCreating |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownAction |
The action type in requests for bulk upload or download of a DNS resolver domain list. |
| KnownActionType |
The type of action to take. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDnsResolverState |
The current status of the DNS resolver. This is a read-only property and any attempt to set this value will be ignored. |
| KnownDnsSecurityRuleState |
The state of DNS security rule. |
| KnownForwardingRuleState |
The state of forwarding rule. |
| KnownIpAllocationMethod |
Private IP address allocation method. |
| KnownManagedDomainList |
Describes Managed Domain List options for DNS security rules. |
| KnownProvisioningState |
The current provisioning state of the resource. |
| KnownVersions |
The available API versions. |
Functions
| is |
Typeguard for RestError |
| restore |
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
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e
restorePoller<TResponse, TResult>(DnsResolverManagementClient, 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: DnsResolverManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- client
- DnsResolverManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor