Package com.pulumi.azurenative.web

Class WebApp

  • public class WebApp
extends com.pulumi.resources.CustomResource
    A web app, a mobile app backend, or an API app. API Version: 2020-12-01. ## Import An existing resource can be imported using its type token, name, and identifier, e.g. ```sh $ pulumi import azure-native:web:WebApp myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      WebApp​(java.lang.String name)  
      WebApp​(java.lang.String name, WebAppArgs args)  
      WebApp​(java.lang.String name, WebAppArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Constructor Detail

      • WebApp

        public WebApp​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • WebApp

        public WebApp​(java.lang.String name,
              WebAppArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • WebApp

        public WebApp​(java.lang.String name,
              WebAppArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • availabilityState

        public com.pulumi.core.Output<java.lang.String> availabilityState()
        Returns:
        Management information availability state for the app.

      • clientAffinityEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> clientAffinityEnabled()
        Returns:
        <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.

      • clientCertEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> clientCertEnabled()
        Returns:
        <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.

      • clientCertExclusionPaths

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientCertExclusionPaths()
        Returns:
        client certificate authentication comma-separated exclusion paths

      • clientCertMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> clientCertMode()
        Returns:
        This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.

      • containerSize

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> containerSize()
        Returns:
        Size of the function container.

      • customDomainVerificationId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customDomainVerificationId()
        Returns:
        Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

      • dailyMemoryTimeQuota

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> dailyMemoryTimeQuota()
        Returns:
        Maximum allowed daily memory-time quota (applicable on dynamic apps only).

      • defaultHostName

        public com.pulumi.core.Output<java.lang.String> defaultHostName()
        Returns:
        Default hostname of the app. Read-only.

      • enabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()
        Returns:
        <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).

      • enabledHostNames

        public com.pulumi.core.Output<java.util.List<java.lang.String>> enabledHostNames()
        Returns:
        Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

      • hostNameSslStates

        public com.pulumi.core.Output<java.util.Optional<java.util.List<HostNameSslStateResponse>>> hostNameSslStates()
        Returns:
        Hostname SSL states are used to manage the SSL bindings for app's hostnames.

      • hostNames

        public com.pulumi.core.Output<java.util.List<java.lang.String>> hostNames()
        Returns:
        Hostnames associated with the app.

      • hostNamesDisabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> hostNamesDisabled()
        Returns:
        <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.

      • hostingEnvironmentProfile

        public com.pulumi.core.Output<java.util.Optional<HostingEnvironmentProfileResponse>> hostingEnvironmentProfile()
        Returns:
        App Service Environment to use for the app.

      • httpsOnly

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> httpsOnly()
        Returns:
        HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

      • hyperV

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> hyperV()
        Returns:
        Hyper-V sandbox.

      • inProgressOperationId

        public com.pulumi.core.Output<java.lang.String> inProgressOperationId()
        Returns:
        Specifies an operation id if this site has a pending operation.

      • isDefaultContainer

        public com.pulumi.core.Output<java.lang.Boolean> isDefaultContainer()
        Returns:
        <code>true</code> if the app is a default container; otherwise, <code>false</code>.

      • isXenon

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> isXenon()
        Returns:
        Obsolete: Hyper-V sandbox.

      • keyVaultReferenceIdentity

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> keyVaultReferenceIdentity()
        Returns:
        Identity to use for Key Vault Reference authentication.

      • kind

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kind()
        Returns:
        Kind of resource.

      • lastModifiedTimeUtc

        public com.pulumi.core.Output<java.lang.String> lastModifiedTimeUtc()
        Returns:
        Last time the app was modified, in UTC. Read-only.

      • location

        public com.pulumi.core.Output<java.lang.String> location()
        Returns:
        Resource Location.

      • maxNumberOfWorkers

        public com.pulumi.core.Output<java.lang.Integer> maxNumberOfWorkers()
        Returns:
        Maximum number of workers. This only applies to Functions container.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Resource Name.

      • outboundIpAddresses

        public com.pulumi.core.Output<java.lang.String> outboundIpAddresses()
        Returns:
        List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.

      • possibleOutboundIpAddresses

        public com.pulumi.core.Output<java.lang.String> possibleOutboundIpAddresses()
        Returns:
        List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

      • redundancyMode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> redundancyMode()
        Returns:
        Site redundancy mode

      • repositorySiteName

        public com.pulumi.core.Output<java.lang.String> repositorySiteName()
        Returns:
        Name of the repository site.

      • reserved

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> reserved()
        Returns:
        <code>true</code> if reserved; otherwise, <code>false</code>.

      • resourceGroup

        public com.pulumi.core.Output<java.lang.String> resourceGroup()
        Returns:
        Name of the resource group the app belongs to. Read-only.

      • scmSiteAlsoStopped

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> scmSiteAlsoStopped()
        Returns:
        <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.

      • serverFarmId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> serverFarmId()
        Returns:
        Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

      • siteConfig

        public com.pulumi.core.Output<java.util.Optional<SiteConfigResponse>> siteConfig()
        Returns:
        Configuration of the app.

      • slotSwapStatus

        public com.pulumi.core.Output<SlotSwapStatusResponse> slotSwapStatus()
        Returns:
        Status of the last deployment slot swap operation.

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        Current state of the app.

      • storageAccountRequired

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> storageAccountRequired()
        Returns:
        Checks if Customer provided storage account is required

      • suspendedTill

        public com.pulumi.core.Output<java.lang.String> suspendedTill()
        Returns:
        App suspended till in case memory-time quota is exceeded.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Resource tags.

      • targetSwapSlot

        public com.pulumi.core.Output<java.lang.String> targetSwapSlot()
        Returns:
        Specifies which deployment slot this app will swap into. Read-only.

      • trafficManagerHostNames

        public com.pulumi.core.Output<java.util.List<java.lang.String>> trafficManagerHostNames()
        Returns:
        Azure Traffic Manager hostnames associated with the app. Read-only.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Resource type.

      • usageState

        public com.pulumi.core.Output<java.lang.String> usageState()
        Returns:
        State indicating whether the app has exceeded its quota usage. Read-only.

      • virtualNetworkSubnetId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> virtualNetworkSubnetId()
        Returns:
        Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

      • get

        public static WebApp get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        options - Optional settings to control the behavior of the CustomResource.