Azure Native v1.102.0, May 2 23

azure-native.network.getEndpoint

Explore with Pulumi AI

Gets a Traffic Manager endpoint. API Version: 2018-08-01.

Using getEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>

def get_endpoint(endpoint_name: Optional[str] = None,
                 endpoint_type: Optional[str] = None,
                 profile_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetEndpointResult
def get_endpoint_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                 endpoint_type: Optional[pulumi.Input[str]] = None,
                 profile_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]

func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

> Note: This function is named LookupEndpoint in the Go SDK.

public static class GetEndpoint 
{
    public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:network:getEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

EndpointName string: The name of the Traffic Manager endpoint.
EndpointType string: The type of the Traffic Manager endpoint.
ProfileName string: The name of the Traffic Manager profile.
ResourceGroupName string: The name of the resource group containing the Traffic Manager endpoint.

EndpointName string: The name of the Traffic Manager endpoint.
EndpointType string: The type of the Traffic Manager endpoint.
ProfileName string: The name of the Traffic Manager profile.
ResourceGroupName string: The name of the resource group containing the Traffic Manager endpoint.

endpointName String: The name of the Traffic Manager endpoint.
endpointType String: The type of the Traffic Manager endpoint.
profileName String: The name of the Traffic Manager profile.
resourceGroupName String: The name of the resource group containing the Traffic Manager endpoint.

endpointName string: The name of the Traffic Manager endpoint.
endpointType string: The type of the Traffic Manager endpoint.
profileName string: The name of the Traffic Manager profile.
resourceGroupName string: The name of the resource group containing the Traffic Manager endpoint.

endpoint_name str: The name of the Traffic Manager endpoint.
endpoint_type str: The type of the Traffic Manager endpoint.
profile_name str: The name of the Traffic Manager profile.
resource_group_name str: The name of the resource group containing the Traffic Manager endpoint.

endpointName String: The name of the Traffic Manager endpoint.
endpointType String: The type of the Traffic Manager endpoint.
profileName String: The name of the Traffic Manager profile.
resourceGroupName String: The name of the resource group containing the Traffic Manager endpoint.

getEndpoint Result

The following output properties are available:

CustomHeaders List<Pulumi.AzureNative.Network.Outputs.EndpointPropertiesResponseCustomHeaders>: List of custom headers.
EndpointLocation string: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
EndpointMonitorStatus string: The monitoring status of the endpoint.
EndpointStatus 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.
GeoMapping List<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.
Id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
MinChildEndpoints double: 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'.
MinChildEndpointsIPv4 double: 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'.
MinChildEndpointsIPv6 double: 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'.
Name string: The name of the resource
Priority double: 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.
Subnets List<Pulumi.AzureNative.Network.Outputs.EndpointPropertiesResponseSubnets>: 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.
Target string: 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.
TargetResourceId string: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
Type string: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
Weight double: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

CustomHeaders []EndpointPropertiesResponseCustomHeaders: List of custom headers.
EndpointLocation string: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
EndpointMonitorStatus string: The monitoring status of the endpoint.
EndpointStatus 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.
GeoMapping []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.
Id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
MinChildEndpoints float64: 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'.
MinChildEndpointsIPv4 float64: 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'.
MinChildEndpointsIPv6 float64: 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'.
Name string: The name of the resource
Priority float64: 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.
Subnets []EndpointPropertiesResponseSubnets: 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.
Target string: 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.
TargetResourceId string: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
Type string: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
Weight float64: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

customHeaders List<EndpointPropertiesResponseCustomHeaders>: List of custom headers.
endpointLocation String: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpointMonitorStatus String: The monitoring status of the endpoint.
endpointStatus 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.
geoMapping List<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.
id String: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
minChildEndpoints Double: 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'.
minChildEndpointsIPv4 Double: 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'.
minChildEndpointsIPv6 Double: 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'.
name String: The name of the resource
priority Double: 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.
subnets List<EndpointPropertiesResponseSubnets>: 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.
target String: 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.
targetResourceId String: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
type String: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
weight Double: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

customHeaders EndpointPropertiesResponseCustomHeaders[]: List of custom headers.
endpointLocation string: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpointMonitorStatus string: The monitoring status of the endpoint.
endpointStatus 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.
geoMapping 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.
id string: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
minChildEndpoints number: 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'.
minChildEndpointsIPv4 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'.
minChildEndpointsIPv6 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'.
name string: The name of the resource
priority number: 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.
subnets EndpointPropertiesResponseSubnets[]: 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.
target string: 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.
targetResourceId string: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
type string: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
weight number: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

custom_headers Sequence[EndpointPropertiesResponseCustomHeaders]: List of custom headers.
endpoint_location str: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpoint_monitor_status str: The monitoring status of the endpoint.
endpoint_status str: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method.
geo_mapping Sequence[str]: 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.
id str: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
min_child_endpoints float: 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'.
min_child_endpoints_i_pv4 float: 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'.
min_child_endpoints_i_pv6 float: 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'.
name str: The name of the resource
priority float: 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.
subnets Sequence[EndpointPropertiesResponseSubnets]: 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.
target str: 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_resource_id str: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
type str: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
weight float: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

customHeaders List<Property Map>: List of custom headers.
endpointLocation String: Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method.
endpointMonitorStatus String: The monitoring status of the endpoint.
endpointStatus 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.
geoMapping List<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.
id String: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
minChildEndpoints Number: 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'.
minChildEndpointsIPv4 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'.
minChildEndpointsIPv6 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'.
name String: The name of the resource
priority Number: 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.
subnets List<Property Map>: 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.
target String: 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.
targetResourceId String: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'.
type String: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
weight Number: The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000.

Supporting Types

EndpointPropertiesResponseCustomHeaders

Name string: Header name.
Value string: Header value.

Name string: Header name.
Value string: Header value.

name String: Header name.
value String: Header value.

name string: Header name.
value string: Header value.

name str: Header name.
value str: Header value.

name String: Header name.
value String: Header value.

EndpointPropertiesResponseSubnets

First string: First address in the subnet.
Last string: Last address in the subnet.
Scope int: Block size (number of leading bits in the subnet mask).

First string: First address in the subnet.
Last string: Last address in the subnet.
Scope int: Block size (number of leading bits in the subnet mask).

first String: First address in the subnet.
last String: Last address in the subnet.
scope Integer: Block size (number of leading bits in the subnet mask).

first string: First address in the subnet.
last string: Last address in the subnet.
scope number: Block size (number of leading bits in the subnet mask).

first str: First address in the subnet.
last str: Last address in the subnet.
scope int: Block size (number of leading bits in the subnet mask).

first String: First address in the subnet.
last String: Last address in the subnet.
scope Number: Block size (number of leading bits in the subnet mask).

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0