Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getProfile
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getProfile

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a Traffic Manager profile. Azure REST API version: 2022-04-01.

    Other available API versions: 2022-04-01-preview.

    Using getProfile

    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 getProfile(args: GetProfileArgs, opts?: InvokeOptions): Promise<GetProfileResult>
function getProfileOutput(args: GetProfileOutputArgs, opts?: InvokeOptions): Output<GetProfileResult>
    def get_profile(profile_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProfileResult
def get_profile_output(profile_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProfileResult]
    func LookupProfile(ctx *Context, args *LookupProfileArgs, opts ...InvokeOption) (*LookupProfileResult, error)
func LookupProfileOutput(ctx *Context, args *LookupProfileOutputArgs, opts ...InvokeOption) LookupProfileResultOutput

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

    public static class GetProfile 
{
    public static Task<GetProfileResult> InvokeAsync(GetProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetProfileResult> Invoke(GetProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)
public static Output<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ProfileName string
    The name of the Traffic Manager profile.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ProfileName string
    The name of the Traffic Manager profile.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    profileName String
    The name of the Traffic Manager profile.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    profileName string
    The name of the Traffic Manager profile.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    profile_name str
    The name of the Traffic Manager profile.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    profileName String
    The name of the Traffic Manager profile.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getProfile Result

    The following output properties are available:

    AllowedEndpointRecordTypes List<string>
    The list of allowed endpoint record types.
    DnsConfig Pulumi.AzureNative.Network.Outputs.DnsConfigResponse
    The DNS settings of the Traffic Manager profile.
    Endpoints List<Pulumi.AzureNative.Network.Outputs.EndpointResponse>
    The list of endpoints in the Traffic Manager profile.
    Id string
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    Location string
    The Azure Region where the resource lives
    MaxReturn double
    Maximum number of endpoints to be returned for MultiValue routing type.
    MonitorConfig Pulumi.AzureNative.Network.Outputs.MonitorConfigResponse
    The endpoint monitoring settings of the Traffic Manager profile.
    Name string
    The name of the resource
    ProfileStatus string
    The status of the Traffic Manager profile.
    Tags Dictionary<string, string>
    Resource tags.
    TrafficRoutingMethod string
    The traffic routing method of the Traffic Manager profile.
    TrafficViewEnrollmentStatus string
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    Type string
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    AllowedEndpointRecordTypes []string
    The list of allowed endpoint record types.
    DnsConfig DnsConfigResponse
    The DNS settings of the Traffic Manager profile.
    Endpoints []EndpointResponse
    The list of endpoints in the Traffic Manager profile.
    Id string
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    Location string
    The Azure Region where the resource lives
    MaxReturn float64
    Maximum number of endpoints to be returned for MultiValue routing type.
    MonitorConfig MonitorConfigResponse
    The endpoint monitoring settings of the Traffic Manager profile.
    Name string
    The name of the resource
    ProfileStatus string
    The status of the Traffic Manager profile.
    Tags map[string]string
    Resource tags.
    TrafficRoutingMethod string
    The traffic routing method of the Traffic Manager profile.
    TrafficViewEnrollmentStatus string
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    Type string
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    allowedEndpointRecordTypes List<String>
    The list of allowed endpoint record types.
    dnsConfig DnsConfigResponse
    The DNS settings of the Traffic Manager profile.
    endpoints List<EndpointResponse>
    The list of endpoints in the Traffic Manager profile.
    id String
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    location String
    The Azure Region where the resource lives
    maxReturn Double
    Maximum number of endpoints to be returned for MultiValue routing type.
    monitorConfig MonitorConfigResponse
    The endpoint monitoring settings of the Traffic Manager profile.
    name String
    The name of the resource
    profileStatus String
    The status of the Traffic Manager profile.
    tags Map<String,String>
    Resource tags.
    trafficRoutingMethod String
    The traffic routing method of the Traffic Manager profile.
    trafficViewEnrollmentStatus String
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    type String
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    allowedEndpointRecordTypes string[]
    The list of allowed endpoint record types.
    dnsConfig DnsConfigResponse
    The DNS settings of the Traffic Manager profile.
    endpoints EndpointResponse[]
    The list of endpoints in the Traffic Manager profile.
    id string
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    location string
    The Azure Region where the resource lives
    maxReturn number
    Maximum number of endpoints to be returned for MultiValue routing type.
    monitorConfig MonitorConfigResponse
    The endpoint monitoring settings of the Traffic Manager profile.
    name string
    The name of the resource
    profileStatus string
    The status of the Traffic Manager profile.
    tags {[key: string]: string}
    Resource tags.
    trafficRoutingMethod string
    The traffic routing method of the Traffic Manager profile.
    trafficViewEnrollmentStatus string
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    type string
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    allowed_endpoint_record_types Sequence[str]
    The list of allowed endpoint record types.
    dns_config DnsConfigResponse
    The DNS settings of the Traffic Manager profile.
    endpoints Sequence[EndpointResponse]
    The list of endpoints in the Traffic Manager profile.
    id str
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    location str
    The Azure Region where the resource lives
    max_return float
    Maximum number of endpoints to be returned for MultiValue routing type.
    monitor_config MonitorConfigResponse
    The endpoint monitoring settings of the Traffic Manager profile.
    name str
    The name of the resource
    profile_status str
    The status of the Traffic Manager profile.
    tags Mapping[str, str]
    Resource tags.
    traffic_routing_method str
    The traffic routing method of the Traffic Manager profile.
    traffic_view_enrollment_status str
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    type str
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.
    allowedEndpointRecordTypes List<String>
    The list of allowed endpoint record types.
    dnsConfig Property Map
    The DNS settings of the Traffic Manager profile.
    endpoints List<Property Map>
    The list of endpoints in the Traffic Manager profile.
    id String
    Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}
    location String
    The Azure Region where the resource lives
    maxReturn Number
    Maximum number of endpoints to be returned for MultiValue routing type.
    monitorConfig Property Map
    The endpoint monitoring settings of the Traffic Manager profile.
    name String
    The name of the resource
    profileStatus String
    The status of the Traffic Manager profile.
    tags Map<String>
    Resource tags.
    trafficRoutingMethod String
    The traffic routing method of the Traffic Manager profile.
    trafficViewEnrollmentStatus String
    Indicates whether Traffic View is 'Enabled' or 'Disabled' for the Traffic Manager profile. Null, indicates 'Disabled'. Enabling this feature will increase the cost of the Traffic Manage profile.
    type String
    The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles.

    Supporting Types

    DnsConfigResponse

    Fqdn string
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    RelativeName string
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    Ttl double
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
    Fqdn string
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    RelativeName string
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    Ttl float64
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
    fqdn String
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    relativeName String
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    ttl Double
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
    fqdn string
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    relativeName string
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    ttl number
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
    fqdn str
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    relative_name str
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    ttl float
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.
    fqdn String
    The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager.
    relativeName String
    The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile.
    ttl Number
    The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile.

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

    EndpointResponse

    AlwaysServe string
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    CustomHeaders List<Pulumi.AzureNative.Network.Inputs.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.Inputs.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.
    AlwaysServe string
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    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.
    alwaysServe String
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    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.
    alwaysServe string
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    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.
    always_serve str
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    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.
    alwaysServe String
    If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method.
    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.

    MonitorConfigResponse

    CustomHeaders List<Pulumi.AzureNative.Network.Inputs.MonitorConfigResponseCustomHeaders>
    List of custom headers.
    ExpectedStatusCodeRanges List<Pulumi.AzureNative.Network.Inputs.MonitorConfigResponseExpectedStatusCodeRanges>
    List of expected status code ranges.
    IntervalInSeconds double
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    Path string
    The path relative to the endpoint domain name used to probe for endpoint health.
    Port double
    The TCP port used to probe for endpoint health.
    ProfileMonitorStatus string
    The profile-level monitoring status of the Traffic Manager profile.
    Protocol string
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    TimeoutInSeconds double
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    ToleratedNumberOfFailures double
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
    CustomHeaders []MonitorConfigResponseCustomHeaders
    List of custom headers.
    ExpectedStatusCodeRanges []MonitorConfigResponseExpectedStatusCodeRanges
    List of expected status code ranges.
    IntervalInSeconds float64
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    Path string
    The path relative to the endpoint domain name used to probe for endpoint health.
    Port float64
    The TCP port used to probe for endpoint health.
    ProfileMonitorStatus string
    The profile-level monitoring status of the Traffic Manager profile.
    Protocol string
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    TimeoutInSeconds float64
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    ToleratedNumberOfFailures float64
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
    customHeaders List<MonitorConfigResponseCustomHeaders>
    List of custom headers.
    expectedStatusCodeRanges List<MonitorConfigResponseExpectedStatusCodeRanges>
    List of expected status code ranges.
    intervalInSeconds Double
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    path String
    The path relative to the endpoint domain name used to probe for endpoint health.
    port Double
    The TCP port used to probe for endpoint health.
    profileMonitorStatus String
    The profile-level monitoring status of the Traffic Manager profile.
    protocol String
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    timeoutInSeconds Double
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    toleratedNumberOfFailures Double
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
    customHeaders MonitorConfigResponseCustomHeaders[]
    List of custom headers.
    expectedStatusCodeRanges MonitorConfigResponseExpectedStatusCodeRanges[]
    List of expected status code ranges.
    intervalInSeconds number
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    path string
    The path relative to the endpoint domain name used to probe for endpoint health.
    port number
    The TCP port used to probe for endpoint health.
    profileMonitorStatus string
    The profile-level monitoring status of the Traffic Manager profile.
    protocol string
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    timeoutInSeconds number
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    toleratedNumberOfFailures number
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
    custom_headers Sequence[MonitorConfigResponseCustomHeaders]
    List of custom headers.
    expected_status_code_ranges Sequence[MonitorConfigResponseExpectedStatusCodeRanges]
    List of expected status code ranges.
    interval_in_seconds float
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    path str
    The path relative to the endpoint domain name used to probe for endpoint health.
    port float
    The TCP port used to probe for endpoint health.
    profile_monitor_status str
    The profile-level monitoring status of the Traffic Manager profile.
    protocol str
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    timeout_in_seconds float
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    tolerated_number_of_failures float
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.
    customHeaders List<Property Map>
    List of custom headers.
    expectedStatusCodeRanges List<Property Map>
    List of expected status code ranges.
    intervalInSeconds Number
    The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile.
    path String
    The path relative to the endpoint domain name used to probe for endpoint health.
    port Number
    The TCP port used to probe for endpoint health.
    profileMonitorStatus String
    The profile-level monitoring status of the Traffic Manager profile.
    protocol String
    The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
    timeoutInSeconds Number
    The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check.
    toleratedNumberOfFailures Number
    The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check.

    MonitorConfigResponseCustomHeaders

    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.

    MonitorConfigResponseExpectedStatusCodeRanges

    Max int
    Max status code.
    Min int
    Min status code.
    Max int
    Max status code.
    Min int
    Min status code.
    max Integer
    Max status code.
    min Integer
    Min status code.
    max number
    Max status code.
    min number
    Min status code.
    max int
    Max status code.
    min int
    Min status code.
    max Number
    Max status code.
    min Number
    Min status code.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native