1. Packages
  2. Azure Classic
  3. API Docs
  4. cdn
  5. getFrontdoorOriginGroup

We recommend using Azure Native.

Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi

azure.cdn.getFrontdoorOriginGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi

    Use this data source to access information about an existing Front Door (standard/premium) Origin Group.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.Cdn.GetFrontdoorOriginGroup.Invoke(new()
        {
            Name = "example-origin-group",
            ProfileName = "example-profile",
            ResourceGroupName = "example-resources",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cdn"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cdn.LookupFrontdoorOriginGroup(ctx, &cdn.LookupFrontdoorOriginGroupArgs{
    			Name:              "example-origin-group",
    			ProfileName:       "example-profile",
    			ResourceGroupName: "example-resources",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.cdn.CdnFunctions;
    import com.pulumi.azure.cdn.inputs.GetFrontdoorOriginGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = CdnFunctions.getFrontdoorOriginGroup(GetFrontdoorOriginGroupArgs.builder()
                .name("example-origin-group")
                .profileName("example-profile")
                .resourceGroupName("example-resources")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.cdn.get_frontdoor_origin_group(name="example-origin-group",
        profile_name="example-profile",
        resource_group_name="example-resources")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.cdn.getFrontdoorOriginGroup({
        name: "example-origin-group",
        profileName: "example-profile",
        resourceGroupName: "example-resources",
    });
    
    variables:
      example:
        fn::invoke:
          Function: azure:cdn:getFrontdoorOriginGroup
          Arguments:
            name: example-origin-group
            profileName: example-profile
            resourceGroupName: example-resources
    

    Using getFrontdoorOriginGroup

    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 getFrontdoorOriginGroup(args: GetFrontdoorOriginGroupArgs, opts?: InvokeOptions): Promise<GetFrontdoorOriginGroupResult>
    function getFrontdoorOriginGroupOutput(args: GetFrontdoorOriginGroupOutputArgs, opts?: InvokeOptions): Output<GetFrontdoorOriginGroupResult>
    def get_frontdoor_origin_group(name: Optional[str] = None,
                                   profile_name: Optional[str] = None,
                                   resource_group_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetFrontdoorOriginGroupResult
    def get_frontdoor_origin_group_output(name: 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[GetFrontdoorOriginGroupResult]
    func LookupFrontdoorOriginGroup(ctx *Context, args *LookupFrontdoorOriginGroupArgs, opts ...InvokeOption) (*LookupFrontdoorOriginGroupResult, error)
    func LookupFrontdoorOriginGroupOutput(ctx *Context, args *LookupFrontdoorOriginGroupOutputArgs, opts ...InvokeOption) LookupFrontdoorOriginGroupResultOutput

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

    public static class GetFrontdoorOriginGroup 
    {
        public static Task<GetFrontdoorOriginGroupResult> InvokeAsync(GetFrontdoorOriginGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetFrontdoorOriginGroupResult> Invoke(GetFrontdoorOriginGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFrontdoorOriginGroupResult> getFrontdoorOriginGroup(GetFrontdoorOriginGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure:cdn/getFrontdoorOriginGroup:getFrontdoorOriginGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the Front Door Origin Group.
    ProfileName string
    The name of the Front Door Profile within which Front Door Origin Group exists.
    ResourceGroupName string
    The name of the Resource Group where the Front Door Profile exists.
    Name string
    Specifies the name of the Front Door Origin Group.
    ProfileName string
    The name of the Front Door Profile within which Front Door Origin Group exists.
    ResourceGroupName string
    The name of the Resource Group where the Front Door Profile exists.
    name String
    Specifies the name of the Front Door Origin Group.
    profileName String
    The name of the Front Door Profile within which Front Door Origin Group exists.
    resourceGroupName String
    The name of the Resource Group where the Front Door Profile exists.
    name string
    Specifies the name of the Front Door Origin Group.
    profileName string
    The name of the Front Door Profile within which Front Door Origin Group exists.
    resourceGroupName string
    The name of the Resource Group where the Front Door Profile exists.
    name str
    Specifies the name of the Front Door Origin Group.
    profile_name str
    The name of the Front Door Profile within which Front Door Origin Group exists.
    resource_group_name str
    The name of the Resource Group where the Front Door Profile exists.
    name String
    Specifies the name of the Front Door Origin Group.
    profileName String
    The name of the Front Door Profile within which Front Door Origin Group exists.
    resourceGroupName String
    The name of the Resource Group where the Front Door Profile exists.

    getFrontdoorOriginGroup Result

    The following output properties are available:

    CdnFrontdoorProfileId string
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    HealthProbes List<GetFrontdoorOriginGroupHealthProbe>
    A health_probe block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancings List<GetFrontdoorOriginGroupLoadBalancing>
    A load_balancing block as defined below.
    Name string
    ProfileName string
    ResourceGroupName string
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int
    SessionAffinityEnabled bool
    Specifies whether session affinity is enabled on this host.
    CdnFrontdoorProfileId string
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    HealthProbes []GetFrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancings []GetFrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    Name string
    ProfileName string
    ResourceGroupName string
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int
    SessionAffinityEnabled bool
    Specifies whether session affinity is enabled on this host.
    cdnFrontdoorProfileId String
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    healthProbes List<GetFrontdoorOriginGroupHealthProbe>
    A health_probe block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancings List<GetFrontdoorOriginGroupLoadBalancing>
    A load_balancing block as defined below.
    name String
    profileName String
    resourceGroupName String
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Integer
    sessionAffinityEnabled Boolean
    Specifies whether session affinity is enabled on this host.
    cdnFrontdoorProfileId string
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    healthProbes GetFrontdoorOriginGroupHealthProbe[]
    A health_probe block as defined below.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancings GetFrontdoorOriginGroupLoadBalancing[]
    A load_balancing block as defined below.
    name string
    profileName string
    resourceGroupName string
    restoreTrafficTimeToHealedOrNewEndpointInMinutes number
    sessionAffinityEnabled boolean
    Specifies whether session affinity is enabled on this host.
    cdn_frontdoor_profile_id str
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    health_probes Sequence[GetFrontdoorOriginGroupHealthProbe]
    A health_probe block as defined below.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancings Sequence[GetFrontdoorOriginGroupLoadBalancing]
    A load_balancing block as defined below.
    name str
    profile_name str
    resource_group_name str
    restore_traffic_time_to_healed_or_new_endpoint_in_minutes int
    session_affinity_enabled bool
    Specifies whether session affinity is enabled on this host.
    cdnFrontdoorProfileId String
    Specifies the ID of the Front Door Profile within which this Front Door Origin Group exists.
    healthProbes List<Property Map>
    A health_probe block as defined below.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancings List<Property Map>
    A load_balancing block as defined below.
    name String
    profileName String
    resourceGroupName String
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Number
    sessionAffinityEnabled Boolean
    Specifies whether session affinity is enabled on this host.

    Supporting Types

    GetFrontdoorOriginGroupHealthProbe

    IntervalInSeconds int
    Specifies the number of seconds between health probes.
    Path string
    Specifies the path relative to the origin that is used to determine the health of the origin.
    Protocol string
    Specifies the protocol to use for health probe.
    RequestType string
    Specifies the type of health probe request that is made.
    IntervalInSeconds int
    Specifies the number of seconds between health probes.
    Path string
    Specifies the path relative to the origin that is used to determine the health of the origin.
    Protocol string
    Specifies the protocol to use for health probe.
    RequestType string
    Specifies the type of health probe request that is made.
    intervalInSeconds Integer
    Specifies the number of seconds between health probes.
    path String
    Specifies the path relative to the origin that is used to determine the health of the origin.
    protocol String
    Specifies the protocol to use for health probe.
    requestType String
    Specifies the type of health probe request that is made.
    intervalInSeconds number
    Specifies the number of seconds between health probes.
    path string
    Specifies the path relative to the origin that is used to determine the health of the origin.
    protocol string
    Specifies the protocol to use for health probe.
    requestType string
    Specifies the type of health probe request that is made.
    interval_in_seconds int
    Specifies the number of seconds between health probes.
    path str
    Specifies the path relative to the origin that is used to determine the health of the origin.
    protocol str
    Specifies the protocol to use for health probe.
    request_type str
    Specifies the type of health probe request that is made.
    intervalInSeconds Number
    Specifies the number of seconds between health probes.
    path String
    Specifies the path relative to the origin that is used to determine the health of the origin.
    protocol String
    Specifies the protocol to use for health probe.
    requestType String
    Specifies the type of health probe request that is made.

    GetFrontdoorOriginGroupLoadBalancing

    AdditionalLatencyInMilliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    SampleSize int
    Specifies the number of samples to consider for load balancing decisions.
    SuccessfulSamplesRequired int
    Specifies the number of samples within the sample period that must succeed.
    AdditionalLatencyInMilliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    SampleSize int
    Specifies the number of samples to consider for load balancing decisions.
    SuccessfulSamplesRequired int
    Specifies the number of samples within the sample period that must succeed.
    additionalLatencyInMilliseconds Integer
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    sampleSize Integer
    Specifies the number of samples to consider for load balancing decisions.
    successfulSamplesRequired Integer
    Specifies the number of samples within the sample period that must succeed.
    additionalLatencyInMilliseconds number
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    sampleSize number
    Specifies the number of samples to consider for load balancing decisions.
    successfulSamplesRequired number
    Specifies the number of samples within the sample period that must succeed.
    additional_latency_in_milliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    sample_size int
    Specifies the number of samples to consider for load balancing decisions.
    successful_samples_required int
    Specifies the number of samples within the sample period that must succeed.
    additionalLatencyInMilliseconds Number
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket.
    sampleSize Number
    Specifies the number of samples to consider for load balancing decisions.
    successfulSamplesRequired Number
    Specifies the number of samples within the sample period that must succeed.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.67.1 published on Tuesday, Feb 27, 2024 by Pulumi