@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* CDN origin is the source of the content being delivered via CDN. When the edge nodes represented by an endpoint do not have the requested content cached, they attempt to fetch it from one or more of the configured origins.
*
* Uses Azure REST API version 2024-09-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-07-01-preview, 2024-02-01, 2024-05-01-preview, 2024-06-01-preview, 2025-01-01-preview, 2025-04-15, 2025-06-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cdn [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Origin extends pulumi.CustomResource {
/**
* Get an existing Origin 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Origin;
/**
* Returns true if the given object is an instance of Origin. 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 Origin;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Origin is enabled for load balancing or not
*/
readonly enabled: pulumi.Output<boolean | undefined>;
/**
* The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
*/
readonly hostName: pulumi.Output<string>;
/**
* The value of the HTTP port. Must be between 1 and 65535.
*/
readonly httpPort: pulumi.Output<number | undefined>;
/**
* The value of the HTTPS port. Must be between 1 and 65535.
*/
readonly httpsPort: pulumi.Output<number | undefined>;
/**
* Resource name.
*/
readonly name: pulumi.Output<string>;
/**
* The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
*/
readonly originHostHeader: pulumi.Output<string | undefined>;
/**
* 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
*/
readonly priority: pulumi.Output<number | undefined>;
/**
* The approval status for the connection to the Private Link
*/
readonly privateEndpointStatus: pulumi.Output<string>;
/**
* The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
*/
readonly privateLinkAlias: pulumi.Output<string | undefined>;
/**
* A custom message to be included in the approval request to connect to the Private Link.
*/
readonly privateLinkApprovalMessage: pulumi.Output<string | undefined>;
/**
* The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
*/
readonly privateLinkLocation: pulumi.Output<string | undefined>;
/**
* The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
*/
readonly privateLinkResourceId: pulumi.Output<string | undefined>;
/**
* Provisioning status of the origin.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Resource status of the origin.
*/
readonly resourceState: pulumi.Output<string>;
/**
* Read only system data
*/
readonly systemData: pulumi.Output<outputs.cdn.SystemDataResponse>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
*/
readonly weight: pulumi.Output<number | undefined>;
/**
* Create a Origin 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: OriginArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Origin resource.
*/
export interface OriginArgs {
/**
* Origin is enabled for load balancing or not
*/
enabled?: pulumi.Input<boolean>;
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: pulumi.Input<string>;
/**
* The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.This should be unique across all origins in an endpoint.
*/
hostName: pulumi.Input<string>;
/**
* The value of the HTTP port. Must be between 1 and 65535.
*/
httpPort?: pulumi.Input<number>;
/**
* The value of the HTTPS port. Must be between 1 and 65535.
*/
httpsPort?: pulumi.Input<number>;
/**
* The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. This overrides the host header defined at Endpoint
*/
originHostHeader?: pulumi.Input<string>;
/**
* Name of the origin that is unique within the endpoint.
*/
originName?: pulumi.Input<string>;
/**
* 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
*/
priority?: pulumi.Input<number>;
/**
* The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'
*/
privateLinkAlias?: pulumi.Input<string>;
/**
* A custom message to be included in the approval request to connect to the Private Link.
*/
privateLinkApprovalMessage?: pulumi.Input<string>;
/**
* The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated
*/
privateLinkLocation?: pulumi.Input<string>;
/**
* The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'
*/
privateLinkResourceId?: pulumi.Input<string>;
/**
* Name of the CDN profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* Name of the Resource group within the Azure subscription.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Weight of the origin in given origin group for load balancing. Must be between 1 and 1000
*/
weight?: pulumi.Input<number>;
}