@azure/arm-privatetrafficmanager package

Classes

PrivateTrafficManagerManagementClient

Interfaces

CustomHeader	Custom header name and value.
DnsConfig	DNS configuration of the Traffic Manager profile.
Endpoint	Class representing a Private Traffic Manager endpoint.
EndpointProperties	Class representing a Traffic Manager endpoint properties.
EndpointUpdate	The type used for update operations of the Endpoint.
EndpointUpdateProperties	The updatable properties of the Endpoint.
EndpointsCreateOrUpdateOptionalParams	Optional parameters.
EndpointsDeleteOptionalParams	Optional parameters.
EndpointsGetOptionalParams	Optional parameters.
EndpointsListByParentOptionalParams	Optional parameters.
EndpointsOperations	Interface representing a Endpoints operations.
EndpointsUpdateOptionalParams	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.
ExpectedStatusCodeRange	Min and max value of a status code range.
HealthPoliciesCreateOrUpdateOptionalParams	Optional parameters.
HealthPoliciesDeleteOptionalParams	Optional parameters.
HealthPoliciesGetOptionalParams	Optional parameters.
HealthPoliciesListByParentOptionalParams	Optional parameters.
HealthPoliciesOperations	Interface representing a HealthPolicies operations.
HealthPolicy	Class representing a Traffic Manager health policy.
HealthPolicyProperties	Class representing the health policy for Traffic Manager profile properties.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateTrafficManagerManagementClientOptionalParams	Optional parameters for the client.
PrivateTrafficManagerProfile	Class representing a Private Traffic Manager profile.
PrivateTrafficManagerProfileUpdate	The type used for update operations of the PrivateTrafficManagerProfile.
PrivateTrafficManagerProfileUpdateProperties	The updatable properties of the PrivateTrafficManagerProfile.
ProbeConfig	Class containing endpoint monitoring settings in a Traffic Manager profile.
ProbeHealthPolicy	Class representing a Traffic Manager health policy of kind Probe.
ProfileEndpoint	Class representing an inline endpoint within a Traffic Manager profile.
ProfileProbingGateway	Class representing a probing gateway associated with a Private Traffic Manager profile. This resource is only available when the parent profile has customTopologyMapMode set to Disabled (Basic experience).
ProfileProbingGatewayProperties	Properties of a probing gateway association with a Private Traffic Manager profile.
ProfileProbingGatewayUpdate	The type used for update operations of the ProfileProbingGateway.
ProfileProbingGatewayUpdateProperties	The updatable properties of the ProfileProbingGateway.
ProfileProbingGatewaysCreateOrUpdateOptionalParams	Optional parameters.
ProfileProbingGatewaysDeleteOptionalParams	Optional parameters.
ProfileProbingGatewaysGetOptionalParams	Optional parameters.
ProfileProbingGatewaysListByParentOptionalParams	Optional parameters.
ProfileProbingGatewaysOperations	Interface representing a ProfileProbingGateways operations.
ProfileProbingGatewaysUpdateOptionalParams	Optional parameters.
ProfileProperties	Class representing the Traffic Manager profile properties.
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 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
Site	Class representing a Site.
SiteProperties	Class representing the Site properties.
SiteUpdate	The type used for update operations of the Site.
SiteUpdateProperties	The updatable properties of the Site.
SitesCreateOrUpdateOptionalParams	Optional parameters.
SitesDeleteOptionalParams	Optional parameters.
SitesGetOptionalParams	Optional parameters.
SitesListByParentOptionalParams	Optional parameters.
SitesOperations	Interface representing a Sites operations.
SitesUpdateOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
TopologyMap	Class representing a Topology Map.
TopologyMapInlineSite	A Site embedded in a Topology Map.
TopologyMapPatch	The type used for update operations of the Topology Map.
TopologyMapPatchProperties	The properties of a Topology Map that can be updated.
TopologyMapProperties	Class representing the Topology Map properties.
TopologyMapsCreateOrUpdateOptionalParams	Optional parameters.
TopologyMapsDeleteOptionalParams	Optional parameters.
TopologyMapsGetOptionalParams	Optional parameters.
TopologyMapsListByResourceGroupOptionalParams	Optional parameters.
TopologyMapsListBySubscriptionOptionalParams	Optional parameters.
TopologyMapsOperations	Interface representing a TopologyMaps operations.
TopologyMapsUpdateOptionalParams	Optional parameters.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AdministrativeStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. KnownAdministrativeStatus can be used interchangeably with AdministrativeStatus, this enum contains the known values that the service supports. Known values supported by the service Enabled: The endpoint is enabled and is probed for health. Disabled: The endpoint is disabled and is not probed for health.
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: Always serve is enabled, endpoint health probing is disabled. Disabled: Always serve is disabled, endpoint health probing is active.
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.
CustomTopologyMapMode	The mode for custom topology map of the Private Traffic Manager profile. KnownCustomTopologyMapMode can be used interchangeably with CustomTopologyMapMode, this enum contains the known values that the service supports. Known values supported by the service Disabled: Custom topology map is disabled. Enabled: Custom topology map is enabled.
EndpointsKind	Class representing the kind of the Private Traffic Manager endpoint. KnownEndpointsKind can be used interchangeably with EndpointsKind, this enum contains the known values that the service supports. Known values supported by the service Endpoint: Private Traffic Manager Endpoint
HealthPolicyKind	Class representing kind of Traffic Manager health policy. KnownHealthPolicyKind can be used interchangeably with HealthPolicyKind, this enum contains the known values that the service supports. Known values supported by the service Probe: Health policy that uses probing to monitor endpoint health.
HealthPolicyUnion	Alias for HealthPolicyUnion
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
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: The profile is enabled and traffic routing is active. Disabled: The profile is disabled and traffic routing is inactive.
Protocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. KnownProtocol can be used interchangeably with Protocol, this enum contains the known values that the service supports. Known values supported by the service HTTP: Hypertext Transfer Protocol for health probing. HTTPS: Hypertext Transfer Protocol Secure for health probing. TCP: Transmission Control Protocol for health probing.
ProvisioningState	The provisioning state of the resource. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: The resource is being provisioned. Updating: The resource is being updated. Deleting: The resource is being deleted. Accepted: The resource provisioning request has been accepted.
RecordType	The record type of the Traffic Manager profile. KnownRecordType can be used interchangeably with RecordType, this enum contains the known values that the service supports. Known values supported by the service A: IPv4 address record type for DNS resolution. AAAA: IPv6 address record type for DNS resolution. CNAME: Canonical name record type that maps an alias to a domain name.
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 Priority: Routes traffic to endpoints based on priority values, directing to the highest priority available endpoint. Weighted: Distributes traffic across endpoints based on assigned weight values. VNet: Routes traffic to an endpoint by matching the virtual network of the DNS query to the endpoint's configured virtual networks.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAdministrativeStatus	The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
KnownAlwaysServe	If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
KnownCreatedByType	The kind of entity that created the resource.
KnownCustomTopologyMapMode	The mode for custom topology map of the Private Traffic Manager profile.
KnownEndpointsKind	Class representing the kind of the Private Traffic Manager endpoint.
KnownHealthPolicyKind	Class representing kind of Traffic Manager health policy.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProfileStatus	The status of the Traffic Manager profile.
KnownProtocol	The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
KnownProvisioningState	The provisioning state of the resource.
KnownRecordType	The record type of the Traffic Manager profile.
KnownTrafficRoutingMethod	The traffic routing method of the Traffic Manager profile.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PrivateTrafficManagerManagementClient, 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.

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

restorePoller<TResponse, TResult>(PrivateTrafficManagerManagementClient, 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: PrivateTrafficManagerManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

PrivateTrafficManagerManagementClient

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

Type

RestErrorConstructor