1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. WebAppActiveSlot

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

azure.appservice.WebAppActiveSlot

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi

    Manages a Web App Active Slot.

    Example Usage

    Windows Web App

    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-plan",
        resourceGroupName: example.name,
        location: example.location,
        osType: "Windows",
        skuName: "P1v2",
    });
    const exampleWindowsWebApp = new azure.appservice.WindowsWebApp("example", {
        name: "example-windows-web-app",
        resourceGroupName: example.name,
        location: exampleServicePlan.location,
        servicePlanId: exampleServicePlan.id,
        siteConfig: {},
    });
    const exampleWindowsWebAppSlot = new azure.appservice.WindowsWebAppSlot("example", {
        name: "example-windows-web-app-slot",
        appServiceId: exampleWindowsWebApp.name,
        siteConfig: {},
    });
    const exampleWebAppActiveSlot = new azure.appservice.WebAppActiveSlot("example", {slotId: exampleWindowsWebAppSlot.id});
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_service_plan = azure.appservice.ServicePlan("example",
        name="example-plan",
        resource_group_name=example.name,
        location=example.location,
        os_type="Windows",
        sku_name="P1v2")
    example_windows_web_app = azure.appservice.WindowsWebApp("example",
        name="example-windows-web-app",
        resource_group_name=example.name,
        location=example_service_plan.location,
        service_plan_id=example_service_plan.id,
        site_config={})
    example_windows_web_app_slot = azure.appservice.WindowsWebAppSlot("example",
        name="example-windows-web-app-slot",
        app_service_id=example_windows_web_app.name,
        site_config={})
    example_web_app_active_slot = azure.appservice.WebAppActiveSlot("example", slot_id=example_windows_web_app_slot.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
    	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleServicePlan, err := appservice.NewServicePlan(ctx, "example", &appservice.ServicePlanArgs{
    			Name:              pulumi.String("example-plan"),
    			ResourceGroupName: example.Name,
    			Location:          example.Location,
    			OsType:            pulumi.String("Windows"),
    			SkuName:           pulumi.String("P1v2"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleWindowsWebApp, err := appservice.NewWindowsWebApp(ctx, "example", &appservice.WindowsWebAppArgs{
    			Name:              pulumi.String("example-windows-web-app"),
    			ResourceGroupName: example.Name,
    			Location:          exampleServicePlan.Location,
    			ServicePlanId:     exampleServicePlan.ID(),
    			SiteConfig:        &appservice.WindowsWebAppSiteConfigArgs{},
    		})
    		if err != nil {
    			return err
    		}
    		exampleWindowsWebAppSlot, err := appservice.NewWindowsWebAppSlot(ctx, "example", &appservice.WindowsWebAppSlotArgs{
    			Name:         pulumi.String("example-windows-web-app-slot"),
    			AppServiceId: exampleWindowsWebApp.Name,
    			SiteConfig:   &appservice.WindowsWebAppSlotSiteConfigArgs{},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = appservice.NewWebAppActiveSlot(ctx, "example", &appservice.WebAppActiveSlotArgs{
    			SlotId: exampleWindowsWebAppSlot.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleServicePlan = new Azure.AppService.ServicePlan("example", new()
        {
            Name = "example-plan",
            ResourceGroupName = example.Name,
            Location = example.Location,
            OsType = "Windows",
            SkuName = "P1v2",
        });
    
        var exampleWindowsWebApp = new Azure.AppService.WindowsWebApp("example", new()
        {
            Name = "example-windows-web-app",
            ResourceGroupName = example.Name,
            Location = exampleServicePlan.Location,
            ServicePlanId = exampleServicePlan.Id,
            SiteConfig = null,
        });
    
        var exampleWindowsWebAppSlot = new Azure.AppService.WindowsWebAppSlot("example", new()
        {
            Name = "example-windows-web-app-slot",
            AppServiceId = exampleWindowsWebApp.Name,
            SiteConfig = null,
        });
    
        var exampleWebAppActiveSlot = new Azure.AppService.WebAppActiveSlot("example", new()
        {
            SlotId = exampleWindowsWebAppSlot.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appservice.ServicePlan;
    import com.pulumi.azure.appservice.ServicePlanArgs;
    import com.pulumi.azure.appservice.WindowsWebApp;
    import com.pulumi.azure.appservice.WindowsWebAppArgs;
    import com.pulumi.azure.appservice.inputs.WindowsWebAppSiteConfigArgs;
    import com.pulumi.azure.appservice.WindowsWebAppSlot;
    import com.pulumi.azure.appservice.WindowsWebAppSlotArgs;
    import com.pulumi.azure.appservice.inputs.WindowsWebAppSlotSiteConfigArgs;
    import com.pulumi.azure.appservice.WebAppActiveSlot;
    import com.pulumi.azure.appservice.WebAppActiveSlotArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ResourceGroup("example", ResourceGroupArgs.builder()
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()
                .name("example-plan")
                .resourceGroupName(example.name())
                .location(example.location())
                .osType("Windows")
                .skuName("P1v2")
                .build());
    
            var exampleWindowsWebApp = new WindowsWebApp("exampleWindowsWebApp", WindowsWebAppArgs.builder()
                .name("example-windows-web-app")
                .resourceGroupName(example.name())
                .location(exampleServicePlan.location())
                .servicePlanId(exampleServicePlan.id())
                .siteConfig()
                .build());
    
            var exampleWindowsWebAppSlot = new WindowsWebAppSlot("exampleWindowsWebAppSlot", WindowsWebAppSlotArgs.builder()
                .name("example-windows-web-app-slot")
                .appServiceId(exampleWindowsWebApp.name())
                .siteConfig()
                .build());
    
            var exampleWebAppActiveSlot = new WebAppActiveSlot("exampleWebAppActiveSlot", WebAppActiveSlotArgs.builder()
                .slotId(exampleWindowsWebAppSlot.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleServicePlan:
        type: azure:appservice:ServicePlan
        name: example
        properties:
          name: example-plan
          resourceGroupName: ${example.name}
          location: ${example.location}
          osType: Windows
          skuName: P1v2
      exampleWindowsWebApp:
        type: azure:appservice:WindowsWebApp
        name: example
        properties:
          name: example-windows-web-app
          resourceGroupName: ${example.name}
          location: ${exampleServicePlan.location}
          servicePlanId: ${exampleServicePlan.id}
          siteConfig: {}
      exampleWindowsWebAppSlot:
        type: azure:appservice:WindowsWebAppSlot
        name: example
        properties:
          name: example-windows-web-app-slot
          appServiceId: ${exampleWindowsWebApp.name}
          siteConfig: {}
      exampleWebAppActiveSlot:
        type: azure:appservice:WebAppActiveSlot
        name: example
        properties:
          slotId: ${exampleWindowsWebAppSlot.id}
    

    Linux Web App

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleServicePlan:
        type: azure:appservice:ServicePlan
        name: example
        properties:
          name: example-plan
          resourceGroupName: ${example.name}
          location: ${example.location}
          osType: Linux
          skuName: P1v2
      exampleLinuxWebApp:
        type: azure:appservice:LinuxWebApp
        name: example
        properties:
          name: example-linux-web-app
          resourceGroupName: ${example.name}
          location: ${exampleServicePlan.location}
          servicePlanId: ${exampleServicePlan.id}
          siteConfig: {}
      exampleLinuxWebAppSlot:
        type: azure:appservice:LinuxWebAppSlot
        name: example
        properties:
          name: example-linux-web-app-slot
          appServiceName: ${exampleLinuxWebApp.name}
          location: ${exampleServicePlan.location}
          servicePlanId: ${exampleServicePlan.id}
          siteConfig: {}
      exampleWebAppActiveSlot:
        type: azure:appservice:WebAppActiveSlot
        name: example
        properties:
          slotId: ${exampleLinuxWebAppSlot.id}
    

    Create WebAppActiveSlot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WebAppActiveSlot(name: string, args: WebAppActiveSlotArgs, opts?: CustomResourceOptions);
    @overload
    def WebAppActiveSlot(resource_name: str,
                         args: WebAppActiveSlotArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def WebAppActiveSlot(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         slot_id: Optional[str] = None,
                         overwrite_network_config: Optional[bool] = None)
    func NewWebAppActiveSlot(ctx *Context, name string, args WebAppActiveSlotArgs, opts ...ResourceOption) (*WebAppActiveSlot, error)
    public WebAppActiveSlot(string name, WebAppActiveSlotArgs args, CustomResourceOptions? opts = null)
    public WebAppActiveSlot(String name, WebAppActiveSlotArgs args)
    public WebAppActiveSlot(String name, WebAppActiveSlotArgs args, CustomResourceOptions options)
    
    type: azure:appservice:WebAppActiveSlot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args WebAppActiveSlotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebAppActiveSlotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebAppActiveSlotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppActiveSlotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppActiveSlotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var webAppActiveSlotResource = new Azure.AppService.WebAppActiveSlot("webAppActiveSlotResource", new()
    {
        SlotId = "string",
        OverwriteNetworkConfig = false,
    });
    
    example, err := appservice.NewWebAppActiveSlot(ctx, "webAppActiveSlotResource", &appservice.WebAppActiveSlotArgs{
    	SlotId:                 pulumi.String("string"),
    	OverwriteNetworkConfig: pulumi.Bool(false),
    })
    
    var webAppActiveSlotResource = new WebAppActiveSlot("webAppActiveSlotResource", WebAppActiveSlotArgs.builder()
        .slotId("string")
        .overwriteNetworkConfig(false)
        .build());
    
    web_app_active_slot_resource = azure.appservice.WebAppActiveSlot("webAppActiveSlotResource",
        slot_id="string",
        overwrite_network_config=False)
    
    const webAppActiveSlotResource = new azure.appservice.WebAppActiveSlot("webAppActiveSlotResource", {
        slotId: "string",
        overwriteNetworkConfig: false,
    });
    
    type: azure:appservice:WebAppActiveSlot
    properties:
        overwriteNetworkConfig: false
        slotId: string
    

    WebAppActiveSlot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WebAppActiveSlot resource accepts the following input properties:

    SlotId string
    The ID of the Slot to swap with Production.
    OverwriteNetworkConfig bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    SlotId string
    The ID of the Slot to swap with Production.
    OverwriteNetworkConfig bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId String
    The ID of the Slot to swap with Production.
    overwriteNetworkConfig Boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId string
    The ID of the Slot to swap with Production.
    overwriteNetworkConfig boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slot_id str
    The ID of the Slot to swap with Production.
    overwrite_network_config bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId String
    The ID of the Slot to swap with Production.
    overwriteNetworkConfig Boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WebAppActiveSlot resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulSwap String
    The timestamp of the last successful swap with Production.
    id string
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    id str
    The provider-assigned unique ID for this managed resource.
    last_successful_swap str
    The timestamp of the last successful swap with Production.
    id String
    The provider-assigned unique ID for this managed resource.
    lastSuccessfulSwap String
    The timestamp of the last successful swap with Production.

    Look up Existing WebAppActiveSlot Resource

    Get an existing WebAppActiveSlot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WebAppActiveSlotState, opts?: CustomResourceOptions): WebAppActiveSlot
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            last_successful_swap: Optional[str] = None,
            overwrite_network_config: Optional[bool] = None,
            slot_id: Optional[str] = None) -> WebAppActiveSlot
    func GetWebAppActiveSlot(ctx *Context, name string, id IDInput, state *WebAppActiveSlotState, opts ...ResourceOption) (*WebAppActiveSlot, error)
    public static WebAppActiveSlot Get(string name, Input<string> id, WebAppActiveSlotState? state, CustomResourceOptions? opts = null)
    public static WebAppActiveSlot get(String name, Output<String> id, WebAppActiveSlotState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    LastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    OverwriteNetworkConfig bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    SlotId string
    The ID of the Slot to swap with Production.
    LastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    OverwriteNetworkConfig bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    SlotId string
    The ID of the Slot to swap with Production.
    lastSuccessfulSwap String
    The timestamp of the last successful swap with Production.
    overwriteNetworkConfig Boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId String
    The ID of the Slot to swap with Production.
    lastSuccessfulSwap string
    The timestamp of the last successful swap with Production.
    overwriteNetworkConfig boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId string
    The ID of the Slot to swap with Production.
    last_successful_swap str
    The timestamp of the last successful swap with Production.
    overwrite_network_config bool
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slot_id str
    The ID of the Slot to swap with Production.
    lastSuccessfulSwap String
    The timestamp of the last successful swap with Production.
    overwriteNetworkConfig Boolean
    The swap action should overwrite the Production slot's network configuration with the configuration from this slot. Defaults to true. Changing this forces a new resource to be created.
    slotId String
    The ID of the Slot to swap with Production.

    Import

    a Web App Active Slot can be imported using the resource id, e.g.

    $ pulumi import azure:appservice/webAppActiveSlot:WebAppActiveSlot example "/subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Web/sites/site1"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.13.0 published on Monday, Dec 9, 2024 by Pulumi