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

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

azure.cdn.FrontdoorOriginGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

    Manages a Front Door (standard/premium) Origin Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-cdn-frontdoor",
        location: "West Europe",
    });
    const exampleFrontdoorProfile = new azure.cdn.FrontdoorProfile("example", {
        name: "example-profile",
        resourceGroupName: example.name,
        skuName: "Standard_AzureFrontDoor",
    });
    const exampleFrontdoorOriginGroup = new azure.cdn.FrontdoorOriginGroup("example", {
        name: "example-origin-group",
        cdnFrontdoorProfileId: exampleFrontdoorProfile.id,
        sessionAffinityEnabled: true,
        restoreTrafficTimeToHealedOrNewEndpointInMinutes: 10,
        healthProbe: {
            intervalInSeconds: 240,
            path: "/healthProbe",
            protocol: "Https",
            requestType: "HEAD",
        },
        loadBalancing: {
            additionalLatencyInMilliseconds: 0,
            sampleSize: 16,
            successfulSamplesRequired: 3,
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-cdn-frontdoor",
        location="West Europe")
    example_frontdoor_profile = azure.cdn.FrontdoorProfile("example",
        name="example-profile",
        resource_group_name=example.name,
        sku_name="Standard_AzureFrontDoor")
    example_frontdoor_origin_group = azure.cdn.FrontdoorOriginGroup("example",
        name="example-origin-group",
        cdn_frontdoor_profile_id=example_frontdoor_profile.id,
        session_affinity_enabled=True,
        restore_traffic_time_to_healed_or_new_endpoint_in_minutes=10,
        health_probe={
            "interval_in_seconds": 240,
            "path": "/healthProbe",
            "protocol": "Https",
            "request_type": "HEAD",
        },
        load_balancing={
            "additional_latency_in_milliseconds": 0,
            "sample_size": 16,
            "successful_samples_required": 3,
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cdn"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-cdn-frontdoor"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleFrontdoorProfile, err := cdn.NewFrontdoorProfile(ctx, "example", &cdn.FrontdoorProfileArgs{
    			Name:              pulumi.String("example-profile"),
    			ResourceGroupName: example.Name,
    			SkuName:           pulumi.String("Standard_AzureFrontDoor"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cdn.NewFrontdoorOriginGroup(ctx, "example", &cdn.FrontdoorOriginGroupArgs{
    			Name:                   pulumi.String("example-origin-group"),
    			CdnFrontdoorProfileId:  exampleFrontdoorProfile.ID(),
    			SessionAffinityEnabled: pulumi.Bool(true),
    			RestoreTrafficTimeToHealedOrNewEndpointInMinutes: pulumi.Int(10),
    			HealthProbe: &cdn.FrontdoorOriginGroupHealthProbeArgs{
    				IntervalInSeconds: pulumi.Int(240),
    				Path:              pulumi.String("/healthProbe"),
    				Protocol:          pulumi.String("Https"),
    				RequestType:       pulumi.String("HEAD"),
    			},
    			LoadBalancing: &cdn.FrontdoorOriginGroupLoadBalancingArgs{
    				AdditionalLatencyInMilliseconds: pulumi.Int(0),
    				SampleSize:                      pulumi.Int(16),
    				SuccessfulSamplesRequired:       pulumi.Int(3),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-cdn-frontdoor",
            Location = "West Europe",
        });
    
        var exampleFrontdoorProfile = new Azure.Cdn.FrontdoorProfile("example", new()
        {
            Name = "example-profile",
            ResourceGroupName = example.Name,
            SkuName = "Standard_AzureFrontDoor",
        });
    
        var exampleFrontdoorOriginGroup = new Azure.Cdn.FrontdoorOriginGroup("example", new()
        {
            Name = "example-origin-group",
            CdnFrontdoorProfileId = exampleFrontdoorProfile.Id,
            SessionAffinityEnabled = true,
            RestoreTrafficTimeToHealedOrNewEndpointInMinutes = 10,
            HealthProbe = new Azure.Cdn.Inputs.FrontdoorOriginGroupHealthProbeArgs
            {
                IntervalInSeconds = 240,
                Path = "/healthProbe",
                Protocol = "Https",
                RequestType = "HEAD",
            },
            LoadBalancing = new Azure.Cdn.Inputs.FrontdoorOriginGroupLoadBalancingArgs
            {
                AdditionalLatencyInMilliseconds = 0,
                SampleSize = 16,
                SuccessfulSamplesRequired = 3,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.cdn.FrontdoorProfile;
    import com.pulumi.azure.cdn.FrontdoorProfileArgs;
    import com.pulumi.azure.cdn.FrontdoorOriginGroup;
    import com.pulumi.azure.cdn.FrontdoorOriginGroupArgs;
    import com.pulumi.azure.cdn.inputs.FrontdoorOriginGroupHealthProbeArgs;
    import com.pulumi.azure.cdn.inputs.FrontdoorOriginGroupLoadBalancingArgs;
    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) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-cdn-frontdoor")
                .location("West Europe")
                .build());
    
            var exampleFrontdoorProfile = new FrontdoorProfile("exampleFrontdoorProfile", FrontdoorProfileArgs.builder()
                .name("example-profile")
                .resourceGroupName(example.name())
                .skuName("Standard_AzureFrontDoor")
                .build());
    
            var exampleFrontdoorOriginGroup = new FrontdoorOriginGroup("exampleFrontdoorOriginGroup", FrontdoorOriginGroupArgs.builder()
                .name("example-origin-group")
                .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
                .sessionAffinityEnabled(true)
                .restoreTrafficTimeToHealedOrNewEndpointInMinutes(10)
                .healthProbe(FrontdoorOriginGroupHealthProbeArgs.builder()
                    .intervalInSeconds(240)
                    .path("/healthProbe")
                    .protocol("Https")
                    .requestType("HEAD")
                    .build())
                .loadBalancing(FrontdoorOriginGroupLoadBalancingArgs.builder()
                    .additionalLatencyInMilliseconds(0)
                    .sampleSize(16)
                    .successfulSamplesRequired(3)
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-cdn-frontdoor
          location: West Europe
      exampleFrontdoorProfile:
        type: azure:cdn:FrontdoorProfile
        name: example
        properties:
          name: example-profile
          resourceGroupName: ${example.name}
          skuName: Standard_AzureFrontDoor
      exampleFrontdoorOriginGroup:
        type: azure:cdn:FrontdoorOriginGroup
        name: example
        properties:
          name: example-origin-group
          cdnFrontdoorProfileId: ${exampleFrontdoorProfile.id}
          sessionAffinityEnabled: true
          restoreTrafficTimeToHealedOrNewEndpointInMinutes: 10
          healthProbe:
            intervalInSeconds: 240
            path: /healthProbe
            protocol: Https
            requestType: HEAD
          loadBalancing:
            additionalLatencyInMilliseconds: 0
            sampleSize: 16
            successfulSamplesRequired: 3
    

    Create FrontdoorOriginGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FrontdoorOriginGroup(name: string, args: FrontdoorOriginGroupArgs, opts?: CustomResourceOptions);
    @overload
    def FrontdoorOriginGroup(resource_name: str,
                             args: FrontdoorOriginGroupArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def FrontdoorOriginGroup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             cdn_frontdoor_profile_id: Optional[str] = None,
                             load_balancing: Optional[FrontdoorOriginGroupLoadBalancingArgs] = None,
                             health_probe: Optional[FrontdoorOriginGroupHealthProbeArgs] = None,
                             name: Optional[str] = None,
                             restore_traffic_time_to_healed_or_new_endpoint_in_minutes: Optional[int] = None,
                             session_affinity_enabled: Optional[bool] = None)
    func NewFrontdoorOriginGroup(ctx *Context, name string, args FrontdoorOriginGroupArgs, opts ...ResourceOption) (*FrontdoorOriginGroup, error)
    public FrontdoorOriginGroup(string name, FrontdoorOriginGroupArgs args, CustomResourceOptions? opts = null)
    public FrontdoorOriginGroup(String name, FrontdoorOriginGroupArgs args)
    public FrontdoorOriginGroup(String name, FrontdoorOriginGroupArgs args, CustomResourceOptions options)
    
    type: azure:cdn:FrontdoorOriginGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args FrontdoorOriginGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FrontdoorOriginGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FrontdoorOriginGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FrontdoorOriginGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FrontdoorOriginGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var frontdoorOriginGroupResource = new Azure.Cdn.FrontdoorOriginGroup("frontdoorOriginGroupResource", new()
    {
        CdnFrontdoorProfileId = "string",
        LoadBalancing = new Azure.Cdn.Inputs.FrontdoorOriginGroupLoadBalancingArgs
        {
            AdditionalLatencyInMilliseconds = 0,
            SampleSize = 0,
            SuccessfulSamplesRequired = 0,
        },
        HealthProbe = new Azure.Cdn.Inputs.FrontdoorOriginGroupHealthProbeArgs
        {
            IntervalInSeconds = 0,
            Protocol = "string",
            Path = "string",
            RequestType = "string",
        },
        Name = "string",
        RestoreTrafficTimeToHealedOrNewEndpointInMinutes = 0,
        SessionAffinityEnabled = false,
    });
    
    example, err := cdn.NewFrontdoorOriginGroup(ctx, "frontdoorOriginGroupResource", &cdn.FrontdoorOriginGroupArgs{
    	CdnFrontdoorProfileId: pulumi.String("string"),
    	LoadBalancing: &cdn.FrontdoorOriginGroupLoadBalancingArgs{
    		AdditionalLatencyInMilliseconds: pulumi.Int(0),
    		SampleSize:                      pulumi.Int(0),
    		SuccessfulSamplesRequired:       pulumi.Int(0),
    	},
    	HealthProbe: &cdn.FrontdoorOriginGroupHealthProbeArgs{
    		IntervalInSeconds: pulumi.Int(0),
    		Protocol:          pulumi.String("string"),
    		Path:              pulumi.String("string"),
    		RequestType:       pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	RestoreTrafficTimeToHealedOrNewEndpointInMinutes: pulumi.Int(0),
    	SessionAffinityEnabled:                           pulumi.Bool(false),
    })
    
    var frontdoorOriginGroupResource = new FrontdoorOriginGroup("frontdoorOriginGroupResource", FrontdoorOriginGroupArgs.builder()
        .cdnFrontdoorProfileId("string")
        .loadBalancing(FrontdoorOriginGroupLoadBalancingArgs.builder()
            .additionalLatencyInMilliseconds(0)
            .sampleSize(0)
            .successfulSamplesRequired(0)
            .build())
        .healthProbe(FrontdoorOriginGroupHealthProbeArgs.builder()
            .intervalInSeconds(0)
            .protocol("string")
            .path("string")
            .requestType("string")
            .build())
        .name("string")
        .restoreTrafficTimeToHealedOrNewEndpointInMinutes(0)
        .sessionAffinityEnabled(false)
        .build());
    
    frontdoor_origin_group_resource = azure.cdn.FrontdoorOriginGroup("frontdoorOriginGroupResource",
        cdn_frontdoor_profile_id="string",
        load_balancing={
            "additional_latency_in_milliseconds": 0,
            "sample_size": 0,
            "successful_samples_required": 0,
        },
        health_probe={
            "interval_in_seconds": 0,
            "protocol": "string",
            "path": "string",
            "request_type": "string",
        },
        name="string",
        restore_traffic_time_to_healed_or_new_endpoint_in_minutes=0,
        session_affinity_enabled=False)
    
    const frontdoorOriginGroupResource = new azure.cdn.FrontdoorOriginGroup("frontdoorOriginGroupResource", {
        cdnFrontdoorProfileId: "string",
        loadBalancing: {
            additionalLatencyInMilliseconds: 0,
            sampleSize: 0,
            successfulSamplesRequired: 0,
        },
        healthProbe: {
            intervalInSeconds: 0,
            protocol: "string",
            path: "string",
            requestType: "string",
        },
        name: "string",
        restoreTrafficTimeToHealedOrNewEndpointInMinutes: 0,
        sessionAffinityEnabled: false,
    });
    
    type: azure:cdn:FrontdoorOriginGroup
    properties:
        cdnFrontdoorProfileId: string
        healthProbe:
            intervalInSeconds: 0
            path: string
            protocol: string
            requestType: string
        loadBalancing:
            additionalLatencyInMilliseconds: 0
            sampleSize: 0
            successfulSamplesRequired: 0
        name: string
        restoreTrafficTimeToHealedOrNewEndpointInMinutes: 0
        sessionAffinityEnabled: false
    

    FrontdoorOriginGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FrontdoorOriginGroup resource accepts the following input properties:

    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    LoadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    HealthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    Name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    SessionAffinityEnabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    LoadBalancing FrontdoorOriginGroupLoadBalancingArgs
    A load_balancing block as defined below.
    HealthProbe FrontdoorOriginGroupHealthProbeArgs
    A health_probe block as defined below.
    Name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    SessionAffinityEnabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    loadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    healthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    name String
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Integer

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled Boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    loadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    healthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes number

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    load_balancing FrontdoorOriginGroupLoadBalancingArgs
    A load_balancing block as defined below.
    health_probe FrontdoorOriginGroupHealthProbeArgs
    A health_probe block as defined below.
    name str
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restore_traffic_time_to_healed_or_new_endpoint_in_minutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    session_affinity_enabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    loadBalancing Property Map
    A load_balancing block as defined below.
    healthProbe Property Map
    A health_probe block as defined below.
    name String
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Number

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled Boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FrontdoorOriginGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FrontdoorOriginGroup Resource

    Get an existing FrontdoorOriginGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FrontdoorOriginGroupState, opts?: CustomResourceOptions): FrontdoorOriginGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cdn_frontdoor_profile_id: Optional[str] = None,
            health_probe: Optional[FrontdoorOriginGroupHealthProbeArgs] = None,
            load_balancing: Optional[FrontdoorOriginGroupLoadBalancingArgs] = None,
            name: Optional[str] = None,
            restore_traffic_time_to_healed_or_new_endpoint_in_minutes: Optional[int] = None,
            session_affinity_enabled: Optional[bool] = None) -> FrontdoorOriginGroup
    func GetFrontdoorOriginGroup(ctx *Context, name string, id IDInput, state *FrontdoorOriginGroupState, opts ...ResourceOption) (*FrontdoorOriginGroup, error)
    public static FrontdoorOriginGroup Get(string name, Input<string> id, FrontdoorOriginGroupState? state, CustomResourceOptions? opts = null)
    public static FrontdoorOriginGroup get(String name, Output<String> id, FrontdoorOriginGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    HealthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    LoadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    Name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    SessionAffinityEnabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    HealthProbe FrontdoorOriginGroupHealthProbeArgs
    A health_probe block as defined below.
    LoadBalancing FrontdoorOriginGroupLoadBalancingArgs
    A load_balancing block as defined below.
    Name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    RestoreTrafficTimeToHealedOrNewEndpointInMinutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    SessionAffinityEnabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    healthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    loadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    name String
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Integer

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled Boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    healthProbe FrontdoorOriginGroupHealthProbe
    A health_probe block as defined below.
    loadBalancing FrontdoorOriginGroupLoadBalancing
    A load_balancing block as defined below.
    name string
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes number

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    health_probe FrontdoorOriginGroupHealthProbeArgs
    A health_probe block as defined below.
    load_balancing FrontdoorOriginGroupLoadBalancingArgs
    A load_balancing block as defined below.
    name str
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restore_traffic_time_to_healed_or_new_endpoint_in_minutes int

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    session_affinity_enabled bool
    Specifies whether session affinity should be enabled on this host. Defaults to true.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Origin Group should exist. Changing this forces a new Front Door Origin Group to be created.
    healthProbe Property Map
    A health_probe block as defined below.
    loadBalancing Property Map
    A load_balancing block as defined below.
    name String
    The name which should be used for this Front Door Origin Group. Changing this forces a new Front Door Origin Group to be created.
    restoreTrafficTimeToHealedOrNewEndpointInMinutes Number

    Specifies the amount of time which should elapse before shifting traffic to another endpoint when a healthy endpoint becomes unhealthy or a new endpoint is added. Possible values are between 0 and 50 minutes (inclusive). Default is 10 minutes.

    NOTE: This property is currently not used, but will be in the near future.

    sessionAffinityEnabled Boolean
    Specifies whether session affinity should be enabled on this host. Defaults to true.

    Supporting Types

    FrontdoorOriginGroupHealthProbe, FrontdoorOriginGroupHealthProbeArgs

    IntervalInSeconds int
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    Protocol string
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    Path string

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    RequestType string
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.
    IntervalInSeconds int
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    Protocol string
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    Path string

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    RequestType string
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.
    intervalInSeconds Integer
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    protocol String
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    path String

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    requestType String
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.
    intervalInSeconds number
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    protocol string
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    path string

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    requestType string
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.
    interval_in_seconds int
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    protocol str
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    path str

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    request_type str
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.
    intervalInSeconds Number
    Specifies the number of seconds between health probes. Possible values are between 1 and 255 seconds (inclusive).
    protocol String
    Specifies the protocol to use for health probe. Possible values are Http and Https.
    path String

    Specifies the path relative to the origin that is used to determine the health of the origin. Defaults to /.

    NOTE: Health probes can only be disabled if there is a single enabled origin in a single enabled origin group. For more information about the health_probe settings please see the product documentation.

    requestType String
    Specifies the type of health probe request that is made. Possible values are GET and HEAD. Defaults to HEAD.

    FrontdoorOriginGroupLoadBalancing, FrontdoorOriginGroupLoadBalancingArgs

    AdditionalLatencyInMilliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    SampleSize int
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    SuccessfulSamplesRequired int
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.
    AdditionalLatencyInMilliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    SampleSize int
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    SuccessfulSamplesRequired int
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.
    additionalLatencyInMilliseconds Integer
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    sampleSize Integer
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    successfulSamplesRequired Integer
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.
    additionalLatencyInMilliseconds number
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    sampleSize number
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    successfulSamplesRequired number
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.
    additional_latency_in_milliseconds int
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    sample_size int
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    successful_samples_required int
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.
    additionalLatencyInMilliseconds Number
    Specifies the additional latency in milliseconds for probes to fall into the lowest latency bucket. Possible values are between 0 and 1000 milliseconds (inclusive). Defaults to 50.
    sampleSize Number
    Specifies the number of samples to consider for load balancing decisions. Possible values are between 0 and 255 (inclusive). Defaults to 4.
    successfulSamplesRequired Number
    Specifies the number of samples within the sample period that must succeed. Possible values are between 0 and 255 (inclusive). Defaults to 3.

    Import

    Front Door Origin Groups can be imported using the resource id, e.g.

    $ pulumi import azure:cdn/frontdoorOriginGroup:FrontdoorOriginGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v6.13.0 published on Monday, Dec 9, 2024 by Pulumi