1. Packages
  2. Azure Native
  3. API Docs
  4. cdn
  5. AFDEndpoint
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.37.0 published on Monday, Apr 15, 2024 by Pulumi

azure-native.cdn.AFDEndpoint

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

    Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format .azureedge.net. Azure REST API version: 2023-05-01. Prior API version in Azure Native 1.x: 2020-09-01.

    Other available API versions: 2020-09-01, 2023-07-01-preview, 2024-02-01.

    Example Usage

    AFDEndpoints_Create

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var afdEndpoint = new AzureNative.Cdn.AFDEndpoint("afdEndpoint", new()
        {
            AutoGeneratedDomainNameLabelScope = AzureNative.Cdn.AutoGeneratedDomainNameLabelScope.TenantReuse,
            EnabledState = AzureNative.Cdn.EnabledState.Enabled,
            EndpointName = "endpoint1",
            Location = "global",
            ProfileName = "profile1",
            ResourceGroupName = "RG",
            Tags = null,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure-native-sdk/cdn/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cdn.NewAFDEndpoint(ctx, "afdEndpoint", &cdn.AFDEndpointArgs{
    			AutoGeneratedDomainNameLabelScope: pulumi.String(cdn.AutoGeneratedDomainNameLabelScopeTenantReuse),
    			EnabledState:                      pulumi.String(cdn.EnabledStateEnabled),
    			EndpointName:                      pulumi.String("endpoint1"),
    			Location:                          pulumi.String("global"),
    			ProfileName:                       pulumi.String("profile1"),
    			ResourceGroupName:                 pulumi.String("RG"),
    			Tags:                              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.azurenative.cdn.AFDEndpoint;
    import com.pulumi.azurenative.cdn.AFDEndpointArgs;
    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 afdEndpoint = new AFDEndpoint("afdEndpoint", AFDEndpointArgs.builder()        
                .autoGeneratedDomainNameLabelScope("TenantReuse")
                .enabledState("Enabled")
                .endpointName("endpoint1")
                .location("global")
                .profileName("profile1")
                .resourceGroupName("RG")
                .tags()
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    afd_endpoint = azure_native.cdn.AFDEndpoint("afdEndpoint",
        auto_generated_domain_name_label_scope=azure_native.cdn.AutoGeneratedDomainNameLabelScope.TENANT_REUSE,
        enabled_state=azure_native.cdn.EnabledState.ENABLED,
        endpoint_name="endpoint1",
        location="global",
        profile_name="profile1",
        resource_group_name="RG",
        tags={})
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const afdEndpoint = new azure_native.cdn.AFDEndpoint("afdEndpoint", {
        autoGeneratedDomainNameLabelScope: azure_native.cdn.AutoGeneratedDomainNameLabelScope.TenantReuse,
        enabledState: azure_native.cdn.EnabledState.Enabled,
        endpointName: "endpoint1",
        location: "global",
        profileName: "profile1",
        resourceGroupName: "RG",
        tags: {},
    });
    
    resources:
      afdEndpoint:
        type: azure-native:cdn:AFDEndpoint
        properties:
          autoGeneratedDomainNameLabelScope: TenantReuse
          enabledState: Enabled
          endpointName: endpoint1
          location: global
          profileName: profile1
          resourceGroupName: RG
          tags: {}
    

    Create AFDEndpoint Resource

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

    Constructor syntax

    new AFDEndpoint(name: string, args: AFDEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def AFDEndpoint(resource_name: str,
                    args: AFDEndpointArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AFDEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    profile_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    auto_generated_domain_name_label_scope: Optional[Union[str, AutoGeneratedDomainNameLabelScope]] = None,
                    enabled_state: Optional[Union[str, EnabledState]] = None,
                    endpoint_name: Optional[str] = None,
                    location: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None)
    func NewAFDEndpoint(ctx *Context, name string, args AFDEndpointArgs, opts ...ResourceOption) (*AFDEndpoint, error)
    public AFDEndpoint(string name, AFDEndpointArgs args, CustomResourceOptions? opts = null)
    public AFDEndpoint(String name, AFDEndpointArgs args)
    public AFDEndpoint(String name, AFDEndpointArgs args, CustomResourceOptions options)
    
    type: azure-native:cdn:AFDEndpoint
    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 AFDEndpointArgs
    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 AFDEndpointArgs
    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 AFDEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AFDEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AFDEndpointArgs
    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 afdendpointResource = new AzureNative.Cdn.AFDEndpoint("afdendpointResource", new()
    {
        ProfileName = "string",
        ResourceGroupName = "string",
        AutoGeneratedDomainNameLabelScope = "string",
        EnabledState = "string",
        EndpointName = "string",
        Location = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := cdn.NewAFDEndpoint(ctx, "afdendpointResource", &cdn.AFDEndpointArgs{
    ProfileName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    AutoGeneratedDomainNameLabelScope: pulumi.String("string"),
    EnabledState: pulumi.String("string"),
    EndpointName: pulumi.String("string"),
    Location: pulumi.String("string"),
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var afdendpointResource = new AFDEndpoint("afdendpointResource", AFDEndpointArgs.builder()        
        .profileName("string")
        .resourceGroupName("string")
        .autoGeneratedDomainNameLabelScope("string")
        .enabledState("string")
        .endpointName("string")
        .location("string")
        .tags(Map.of("string", "string"))
        .build());
    
    afdendpoint_resource = azure_native.cdn.AFDEndpoint("afdendpointResource",
        profile_name="string",
        resource_group_name="string",
        auto_generated_domain_name_label_scope="string",
        enabled_state="string",
        endpoint_name="string",
        location="string",
        tags={
            "string": "string",
        })
    
    const afdendpointResource = new azure_native.cdn.AFDEndpoint("afdendpointResource", {
        profileName: "string",
        resourceGroupName: "string",
        autoGeneratedDomainNameLabelScope: "string",
        enabledState: "string",
        endpointName: "string",
        location: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:cdn:AFDEndpoint
    properties:
        autoGeneratedDomainNameLabelScope: string
        enabledState: string
        endpointName: string
        location: string
        profileName: string
        resourceGroupName: string
        tags:
            string: string
    

    AFDEndpoint 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 AFDEndpoint resource accepts the following input properties:

    ProfileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    AutoGeneratedDomainNameLabelScope string | Pulumi.AzureNative.Cdn.AutoGeneratedDomainNameLabelScope
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    EnabledState string | Pulumi.AzureNative.Cdn.EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    EndpointName string
    Name of the endpoint under the profile which is unique globally.
    Location string
    Resource location.
    Tags Dictionary<string, string>
    Resource tags.
    ProfileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    AutoGeneratedDomainNameLabelScope string | AutoGeneratedDomainNameLabelScope
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    EnabledState string | EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    EndpointName string
    Name of the endpoint under the profile which is unique globally.
    Location string
    Resource location.
    Tags map[string]string
    Resource tags.
    profileName String
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    autoGeneratedDomainNameLabelScope String | AutoGeneratedDomainNameLabelScope
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    enabledState String | EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    endpointName String
    Name of the endpoint under the profile which is unique globally.
    location String
    Resource location.
    tags Map<String,String>
    Resource tags.
    profileName string
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    autoGeneratedDomainNameLabelScope string | AutoGeneratedDomainNameLabelScope
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    enabledState string | EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    endpointName string
    Name of the endpoint under the profile which is unique globally.
    location string
    Resource location.
    tags {[key: string]: string}
    Resource tags.
    profile_name str
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    auto_generated_domain_name_label_scope str | AutoGeneratedDomainNameLabelScope
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    enabled_state str | EnabledState
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    endpoint_name str
    Name of the endpoint under the profile which is unique globally.
    location str
    Resource location.
    tags Mapping[str, str]
    Resource tags.
    profileName String
    Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    autoGeneratedDomainNameLabelScope String | "TenantReuse" | "SubscriptionReuse" | "ResourceGroupReuse" | "NoReuse"
    Indicates the endpoint name reuse scope. The default value is TenantReuse.
    enabledState String | "Enabled" | "Disabled"
    Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
    endpointName String
    Name of the endpoint under the profile which is unique globally.
    location String
    Resource location.
    tags Map<String>
    Resource tags.

    Outputs

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

    DeploymentStatus string
    HostName string
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    Provisioning status
    SystemData Pulumi.AzureNative.Cdn.Outputs.SystemDataResponse
    Read only system data
    Type string
    Resource type.
    DeploymentStatus string
    HostName string
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    Provisioning status
    SystemData SystemDataResponse
    Read only system data
    Type string
    Resource type.
    deploymentStatus String
    hostName String
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type String
    Resource type.
    deploymentStatus string
    hostName string
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    Provisioning status
    systemData SystemDataResponse
    Read only system data
    type string
    Resource type.
    deployment_status str
    host_name str
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    Provisioning status
    system_data SystemDataResponse
    Read only system data
    type str
    Resource type.
    deploymentStatus String
    hostName String
    The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    Provisioning status
    systemData Property Map
    Read only system data
    type String
    Resource type.

    Supporting Types

    AutoGeneratedDomainNameLabelScope, AutoGeneratedDomainNameLabelScopeArgs

    TenantReuse
    TenantReuse
    SubscriptionReuse
    SubscriptionReuse
    ResourceGroupReuse
    ResourceGroupReuse
    NoReuse
    NoReuse
    AutoGeneratedDomainNameLabelScopeTenantReuse
    TenantReuse
    AutoGeneratedDomainNameLabelScopeSubscriptionReuse
    SubscriptionReuse
    AutoGeneratedDomainNameLabelScopeResourceGroupReuse
    ResourceGroupReuse
    AutoGeneratedDomainNameLabelScopeNoReuse
    NoReuse
    TenantReuse
    TenantReuse
    SubscriptionReuse
    SubscriptionReuse
    ResourceGroupReuse
    ResourceGroupReuse
    NoReuse
    NoReuse
    TenantReuse
    TenantReuse
    SubscriptionReuse
    SubscriptionReuse
    ResourceGroupReuse
    ResourceGroupReuse
    NoReuse
    NoReuse
    TENANT_REUSE
    TenantReuse
    SUBSCRIPTION_REUSE
    SubscriptionReuse
    RESOURCE_GROUP_REUSE
    ResourceGroupReuse
    NO_REUSE
    NoReuse
    "TenantReuse"
    TenantReuse
    "SubscriptionReuse"
    SubscriptionReuse
    "ResourceGroupReuse"
    ResourceGroupReuse
    "NoReuse"
    NoReuse

    EnabledState, EnabledStateArgs

    Enabled
    Enabled
    Disabled
    Disabled
    EnabledStateEnabled
    Enabled
    EnabledStateDisabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    Enabled
    Enabled
    Disabled
    Disabled
    ENABLED
    Enabled
    DISABLED
    Disabled
    "Enabled"
    Enabled
    "Disabled"
    Disabled

    SystemDataResponse, SystemDataResponseArgs

    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    An identifier for the identity that created the resource
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    The type of identity that last modified the resource
    CreatedAt string
    The timestamp of resource creation (UTC)
    CreatedBy string
    An identifier for the identity that created the resource
    CreatedByType string
    The type of identity that created the resource
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    An identifier for the identity that last modified the resource
    LastModifiedByType string
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    An identifier for the identity that created the resource
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    The type of identity that last modified the resource
    createdAt string
    The timestamp of resource creation (UTC)
    createdBy string
    An identifier for the identity that created the resource
    createdByType string
    The type of identity that created the resource
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    An identifier for the identity that last modified the resource
    lastModifiedByType string
    The type of identity that last modified the resource
    created_at str
    The timestamp of resource creation (UTC)
    created_by str
    An identifier for the identity that created the resource
    created_by_type str
    The type of identity that created the resource
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    An identifier for the identity that last modified the resource
    last_modified_by_type str
    The type of identity that last modified the resource
    createdAt String
    The timestamp of resource creation (UTC)
    createdBy String
    An identifier for the identity that created the resource
    createdByType String
    The type of identity that created the resource
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    An identifier for the identity that last modified the resource
    lastModifiedByType String
    The type of identity that last modified the resource

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:cdn:AFDEndpoint endpoint1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/afdEndpoints/{endpointName} 
    

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

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