import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages a Windows Web App. * * ## 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 exampleServicePlan = new azure.appservice.ServicePlan("example", { * name: "example", * resourceGroupName: example.name, * location: example.location, * skuName: "P1v2", * osType: "Windows", * }); * const exampleWindowsWebApp = new azure.appservice.WindowsWebApp("example", { * name: "example", * resourceGroupName: example.name, * location: exampleServicePlan.location, * servicePlanId: exampleServicePlan.id, * siteConfig: {}, * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.Web` - 2023-12-01, 2023-01-01 * * ## Import * * Windows Web Apps can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:appservice/windowsWebApp:WindowsWebApp example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Web/sites/site1 * ``` */ export declare class WindowsWebApp extends pulumi.CustomResource { /** * Get an existing WindowsWebApp 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?: WindowsWebAppState, opts?: pulumi.CustomResourceOptions): WindowsWebApp; /** * Returns true if the given object is an instance of WindowsWebApp. 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 WindowsWebApp; /** * A map of key-value pairs of App Settings. */ readonly appSettings: pulumi.Output<{ [key: string]: string; } | undefined>; /** * An `authSettings` block as defined below. */ readonly authSettings: pulumi.Output; /** * An `authSettingsV2` block as defined below. */ readonly authSettingsV2: pulumi.Output; /** * A `backup` block as defined below. */ readonly backup: pulumi.Output; /** * Should Client Affinity be enabled? */ readonly clientAffinityEnabled: pulumi.Output; /** * Should Client Certificates be enabled? */ readonly clientCertificateEnabled: pulumi.Output; /** * Paths to exclude when using client certificates, separated by ; */ readonly clientCertificateExclusionPaths: pulumi.Output; /** * The Client Certificate mode. Possible values are `Required`, `Optional`, and `OptionalInteractiveUser`. This property has no effect when `clientCertificateEnabled` is `false`. Defaults to `Required`. */ readonly clientCertificateMode: pulumi.Output; /** * One or more `connectionString` blocks as defined below. */ readonly connectionStrings: pulumi.Output; /** * The identifier used by App Service to perform domain ownership verification via DNS TXT record. */ readonly customDomainVerificationId: pulumi.Output; /** * The default hostname of the Windows Web App. */ readonly defaultHostname: pulumi.Output; /** * Should the Windows Web App be enabled? Defaults to `true`. */ readonly enabled: pulumi.Output; /** * Should the default FTP Basic Authentication publishing profile be enabled. Defaults to `true`. */ readonly ftpPublishBasicAuthenticationEnabled: pulumi.Output; /** * The ID of the App Service Environment used by App Service. */ readonly hostingEnvironmentId: pulumi.Output; /** * Should the Windows Web App require HTTPS connections. Defaults to `false`. */ readonly httpsOnly: pulumi.Output; /** * An `identity` block as defined below. */ readonly identity: pulumi.Output; /** * The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the `identity` block. [For more information see - Access vaults with a user-assigned identity](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references#access-vaults-with-a-user-assigned-identity) */ readonly keyVaultReferenceIdentityId: pulumi.Output; /** * The Kind value for this Windows Web App. */ readonly kind: pulumi.Output; /** * The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ readonly location: pulumi.Output; /** * A `logs` block as defined below. */ readonly logs: pulumi.Output; /** * The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created. */ readonly name: pulumi.Output; /** * A list of outbound IP addresses - such as `["52.23.25.3", "52.143.43.12"]` */ readonly outboundIpAddressLists: pulumi.Output; /** * A comma separated list of outbound IP addresses - such as `52.23.25.3,52.143.43.12`. */ readonly outboundIpAddresses: pulumi.Output; /** * A list of possible outbound ip address. */ readonly possibleOutboundIpAddressLists: pulumi.Output; /** * A comma separated list of outbound IP addresses - such as `52.23.25.3,52.143.43.12,52.143.43.17` - not all of which are necessarily in use. Superset of `outboundIpAddresses`. */ readonly possibleOutboundIpAddresses: pulumi.Output; /** * Should public network access be enabled for the Web App. Defaults to `true`. */ readonly publicNetworkAccessEnabled: pulumi.Output; /** * The name of the Resource Group where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ readonly resourceGroupName: pulumi.Output; /** * The ID of the Service Plan that this Windows App Service will be created in. */ readonly servicePlanId: pulumi.Output; /** * A `siteConfig` block as defined below. */ readonly siteConfig: pulumi.Output; /** * A `siteCredential` block as defined below. */ readonly siteCredentials: pulumi.Output; /** * A `stickySettings` block as defined below. */ readonly stickySettings: pulumi.Output; /** * One or more `storageAccount` blocks as defined below. * * > **Note:** Using this value requires `WEBSITE_RUN_FROM_PACKAGE=1` to be set on the App in `appSettings`. Refer to the [Azure docs](https://docs.microsoft.com/en-us/azure/app-service/deploy-run-package) for further details. */ readonly storageAccounts: pulumi.Output; /** * A mapping of tags which should be assigned to the Windows Web App. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * Whether backup and restore operations over the linked virtual network are enabled. Defaults to `false`. */ readonly virtualNetworkBackupRestoreEnabled: pulumi.Output; /** * Whether traffic for the image pull should be routed over the virtual network. * * > **Note:** `virtualNetworkImagePullEnabled` must be set to `true` when running in an App Service Environment. */ readonly virtualNetworkImagePullEnabled: pulumi.Output; /** * The subnet id which will be used by this Web App for [regional virtual network integration](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#regional-virtual-network-integration). * * > **Note:** The AzureRM Terraform provider provides regional virtual network integration via the standalone resource appServiceVirtualNetworkSwiftConnection and in-line within this resource using the `virtualNetworkSubnetId` property. You cannot use both methods simultaneously. If the virtual network is set via the resource `appServiceVirtualNetworkSwiftConnection` then `ignoreChanges` should be used in the web app configuration. * * > **Note:** Assigning the `virtualNetworkSubnetId` property requires [RBAC permissions on the subnet](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#permissions) */ readonly virtualNetworkSubnetId: pulumi.Output; /** * Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to `true`. * * > **Note:** Setting this value to true will disable the ability to use `zipDeployFile` which currently relies on the default publishing profile. */ readonly webdeployPublishBasicAuthenticationEnabled: pulumi.Output; /** * The local path and filename of the Zip packaged application to deploy to this Windows Web App. * * > **Note:** Using this value requires either `WEBSITE_RUN_FROM_PACKAGE=1` or `SCM_DO_BUILD_DURING_DEPLOYMENT=true` to be set on the App in `appSettings`. Refer to the Azure docs on [running the Web App directly from the Zip package](https://learn.microsoft.com/en-us/azure/app-service/deploy-run-package), or [automating the build for Zip deploy](https://learn.microsoft.com/en-us/azure/app-service/deploy-zip#enable-build-automation-for-zip-deploy) for further details. */ readonly zipDeployFile: pulumi.Output; /** * Create a WindowsWebApp 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: WindowsWebAppArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering WindowsWebApp resources. */ export interface WindowsWebAppState { /** * A map of key-value pairs of App Settings. */ appSettings?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * An `authSettings` block as defined below. */ authSettings?: pulumi.Input; /** * An `authSettingsV2` block as defined below. */ authSettingsV2?: pulumi.Input; /** * A `backup` block as defined below. */ backup?: pulumi.Input; /** * Should Client Affinity be enabled? */ clientAffinityEnabled?: pulumi.Input; /** * Should Client Certificates be enabled? */ clientCertificateEnabled?: pulumi.Input; /** * Paths to exclude when using client certificates, separated by ; */ clientCertificateExclusionPaths?: pulumi.Input; /** * The Client Certificate mode. Possible values are `Required`, `Optional`, and `OptionalInteractiveUser`. This property has no effect when `clientCertificateEnabled` is `false`. Defaults to `Required`. */ clientCertificateMode?: pulumi.Input; /** * One or more `connectionString` blocks as defined below. */ connectionStrings?: pulumi.Input[]>; /** * The identifier used by App Service to perform domain ownership verification via DNS TXT record. */ customDomainVerificationId?: pulumi.Input; /** * The default hostname of the Windows Web App. */ defaultHostname?: pulumi.Input; /** * Should the Windows Web App be enabled? Defaults to `true`. */ enabled?: pulumi.Input; /** * Should the default FTP Basic Authentication publishing profile be enabled. Defaults to `true`. */ ftpPublishBasicAuthenticationEnabled?: pulumi.Input; /** * The ID of the App Service Environment used by App Service. */ hostingEnvironmentId?: pulumi.Input; /** * Should the Windows Web App require HTTPS connections. Defaults to `false`. */ httpsOnly?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the `identity` block. [For more information see - Access vaults with a user-assigned identity](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references#access-vaults-with-a-user-assigned-identity) */ keyVaultReferenceIdentityId?: pulumi.Input; /** * The Kind value for this Windows Web App. */ kind?: pulumi.Input; /** * The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ location?: pulumi.Input; /** * A `logs` block as defined below. */ logs?: pulumi.Input; /** * The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created. */ name?: pulumi.Input; /** * A list of outbound IP addresses - such as `["52.23.25.3", "52.143.43.12"]` */ outboundIpAddressLists?: pulumi.Input[]>; /** * A comma separated list of outbound IP addresses - such as `52.23.25.3,52.143.43.12`. */ outboundIpAddresses?: pulumi.Input; /** * A list of possible outbound ip address. */ possibleOutboundIpAddressLists?: pulumi.Input[]>; /** * A comma separated list of outbound IP addresses - such as `52.23.25.3,52.143.43.12,52.143.43.17` - not all of which are necessarily in use. Superset of `outboundIpAddresses`. */ possibleOutboundIpAddresses?: pulumi.Input; /** * Should public network access be enabled for the Web App. Defaults to `true`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * The name of the Resource Group where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ resourceGroupName?: pulumi.Input; /** * The ID of the Service Plan that this Windows App Service will be created in. */ servicePlanId?: pulumi.Input; /** * A `siteConfig` block as defined below. */ siteConfig?: pulumi.Input; /** * A `siteCredential` block as defined below. */ siteCredentials?: pulumi.Input[]>; /** * A `stickySettings` block as defined below. */ stickySettings?: pulumi.Input; /** * One or more `storageAccount` blocks as defined below. * * > **Note:** Using this value requires `WEBSITE_RUN_FROM_PACKAGE=1` to be set on the App in `appSettings`. Refer to the [Azure docs](https://docs.microsoft.com/en-us/azure/app-service/deploy-run-package) for further details. */ storageAccounts?: pulumi.Input[]>; /** * A mapping of tags which should be assigned to the Windows Web App. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether backup and restore operations over the linked virtual network are enabled. Defaults to `false`. */ virtualNetworkBackupRestoreEnabled?: pulumi.Input; /** * Whether traffic for the image pull should be routed over the virtual network. * * > **Note:** `virtualNetworkImagePullEnabled` must be set to `true` when running in an App Service Environment. */ virtualNetworkImagePullEnabled?: pulumi.Input; /** * The subnet id which will be used by this Web App for [regional virtual network integration](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#regional-virtual-network-integration). * * > **Note:** The AzureRM Terraform provider provides regional virtual network integration via the standalone resource appServiceVirtualNetworkSwiftConnection and in-line within this resource using the `virtualNetworkSubnetId` property. You cannot use both methods simultaneously. If the virtual network is set via the resource `appServiceVirtualNetworkSwiftConnection` then `ignoreChanges` should be used in the web app configuration. * * > **Note:** Assigning the `virtualNetworkSubnetId` property requires [RBAC permissions on the subnet](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#permissions) */ virtualNetworkSubnetId?: pulumi.Input; /** * Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to `true`. * * > **Note:** Setting this value to true will disable the ability to use `zipDeployFile` which currently relies on the default publishing profile. */ webdeployPublishBasicAuthenticationEnabled?: pulumi.Input; /** * The local path and filename of the Zip packaged application to deploy to this Windows Web App. * * > **Note:** Using this value requires either `WEBSITE_RUN_FROM_PACKAGE=1` or `SCM_DO_BUILD_DURING_DEPLOYMENT=true` to be set on the App in `appSettings`. Refer to the Azure docs on [running the Web App directly from the Zip package](https://learn.microsoft.com/en-us/azure/app-service/deploy-run-package), or [automating the build for Zip deploy](https://learn.microsoft.com/en-us/azure/app-service/deploy-zip#enable-build-automation-for-zip-deploy) for further details. */ zipDeployFile?: pulumi.Input; } /** * The set of arguments for constructing a WindowsWebApp resource. */ export interface WindowsWebAppArgs { /** * A map of key-value pairs of App Settings. */ appSettings?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * An `authSettings` block as defined below. */ authSettings?: pulumi.Input; /** * An `authSettingsV2` block as defined below. */ authSettingsV2?: pulumi.Input; /** * A `backup` block as defined below. */ backup?: pulumi.Input; /** * Should Client Affinity be enabled? */ clientAffinityEnabled?: pulumi.Input; /** * Should Client Certificates be enabled? */ clientCertificateEnabled?: pulumi.Input; /** * Paths to exclude when using client certificates, separated by ; */ clientCertificateExclusionPaths?: pulumi.Input; /** * The Client Certificate mode. Possible values are `Required`, `Optional`, and `OptionalInteractiveUser`. This property has no effect when `clientCertificateEnabled` is `false`. Defaults to `Required`. */ clientCertificateMode?: pulumi.Input; /** * One or more `connectionString` blocks as defined below. */ connectionStrings?: pulumi.Input[]>; /** * Should the Windows Web App be enabled? Defaults to `true`. */ enabled?: pulumi.Input; /** * Should the default FTP Basic Authentication publishing profile be enabled. Defaults to `true`. */ ftpPublishBasicAuthenticationEnabled?: pulumi.Input; /** * Should the Windows Web App require HTTPS connections. Defaults to `false`. */ httpsOnly?: pulumi.Input; /** * An `identity` block as defined below. */ identity?: pulumi.Input; /** * The User Assigned Identity ID used for accessing KeyVault secrets. The identity must be assigned to the application in the `identity` block. [For more information see - Access vaults with a user-assigned identity](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references#access-vaults-with-a-user-assigned-identity) */ keyVaultReferenceIdentityId?: pulumi.Input; /** * The Azure Region where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ location?: pulumi.Input; /** * A `logs` block as defined below. */ logs?: pulumi.Input; /** * The name which should be used for this Windows Web App. Changing this forces a new Windows Web App to be created. */ name?: pulumi.Input; /** * Should public network access be enabled for the Web App. Defaults to `true`. */ publicNetworkAccessEnabled?: pulumi.Input; /** * The name of the Resource Group where the Windows Web App should exist. Changing this forces a new Windows Web App to be created. */ resourceGroupName: pulumi.Input; /** * The ID of the Service Plan that this Windows App Service will be created in. */ servicePlanId: pulumi.Input; /** * A `siteConfig` block as defined below. */ siteConfig: pulumi.Input; /** * A `stickySettings` block as defined below. */ stickySettings?: pulumi.Input; /** * One or more `storageAccount` blocks as defined below. * * > **Note:** Using this value requires `WEBSITE_RUN_FROM_PACKAGE=1` to be set on the App in `appSettings`. Refer to the [Azure docs](https://docs.microsoft.com/en-us/azure/app-service/deploy-run-package) for further details. */ storageAccounts?: pulumi.Input[]>; /** * A mapping of tags which should be assigned to the Windows Web App. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Whether backup and restore operations over the linked virtual network are enabled. Defaults to `false`. */ virtualNetworkBackupRestoreEnabled?: pulumi.Input; /** * Whether traffic for the image pull should be routed over the virtual network. * * > **Note:** `virtualNetworkImagePullEnabled` must be set to `true` when running in an App Service Environment. */ virtualNetworkImagePullEnabled?: pulumi.Input; /** * The subnet id which will be used by this Web App for [regional virtual network integration](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#regional-virtual-network-integration). * * > **Note:** The AzureRM Terraform provider provides regional virtual network integration via the standalone resource appServiceVirtualNetworkSwiftConnection and in-line within this resource using the `virtualNetworkSubnetId` property. You cannot use both methods simultaneously. If the virtual network is set via the resource `appServiceVirtualNetworkSwiftConnection` then `ignoreChanges` should be used in the web app configuration. * * > **Note:** Assigning the `virtualNetworkSubnetId` property requires [RBAC permissions on the subnet](https://docs.microsoft.com/en-us/azure/app-service/overview-vnet-integration#permissions) */ virtualNetworkSubnetId?: pulumi.Input; /** * Should the default WebDeploy Basic Authentication publishing credentials enabled. Defaults to `true`. * * > **Note:** Setting this value to true will disable the ability to use `zipDeployFile` which currently relies on the default publishing profile. */ webdeployPublishBasicAuthenticationEnabled?: pulumi.Input; /** * The local path and filename of the Zip packaged application to deploy to this Windows Web App. * * > **Note:** Using this value requires either `WEBSITE_RUN_FROM_PACKAGE=1` or `SCM_DO_BUILD_DURING_DEPLOYMENT=true` to be set on the App in `appSettings`. Refer to the Azure docs on [running the Web App directly from the Zip package](https://learn.microsoft.com/en-us/azure/app-service/deploy-run-package), or [automating the build for Zip deploy](https://learn.microsoft.com/en-us/azure/app-service/deploy-zip#enable-build-automation-for-zip-deploy) for further details. */ zipDeployFile?: pulumi.Input; }