@azure/arm-trafficmanager package

Classes

TrafficManagerManagementClient

Interfaces

CheckTrafficManagerRelativeDnsNameAvailabilityParameters	Parameters supplied to check Traffic Manager name operation.
CloudError	An error returned by the Azure Resource Manager
CloudErrorBody	The content of an error returned by the Azure Resource Manager
DeleteOperationResult	The result of the request or operation.
DnsConfig	Class containing DNS settings in a Traffic Manager profile.
Endpoint	Class representing a Traffic Manager endpoint.
EndpointProperties	Class representing a Traffic Manager endpoint properties.
EndpointPropertiesCustomHeadersItem	Custom header name and value.
EndpointPropertiesSubnetsItem	Subnet first address, scope, and/or last address.
EndpointsCreateOrUpdateOptionalParams	Optional parameters.
EndpointsDeleteOptionalParams	Optional parameters.
EndpointsGetOptionalParams	Optional parameters.
EndpointsOperations	Interface representing a Endpoints operations.
EndpointsUpdateOptionalParams	Optional parameters.
GeographicHierarchiesGetDefaultOptionalParams	Optional parameters.
GeographicHierarchiesOperations	Interface representing a GeographicHierarchies operations.
GeographicHierarchyProperties	Class representing the properties of the Geographic hierarchy used with the Geographic traffic routing method.
HeatMapEndpoint	Class which is a sparse representation of a Traffic Manager endpoint.
HeatMapGetOptionalParams	Optional parameters.
HeatMapModel	Class representing a Traffic Manager HeatMap.
HeatMapOperations	Interface representing a HeatMap operations.
HeatMapProperties	Class representing a Traffic Manager HeatMap properties.
MonitorConfig	Class containing endpoint monitoring settings in a Traffic Manager profile.
MonitorConfigCustomHeadersItem	Custom header name and value.
MonitorConfigExpectedStatusCodeRangesItem	Min and max value of a status code range.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
Profile	Class representing a Traffic Manager profile.
ProfileProperties	Class representing the Traffic Manager profile properties.
ProfilesCheckTrafficManagerNameAvailabilityV2OptionalParams	Optional parameters.
ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityOptionalParams	Optional parameters.
ProfilesCreateOrUpdateOptionalParams	Optional parameters.
ProfilesDeleteOptionalParams	Optional parameters.
ProfilesGetOptionalParams	Optional parameters.
ProfilesListByResourceGroupOptionalParams	Optional parameters.
ProfilesListBySubscriptionOptionalParams	Optional parameters.
ProfilesOperations	Interface representing a Profiles operations.
ProfilesUpdateOptionalParams	Optional parameters.
ProxyResource	The resource model definition for a ARM proxy resource. It will have everything other than required location and tags
QueryExperience	Class representing a Traffic Manager HeatMap query experience properties.
Region	Class representing a region in the Geographic hierarchy used with the Geographic traffic routing method.
Resource	The core properties of ARM resources
TrackedResource	The resource model definition for a ARM tracked top level resource
TrafficFlow	Class representing a Traffic Manager HeatMap traffic flow properties.
TrafficManagerGeographicHierarchy	Class representing the Geographic hierarchy used with the Geographic traffic routing method.
TrafficManagerManagementClientOptionalParams	Optional parameters for the client.
TrafficManagerNameAvailability	Class representing a Traffic Manager Name Availability response.
TrafficManagerUserMetricsKeysCreateOrUpdateOptionalParams	Optional parameters.
TrafficManagerUserMetricsKeysDeleteOptionalParams	Optional parameters.
TrafficManagerUserMetricsKeysGetOptionalParams	Optional parameters.
TrafficManagerUserMetricsKeysOperations	Interface representing a TrafficManagerUserMetricsKeys operations.
UserMetricsModel	Class representing Traffic Manager User Metrics.
UserMetricsProperties	Class representing a Traffic Manager Real User Metrics key response.

Type Aliases

AllowedEndpointRecordType	The allowed type DNS record types for this profile. KnownAllowedEndpointRecordType can be used interchangeably with AllowedEndpointRecordType, this enum contains the known values that the service supports. Known values supported by the service DomainName IPv4Address IPv6Address Any
AlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. KnownAlwaysServe can be used interchangeably with AlwaysServe, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
EndpointMonitorStatus	The monitoring status of the endpoint. KnownEndpointMonitorStatus can be used interchangeably with EndpointMonitorStatus, this enum contains the known values that the service supports. Known values supported by the service CheckingEndpoint Online Degraded Disabled Inactive Stopped Unmonitored
EndpointStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. KnownEndpointStatus can be used interchangeably with EndpointStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
EndpointType	Type of EndpointType
MonitorProtocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. KnownMonitorProtocol can be used interchangeably with MonitorProtocol, this enum contains the known values that the service supports. Known values supported by the service HTTP HTTPS TCP
ProfileMonitorStatus	The profile-level monitoring status of the Traffic Manager profile. KnownProfileMonitorStatus can be used interchangeably with ProfileMonitorStatus, this enum contains the known values that the service supports. Known values supported by the service CheckingEndpoints Online Degraded Disabled Inactive
ProfileStatus	The status of the Traffic Manager profile. KnownProfileStatus can be used interchangeably with ProfileStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
RecordType	When record type is set, a traffic manager profile will allow only endpoints that match this type. KnownRecordType can be used interchangeably with RecordType, this enum contains the known values that the service supports. Known values supported by the service A: A record type. AAAA: AAAA record type. CNAME: CNAME record type.
TrafficRoutingMethod	The traffic routing method of the Traffic Manager profile. KnownTrafficRoutingMethod can be used interchangeably with TrafficRoutingMethod, this enum contains the known values that the service supports. Known values supported by the service Performance Priority Weighted Geographic MultiValue Subnet
TrafficViewEnrollmentStatus	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile. KnownTrafficViewEnrollmentStatus can be used interchangeably with TrafficViewEnrollmentStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAllowedEndpointRecordType	The allowed type DNS record types for this profile.
KnownAlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
KnownEndpointMonitorStatus	The monitoring status of the endpoint.
KnownEndpointStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
KnownMonitorProtocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
KnownProfileMonitorStatus	The profile-level monitoring status of the Traffic Manager profile.
KnownProfileStatus	The status of the Traffic Manager profile.
KnownRecordType	When record type is set, a traffic manager profile will allow only endpoints that match this type.
KnownTrafficRoutingMethod	The traffic routing method of the Traffic Manager profile.
KnownTrafficViewEnrollmentStatus	Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
KnownVersions	The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor