import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Front Door (standard/premium) Origin. * * !> **Note:** If you are attempting to implement an Origin that uses its own Private Link Service with a Load Balancer the Profile resource in your configuration file **must** have a `dependsOn` meta-argument which references the `azure.privatedns.LinkService`, see `Example Usage With Private Link Service` below. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleFrontdoorProfile = new azure.cdn.FrontdoorProfile("example", { * name: "example-profile", * resourceGroupName: example.name, * skuName: "Premium_AzureFrontDoor", * }); * const exampleFrontdoorOriginGroup = new azure.cdn.FrontdoorOriginGroup("example", { * name: "example-origingroup", * cdnFrontdoorProfileId: exampleFrontdoorProfile.id, * loadBalancing: {}, * }); * const exampleFrontdoorOrigin = new azure.cdn.FrontdoorOrigin("example", { * name: "example-origin", * cdnFrontdoorOriginGroupId: exampleFrontdoorOriginGroup.id, * enabled: true, * certificateNameCheckEnabled: false, * hostName: "contoso.com", * httpPort: 80, * httpsPort: 443, * originHostHeader: "www.contoso.com", * priority: 1, * weight: 1, * }); * ``` * * ### With Private Link * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleAccount = new azure.storage.Account("example", { * name: "examplestoracc", * resourceGroupName: example.name, * location: example.location, * accountTier: "Premium", * accountReplicationType: "LRS", * allowNestedItemsToBePublic: false, * networkRules: { * defaultAction: "Deny", * }, * tags: { * environment: "Example", * }, * }); * const exampleFrontdoorProfile = new azure.cdn.FrontdoorProfile("example", { * name: "example-profile", * resourceGroupName: example.name, * skuName: "Premium_AzureFrontDoor", * }); * const exampleFrontdoorOriginGroup = new azure.cdn.FrontdoorOriginGroup("example", { * name: "example-origin-group", * cdnFrontdoorProfileId: exampleFrontdoorProfile.id, * loadBalancing: {}, * }); * const exampleFrontdoorOrigin = new azure.cdn.FrontdoorOrigin("example", { * name: "example-origin", * cdnFrontdoorOriginGroupId: exampleFrontdoorOriginGroup.id, * enabled: true, * certificateNameCheckEnabled: true, * hostName: exampleAccount.primaryBlobHost, * originHostHeader: exampleAccount.primaryBlobHost, * priority: 1, * weight: 500, * privateLink: { * requestMessage: "Request access for Private Link Origin CDN Frontdoor", * targetType: "blob", * location: exampleAccount.location, * privateLinkTargetId: exampleAccount.id, * }, * }); * ``` * * ### With Private Link Service * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const current = azure.core.getClientConfig({}); * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleVirtualNetwork = new azure.network.VirtualNetwork("example", { * name: "vn-example", * resourceGroupName: example.name, * location: example.location, * addressSpaces: ["10.5.0.0/16"], * }); * const exampleSubnet = new azure.network.Subnet("example", { * name: "sn-example", * resourceGroupName: example.name, * virtualNetworkName: exampleVirtualNetwork.name, * addressPrefixes: ["10.5.1.0/24"], * privateLinkServiceNetworkPoliciesEnabled: false, * }); * const examplePublicIp = new azure.network.PublicIp("example", { * name: "ip-example", * sku: "Standard", * location: example.location, * resourceGroupName: example.name, * allocationMethod: "Static", * }); * const exampleLoadBalancer = new azure.lb.LoadBalancer("example", { * name: "lb-example", * sku: "Standard", * location: example.location, * resourceGroupName: example.name, * frontendIpConfigurations: [{ * name: examplePublicIp.name, * publicIpAddressId: examplePublicIp.id, * }], * }); * const exampleLinkService = new azure.privatedns.LinkService("example", { * name: "pls-example", * resourceGroupName: example.name, * location: example.location, * visibilitySubscriptionIds: [current.then(current => current.subscriptionId)], * loadBalancerFrontendIpConfigurationIds: [exampleLoadBalancer.frontendIpConfigurations.apply(frontendIpConfigurations => frontendIpConfigurations?.[0]?.id)], * natIpConfigurations: [{ * name: "primary", * privateIpAddress: "10.5.1.17", * privateIpAddressVersion: "IPv4", * subnetId: exampleSubnet.id, * primary: true, * }], * }); * const exampleFrontdoorProfile = new azure.cdn.FrontdoorProfile("example", { * name: "profile-example", * resourceGroupName: example.name, * skuName: "Premium_AzureFrontDoor", * }, { * dependsOn: [exampleLinkService], * }); * const exampleFrontdoorOriginGroup = new azure.cdn.FrontdoorOriginGroup("example", { * name: "group-example", * cdnFrontdoorProfileId: exampleFrontdoorProfile.id, * loadBalancing: { * additionalLatencyInMilliseconds: 0, * sampleSize: 16, * successfulSamplesRequired: 3, * }, * }); * const exampleFrontdoorOrigin = new azure.cdn.FrontdoorOrigin("example", { * name: "origin-example", * cdnFrontdoorOriginGroupId: exampleFrontdoorOriginGroup.id, * enabled: true, * hostName: "example.com", * originHostHeader: "example.com", * priority: 1, * weight: 1000, * certificateNameCheckEnabled: false, * privateLink: { * requestMessage: "Request access for Private Link Origin CDN Frontdoor", * location: example.location, * privateLinkTargetId: exampleLinkService.id, * }, * }); * ``` * * ## Example HCL Configurations * * * Private Link Origin with Storage Account Blob * * Private Link Origin with Storage Account Static Web Site * * Private Link Origin with Linux Web Application * * Private Link Origin with Internal Load Balancer * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Cdn` - 2024-02-01 * * ## Import * * Front Door Origins can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:cdn/frontdoorOrigin:FrontdoorOrigin example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Cdn/profiles/profile1/originGroups/originGroup1/origins/origin1 * ``` */ export declare class FrontdoorOrigin extends pulumi.CustomResource { /** * Get an existing FrontdoorOrigin resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: FrontdoorOriginState, opts?: pulumi.CustomResourceOptions): FrontdoorOrigin; /** * Returns true if the given object is an instance of FrontdoorOrigin. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is FrontdoorOrigin; /** * The ID of the Front Door Origin Group within which this Front Door Origin should exist. Changing this forces a new Front Door Origin to be created. */ readonly cdnFrontdoorOriginGroupId: pulumi.Output; /** * Specifies whether certificate name checks are enabled for this origin. */ readonly certificateNameCheckEnabled: pulumi.Output; /** * Should the origin be enabled? Possible values are `true` or `false`. Defaults to `true`. */ readonly enabled: pulumi.Output; /** * The IPv4 address, IPv6 address or Domain name of the Origin. * * !> **Note:** This must be unique across all Front Door Origins within a Front Door Endpoint. */ readonly hostName: pulumi.Output; /** * The value of the HTTP port. Must be between `1` and `65535`. Defaults to `80`. */ readonly httpPort: pulumi.Output; /** * The value of the HTTPS port. Must be between `1` and `65535`. Defaults to `443`. */ readonly httpsPort: pulumi.Output; /** * The name which should be used for this Front Door Origin. Changing this forces a new Front Door Origin to be created. */ readonly name: pulumi.Output; /** * The host header value (an IPv4 address, IPv6 address or Domain name) which is sent to the origin with each request. If unspecified the hostname from the request will be used. * * > **Note:** Azure Front Door Origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin's hostname. This field's value overrides the host header defined in the Front Door Endpoint. For more information on how to properly set the origin host header value please see the [product documentation](https://docs.microsoft.com/azure/frontdoor/origin?pivots=front-door-standard-premium#origin-host-header). */ readonly originHostHeader: pulumi.Output; /** * Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy. Must be between `1` and `5` (inclusive). Defaults to `1`. */ readonly priority: pulumi.Output; /** * A `privateLink` block as defined below. * * > **Note:** Private Link requires that the Front Door Profile this Origin is hosted within is using the SKU `Premium_AzureFrontDoor` and that the `certificateNameCheckEnabled` field is set to `true`. */ readonly privateLink: pulumi.Output; /** * The weight of the origin in a given origin group for load balancing. Must be between `1` and `1000`. Defaults to `500`. */ readonly weight: pulumi.Output; /** * Create a FrontdoorOrigin resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: FrontdoorOriginArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering FrontdoorOrigin resources. */ export interface FrontdoorOriginState { /** * The ID of the Front Door Origin Group within which this Front Door Origin should exist. Changing this forces a new Front Door Origin to be created. */ cdnFrontdoorOriginGroupId?: pulumi.Input; /** * Specifies whether certificate name checks are enabled for this origin. */ certificateNameCheckEnabled?: pulumi.Input; /** * Should the origin be enabled? Possible values are `true` or `false`. Defaults to `true`. */ enabled?: pulumi.Input; /** * The IPv4 address, IPv6 address or Domain name of the Origin. * * !> **Note:** This must be unique across all Front Door Origins within a Front Door Endpoint. */ hostName?: pulumi.Input; /** * The value of the HTTP port. Must be between `1` and `65535`. Defaults to `80`. */ httpPort?: pulumi.Input; /** * The value of the HTTPS port. Must be between `1` and `65535`. Defaults to `443`. */ httpsPort?: pulumi.Input; /** * The name which should be used for this Front Door Origin. Changing this forces a new Front Door Origin to be created. */ name?: pulumi.Input; /** * The host header value (an IPv4 address, IPv6 address or Domain name) which is sent to the origin with each request. If unspecified the hostname from the request will be used. * * > **Note:** Azure Front Door Origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin's hostname. This field's value overrides the host header defined in the Front Door Endpoint. For more information on how to properly set the origin host header value please see the [product documentation](https://docs.microsoft.com/azure/frontdoor/origin?pivots=front-door-standard-premium#origin-host-header). */ originHostHeader?: pulumi.Input; /** * Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy. Must be between `1` and `5` (inclusive). Defaults to `1`. */ priority?: pulumi.Input; /** * A `privateLink` block as defined below. * * > **Note:** Private Link requires that the Front Door Profile this Origin is hosted within is using the SKU `Premium_AzureFrontDoor` and that the `certificateNameCheckEnabled` field is set to `true`. */ privateLink?: pulumi.Input; /** * The weight of the origin in a given origin group for load balancing. Must be between `1` and `1000`. Defaults to `500`. */ weight?: pulumi.Input; } /** * The set of arguments for constructing a FrontdoorOrigin resource. */ export interface FrontdoorOriginArgs { /** * The ID of the Front Door Origin Group within which this Front Door Origin should exist. Changing this forces a new Front Door Origin to be created. */ cdnFrontdoorOriginGroupId: pulumi.Input; /** * Specifies whether certificate name checks are enabled for this origin. */ certificateNameCheckEnabled: pulumi.Input; /** * Should the origin be enabled? Possible values are `true` or `false`. Defaults to `true`. */ enabled?: pulumi.Input; /** * The IPv4 address, IPv6 address or Domain name of the Origin. * * !> **Note:** This must be unique across all Front Door Origins within a Front Door Endpoint. */ hostName: pulumi.Input; /** * The value of the HTTP port. Must be between `1` and `65535`. Defaults to `80`. */ httpPort?: pulumi.Input; /** * The value of the HTTPS port. Must be between `1` and `65535`. Defaults to `443`. */ httpsPort?: pulumi.Input; /** * The name which should be used for this Front Door Origin. Changing this forces a new Front Door Origin to be created. */ name?: pulumi.Input; /** * The host header value (an IPv4 address, IPv6 address or Domain name) which is sent to the origin with each request. If unspecified the hostname from the request will be used. * * > **Note:** Azure Front Door Origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin's hostname. This field's value overrides the host header defined in the Front Door Endpoint. For more information on how to properly set the origin host header value please see the [product documentation](https://docs.microsoft.com/azure/frontdoor/origin?pivots=front-door-standard-premium#origin-host-header). */ originHostHeader?: pulumi.Input; /** * Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy. Must be between `1` and `5` (inclusive). Defaults to `1`. */ priority?: pulumi.Input; /** * A `privateLink` block as defined below. * * > **Note:** Private Link requires that the Front Door Profile this Origin is hosted within is using the SKU `Premium_AzureFrontDoor` and that the `certificateNameCheckEnabled` field is set to `true`. */ privateLink?: pulumi.Input; /** * The weight of the origin in a given origin group for load balancing. Must be between `1` and `1000`. Defaults to `500`. */ weight?: pulumi.Input; }