@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.97 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Gets a Traffic Manager endpoint.
*
* Uses Azure REST API version 2022-04-01.
*
* Other available API versions: 2015-11-01, 2017-03-01, 2017-05-01, 2018-02-01, 2018-03-01, 2018-04-01, 2018-08-01, 2022-04-01-preview, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native trafficmanager [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getEndpoint(args: GetEndpointArgs, opts?: pulumi.InvokeOptions): Promise<GetEndpointResult>;
export interface GetEndpointArgs {
/**
* The name of the Traffic Manager endpoint.
*/
endpointName: string;
/**
* The type of the Traffic Manager endpoint.
*/
endpointType: string;
/**
* The name of the Traffic Manager profile.
*/
profileName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* Class representing a Traffic Manager endpoint.
*/
export interface GetEndpointResult {
/**
* If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
*/
readonly alwaysServe?: string;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* List of custom headers.
*/
readonly customHeaders?: outputs.trafficmanager.EndpointPropertiesResponseCustomHeaders[];
/**
* Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
*/
readonly endpointLocation?: string;
/**
* The monitoring status of the endpoint.
*/
readonly endpointMonitorStatus?: string;
/**
* The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
*/
readonly endpointStatus?: string;
/**
* The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values.
*/
readonly geoMapping?: string[];
/**
* Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
*/
readonly id?: string;
/**
* The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
*/
readonly minChildEndpoints?: number;
/**
* The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
*/
readonly minChildEndpointsIPv4?: number;
/**
* The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'.
*/
readonly minChildEndpointsIPv6?: number;
/**
* The name of the resource
*/
readonly name?: string;
/**
* The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value.
*/
readonly priority?: number;
/**
* The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints.
*/
readonly subnets?: outputs.trafficmanager.EndpointPropertiesResponseSubnets[];
/**
* The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint.
*/
readonly target?: string;
/**
* The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
*/
readonly targetResourceId?: string;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
readonly type?: string;
/**
* The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
*/
readonly weight?: number;
}
/**
* Gets a Traffic Manager endpoint.
*
* Uses Azure REST API version 2022-04-01.
*
* Other available API versions: 2015-11-01, 2017-03-01, 2017-05-01, 2018-02-01, 2018-03-01, 2018-04-01, 2018-08-01, 2022-04-01-preview, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native trafficmanager [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getEndpointOutput(args: GetEndpointOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetEndpointResult>;
export interface GetEndpointOutputArgs {
/**
* The name of the Traffic Manager endpoint.
*/
endpointName: pulumi.Input<string>;
/**
* The type of the Traffic Manager endpoint.
*/
endpointType: pulumi.Input<string>;
/**
* The name of the Traffic Manager profile.
*/
profileName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}