@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.
*
* Uses Azure REST API version 2025-06-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, 2024-09-01, 2025-01-01-preview, 2025-04-15, 2025-07-01-preview, 2025-09-01-preview. 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 OriginGroup extends pulumi.CustomResource {
/**
* Get an existing OriginGroup 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): OriginGroup;
/**
* Returns true if the given object is an instance of OriginGroup. 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 OriginGroup;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Health probe settings to the origin that is used to determine the health of the origin.
*/
readonly healthProbeSettings: pulumi.Output<outputs.cdn.HealthProbeParametersResponse | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The source of the content being delivered via CDN within given origin group.
*/
readonly origins: pulumi.Output<outputs.cdn.ResourceReferenceResponse[] | undefined>;
/**
* Provisioning status of the origin group.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Resource status of the origin group.
*/
readonly resourceState: pulumi.Output<string>;
/**
* The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
*/
readonly responseBasedOriginErrorDetectionSettings: pulumi.Output<outputs.cdn.ResponseBasedOriginErrorDetectionParametersResponse | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.cdn.SystemDataResponse>;
/**
* Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
*/
readonly trafficRestorationTimeToHealedOrNewEndpointsInMinutes: pulumi.Output<number | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a OriginGroup 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: OriginGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a OriginGroup resource.
*/
export interface OriginGroupArgs {
/**
* Name of the endpoint under the profile which is unique globally.
*/
endpointName: pulumi.Input<string>;
/**
* Health probe settings to the origin that is used to determine the health of the origin.
*/
healthProbeSettings?: pulumi.Input<inputs.cdn.HealthProbeParametersArgs>;
/**
* Name of the origin group which is unique within the endpoint.
*/
originGroupName?: pulumi.Input<string>;
/**
* The source of the content being delivered via CDN within given origin group.
*/
origins?: pulumi.Input<pulumi.Input<inputs.cdn.ResourceReferenceArgs>[]>;
/**
* Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.
*/
profileName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
*/
responseBasedOriginErrorDetectionSettings?: pulumi.Input<inputs.cdn.ResponseBasedOriginErrorDetectionParametersArgs>;
/**
* Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
*/
trafficRestorationTimeToHealedOrNewEndpointsInMinutes?: pulumi.Input<number>;
}