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

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.cdn.FrontdoorEndpoint

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages a Front Door (standard/premium) Endpoint.

    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 exampleFrontdoorEndpoint = new azure.cdn.FrontdoorEndpoint("example", {
        name: "example-endpoint",
        cdnFrontdoorProfileId: exampleFrontdoorProfile.id,
        tags: {
            ENV: "example",
        },
    });
    
    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_endpoint = azure.cdn.FrontdoorEndpoint("example",
        name="example-endpoint",
        cdn_frontdoor_profile_id=example_frontdoor_profile.id,
        tags={
            "ENV": "example",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/cdn"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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.NewFrontdoorEndpoint(ctx, "example", &cdn.FrontdoorEndpointArgs{
    			Name:                  pulumi.String("example-endpoint"),
    			CdnFrontdoorProfileId: exampleFrontdoorProfile.ID(),
    			Tags: pulumi.StringMap{
    				"ENV": pulumi.String("example"),
    			},
    		})
    		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 exampleFrontdoorEndpoint = new Azure.Cdn.FrontdoorEndpoint("example", new()
        {
            Name = "example-endpoint",
            CdnFrontdoorProfileId = exampleFrontdoorProfile.Id,
            Tags = 
            {
                { "ENV", "example" },
            },
        });
    
    });
    
    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.FrontdoorEndpoint;
    import com.pulumi.azure.cdn.FrontdoorEndpointArgs;
    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 exampleFrontdoorEndpoint = new FrontdoorEndpoint("exampleFrontdoorEndpoint", FrontdoorEndpointArgs.builder()        
                .name("example-endpoint")
                .cdnFrontdoorProfileId(exampleFrontdoorProfile.id())
                .tags(Map.of("ENV", "example"))
                .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
      exampleFrontdoorEndpoint:
        type: azure:cdn:FrontdoorEndpoint
        name: example
        properties:
          name: example-endpoint
          cdnFrontdoorProfileId: ${exampleFrontdoorProfile.id}
          tags:
            ENV: example
    

    Create FrontdoorEndpoint Resource

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

    Constructor syntax

    new FrontdoorEndpoint(name: string, args: FrontdoorEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def FrontdoorEndpoint(resource_name: str,
                          args: FrontdoorEndpointArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def FrontdoorEndpoint(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          cdn_frontdoor_profile_id: Optional[str] = None,
                          enabled: Optional[bool] = None,
                          name: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None)
    func NewFrontdoorEndpoint(ctx *Context, name string, args FrontdoorEndpointArgs, opts ...ResourceOption) (*FrontdoorEndpoint, error)
    public FrontdoorEndpoint(string name, FrontdoorEndpointArgs args, CustomResourceOptions? opts = null)
    public FrontdoorEndpoint(String name, FrontdoorEndpointArgs args)
    public FrontdoorEndpoint(String name, FrontdoorEndpointArgs args, CustomResourceOptions options)
    
    type: azure:cdn:FrontdoorEndpoint
    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 FrontdoorEndpointArgs
    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 FrontdoorEndpointArgs
    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 FrontdoorEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FrontdoorEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FrontdoorEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var frontdoorEndpointResource = new Azure.Cdn.FrontdoorEndpoint("frontdoorEndpointResource", new()
    {
        CdnFrontdoorProfileId = "string",
        Enabled = false,
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := cdn.NewFrontdoorEndpoint(ctx, "frontdoorEndpointResource", &cdn.FrontdoorEndpointArgs{
    	CdnFrontdoorProfileId: pulumi.String("string"),
    	Enabled:               pulumi.Bool(false),
    	Name:                  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var frontdoorEndpointResource = new FrontdoorEndpoint("frontdoorEndpointResource", FrontdoorEndpointArgs.builder()        
        .cdnFrontdoorProfileId("string")
        .enabled(false)
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    frontdoor_endpoint_resource = azure.cdn.FrontdoorEndpoint("frontdoorEndpointResource",
        cdn_frontdoor_profile_id="string",
        enabled=False,
        name="string",
        tags={
            "string": "string",
        })
    
    const frontdoorEndpointResource = new azure.cdn.FrontdoorEndpoint("frontdoorEndpointResource", {
        cdnFrontdoorProfileId: "string",
        enabled: false,
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:cdn:FrontdoorEndpoint
    properties:
        cdnFrontdoorProfileId: string
        enabled: false
        name: string
        tags:
            string: string
    

    FrontdoorEndpoint Resource Properties

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

    Inputs

    The FrontdoorEndpoint resource accepts the following input properties:

    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    Enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    Name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    Tags Dictionary<string, string>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    Enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    Name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    Tags map[string]string
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled Boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    name String
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Map<String,String>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags {[key: string]: string}
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    name str
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Mapping[str, str]
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled Boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    name String
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Map<String>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.

    Outputs

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

    HostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    Id string
    The provider-assigned unique ID for this managed resource.
    HostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    Id string
    The provider-assigned unique ID for this managed resource.
    hostName String
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    id String
    The provider-assigned unique ID for this managed resource.
    hostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    id string
    The provider-assigned unique ID for this managed resource.
    host_name str
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    id str
    The provider-assigned unique ID for this managed resource.
    hostName String
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing FrontdoorEndpoint Resource

    Get an existing FrontdoorEndpoint 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?: FrontdoorEndpointState, opts?: CustomResourceOptions): FrontdoorEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cdn_frontdoor_profile_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            host_name: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> FrontdoorEndpoint
    func GetFrontdoorEndpoint(ctx *Context, name string, id IDInput, state *FrontdoorEndpointState, opts ...ResourceOption) (*FrontdoorEndpoint, error)
    public static FrontdoorEndpoint Get(string name, Input<string> id, FrontdoorEndpointState? state, CustomResourceOptions? opts = null)
    public static FrontdoorEndpoint get(String name, Output<String> id, FrontdoorEndpointState 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 Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    Enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    HostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    Name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    Tags Dictionary<string, string>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    CdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    Enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    HostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    Name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    Tags map[string]string
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled Boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    hostName String
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    name String
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Map<String,String>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId string
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    hostName string
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    name string
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags {[key: string]: string}
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdn_frontdoor_profile_id str
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled bool
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    host_name str
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    name str
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Mapping[str, str]
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.
    cdnFrontdoorProfileId String
    The ID of the Front Door Profile within which this Front Door Endpoint should exist. Changing this forces a new Front Door Endpoint to be created.
    enabled Boolean
    Specifies if this Front Door Endpoint is enabled? Defaults to true.
    hostName String
    The host name of the Front Door Endpoint, in the format {endpointName}.{dnsZone} (for example, contoso.azureedge.net).
    name String
    The name which should be used for this Front Door Endpoint. Changing this forces a new Front Door Endpoint to be created.
    tags Map<String>
    Specifies a mapping of tags which should be assigned to the Front Door Endpoint.

    Import

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

    $ pulumi import azure:cdn/frontdoorEndpoint:FrontdoorEndpoint example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/afdEndpoints/endpoint1
    

    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 Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi