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

EndpointPropertiesCustomHeadersItem

Custom header name and value.

EndpointPropertiesSubnetsItem

Subnet first address, scope, and/or last address.

Endpoints

Interface representing a Endpoints.

EndpointsCreateOrUpdateOptionalParams

Optional parameters.

EndpointsDeleteOptionalParams

Optional parameters.

EndpointsGetOptionalParams

Optional parameters.

EndpointsUpdateOptionalParams

Optional parameters.

GeographicHierarchies

Interface representing a GeographicHierarchies.

GeographicHierarchiesGetDefaultOptionalParams

Optional parameters.

HeatMap

Interface representing a HeatMap.

HeatMapEndpoint

Class which is a sparse representation of a Traffic Manager endpoint.

HeatMapGetOptionalParams

Optional parameters.

HeatMapModel

Class representing a Traffic Manager HeatMap.

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.

Profile

Class representing a Traffic Manager profile.

ProfileListResult

The list Traffic Manager profiles operation response.

Profiles

Interface representing a Profiles.

ProfilesCheckTrafficManagerNameAvailabilityV2OptionalParams

Optional parameters.

ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityOptionalParams

Optional parameters.

ProfilesCreateOrUpdateOptionalParams

Optional parameters.

ProfilesDeleteOptionalParams

Optional parameters.

ProfilesGetOptionalParams

Optional parameters.

ProfilesListByResourceGroupOptionalParams

Optional parameters.

ProfilesListBySubscriptionOptionalParams

Optional parameters.

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.

TrafficManagerNameAvailability

Class representing a Traffic Manager Name Availability response.

TrafficManagerUserMetricsKeys

Interface representing a TrafficManagerUserMetricsKeys.

TrafficManagerUserMetricsKeysCreateOrUpdateOptionalParams

Optional parameters.

TrafficManagerUserMetricsKeysDeleteOptionalParams

Optional parameters.

TrafficManagerUserMetricsKeysGetOptionalParams

Optional parameters.

UserMetricsModel

Class representing Traffic Manager User Metrics.

Type Aliases

AllowedEndpointRecordType

Defines values for AllowedEndpointRecordType.
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

Defines values for AlwaysServe.
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

EndpointMonitorStatus

Defines values for EndpointMonitorStatus.
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

Defines values for EndpointStatus.
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

Defines values for EndpointType.

EndpointsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

EndpointsDeleteResponse

Contains response data for the delete operation.

EndpointsGetResponse

Contains response data for the get operation.

EndpointsUpdateResponse

Contains response data for the update operation.

GeographicHierarchiesGetDefaultResponse

Contains response data for the getDefault operation.

HeatMapGetResponse

Contains response data for the get operation.

MonitorProtocol

Defines values for MonitorProtocol.
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

Defines values for ProfileMonitorStatus.
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

Defines values for ProfileStatus.
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

ProfilesCheckTrafficManagerNameAvailabilityV2Response

Contains response data for the checkTrafficManagerNameAvailabilityV2 operation.

ProfilesCheckTrafficManagerRelativeDnsNameAvailabilityResponse

Contains response data for the checkTrafficManagerRelativeDnsNameAvailability operation.

ProfilesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ProfilesDeleteResponse

Contains response data for the delete operation.

ProfilesGetResponse

Contains response data for the get operation.

ProfilesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ProfilesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ProfilesUpdateResponse

Contains response data for the update operation.

TrafficManagerUserMetricsKeysCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

TrafficManagerUserMetricsKeysDeleteResponse

Contains response data for the delete operation.

TrafficManagerUserMetricsKeysGetResponse

Contains response data for the get operation.

TrafficRoutingMethod

Defines values for TrafficRoutingMethod.
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

Defines values for TrafficViewEnrollmentStatus.
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

KnownAllowedEndpointRecordType

Known values of AllowedEndpointRecordType that the service accepts.

KnownAlwaysServe

Known values of AlwaysServe that the service accepts.

KnownEndpointMonitorStatus

Known values of EndpointMonitorStatus that the service accepts.

KnownEndpointStatus

Known values of EndpointStatus that the service accepts.

KnownMonitorProtocol

Known values of MonitorProtocol that the service accepts.

KnownProfileMonitorStatus

Known values of ProfileMonitorStatus that the service accepts.

KnownProfileStatus

Known values of ProfileStatus that the service accepts.

KnownTrafficRoutingMethod

Known values of TrafficRoutingMethod that the service accepts.

KnownTrafficViewEnrollmentStatus

Known values of TrafficViewEnrollmentStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.