@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 10.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Class representing 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 class Endpoint extends pulumi.CustomResource {
/**
* Get an existing Endpoint resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Endpoint;
/**
* Returns true if the given object is an instance of Endpoint. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Endpoint;
/**
* If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
*/
readonly alwaysServe: pulumi.Output<string | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* List of custom headers.
*/
readonly customHeaders: pulumi.Output<outputs.trafficmanager.EndpointPropertiesResponseCustomHeaders[] | undefined>;
/**
* Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
*/
readonly endpointLocation: pulumi.Output<string | undefined>;
/**
* The monitoring status of the endpoint.
*/
readonly endpointMonitorStatus: pulumi.Output<string | undefined>;
/**
* 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: pulumi.Output<string | undefined>;
/**
* 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: pulumi.Output<string[] | undefined>;
/**
* 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: pulumi.Output<number | undefined>;
/**
* 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: pulumi.Output<number | undefined>;
/**
* 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: pulumi.Output<number | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string | undefined>;
/**
* 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: pulumi.Output<number | undefined>;
/**
* 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: pulumi.Output<outputs.trafficmanager.EndpointPropertiesResponseSubnets[] | undefined>;
/**
* 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: pulumi.Output<string | undefined>;
/**
* The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
*/
readonly targetResourceId: pulumi.Output<string | undefined>;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
readonly type: pulumi.Output<string | undefined>;
/**
* The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
*/
readonly weight: pulumi.Output<number | undefined>;
/**
* Create a Endpoint resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Endpoint resource.
*/
export interface EndpointArgs {
/**
* If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
*/
alwaysServe?: pulumi.Input<string | enums.trafficmanager.AlwaysServe>;
/**
* List of custom headers.
*/
customHeaders?: pulumi.Input<pulumi.Input<inputs.trafficmanager.EndpointPropertiesCustomHeadersArgs>[]>;
/**
* Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
*/
endpointLocation?: pulumi.Input<string>;
/**
* The monitoring status of the endpoint.
*/
endpointMonitorStatus?: pulumi.Input<string | enums.trafficmanager.EndpointMonitorStatus>;
/**
* The name of the Traffic Manager endpoint to be created or updated.
*/
endpointName?: pulumi.Input<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.
*/
endpointStatus?: pulumi.Input<string | enums.trafficmanager.EndpointStatus>;
/**
* The type of the Traffic Manager endpoint to be created or updated.
*/
endpointType: pulumi.Input<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.
*/
geoMapping?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
*/
id?: pulumi.Input<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'.
*/
minChildEndpoints?: pulumi.Input<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'.
*/
minChildEndpointsIPv4?: pulumi.Input<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'.
*/
minChildEndpointsIPv6?: pulumi.Input<number>;
/**
* The name of the resource
*/
name?: pulumi.Input<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.
*/
priority?: pulumi.Input<number>;
/**
* 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>;
/**
* 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.
*/
subnets?: pulumi.Input<pulumi.Input<inputs.trafficmanager.EndpointPropertiesSubnetsArgs>[]>;
/**
* 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.
*/
target?: pulumi.Input<string>;
/**
* The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
*/
targetResourceId?: pulumi.Input<string>;
/**
* The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
*/
type?: pulumi.Input<string>;
/**
* The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.
*/
weight?: pulumi.Input<number>;
}