1. Packages
  2. Packages
  3. Azure Classic
  4. API Docs
  5. compute
  6. BastionHost

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    Manages a Bastion Host.

    Example Usage

    This example deploys an Azure Bastion Host Instance to a target virtual network.

    using Pulumi;
    using Azure = Pulumi.Azure;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
            {
                Location = "West Europe",
            });
            var exampleVirtualNetwork = new Azure.Network.VirtualNetwork("exampleVirtualNetwork", new Azure.Network.VirtualNetworkArgs
            {
                AddressSpaces = 
                {
                    "192.168.1.0/24",
                },
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
            });
            var exampleSubnet = new Azure.Network.Subnet("exampleSubnet", new Azure.Network.SubnetArgs
            {
                ResourceGroupName = exampleResourceGroup.Name,
                VirtualNetworkName = exampleVirtualNetwork.Name,
                AddressPrefixes = 
                {
                    "192.168.1.224/27",
                },
            });
            var examplePublicIp = new Azure.Network.PublicIp("examplePublicIp", new Azure.Network.PublicIpArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                AllocationMethod = "Static",
                Sku = "Standard",
            });
            var exampleBastionHost = new Azure.Compute.BastionHost("exampleBastionHost", new Azure.Compute.BastionHostArgs
            {
                Location = exampleResourceGroup.Location,
                ResourceGroupName = exampleResourceGroup.Name,
                IpConfiguration = new Azure.Compute.Inputs.BastionHostIpConfigurationArgs
                {
                    Name = "configuration",
                    SubnetId = exampleSubnet.Id,
                    PublicIpAddressId = examplePublicIp.Id,
                },
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/compute"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
    	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/network"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "exampleVirtualNetwork", &network.VirtualNetworkArgs{
    			AddressSpaces: pulumi.StringArray{
    				pulumi.String("192.168.1.0/24"),
    			},
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		exampleSubnet, err := network.NewSubnet(ctx, "exampleSubnet", &network.SubnetArgs{
    			ResourceGroupName:  exampleResourceGroup.Name,
    			VirtualNetworkName: exampleVirtualNetwork.Name,
    			AddressPrefixes: pulumi.StringArray{
    				pulumi.String("192.168.1.224/27"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		examplePublicIp, err := network.NewPublicIp(ctx, "examplePublicIp", &network.PublicIpArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			AllocationMethod:  pulumi.String("Static"),
    			Sku:               pulumi.String("Standard"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = compute.NewBastionHost(ctx, "exampleBastionHost", &compute.BastionHostArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			IpConfiguration: &compute.BastionHostIpConfigurationArgs{
    				Name:              pulumi.String("configuration"),
    				SubnetId:          exampleSubnet.ID(),
    				PublicIpAddressId: examplePublicIp.ID(),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleVirtualNetwork = new azure.network.VirtualNetwork("exampleVirtualNetwork", {
        addressSpaces: ["192.168.1.0/24"],
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
    });
    const exampleSubnet = new azure.network.Subnet("exampleSubnet", {
        resourceGroupName: exampleResourceGroup.name,
        virtualNetworkName: exampleVirtualNetwork.name,
        addressPrefixes: ["192.168.1.224/27"],
    });
    const examplePublicIp = new azure.network.PublicIp("examplePublicIp", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        allocationMethod: "Static",
        sku: "Standard",
    });
    const exampleBastionHost = new azure.compute.BastionHost("exampleBastionHost", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        ipConfiguration: {
            name: "configuration",
            subnetId: exampleSubnet.id,
            publicIpAddressId: examplePublicIp.id,
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_virtual_network = azure.network.VirtualNetwork("exampleVirtualNetwork",
        address_spaces=["192.168.1.0/24"],
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name)
    example_subnet = azure.network.Subnet("exampleSubnet",
        resource_group_name=example_resource_group.name,
        virtual_network_name=example_virtual_network.name,
        address_prefixes=["192.168.1.224/27"])
    example_public_ip = azure.network.PublicIp("examplePublicIp",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        allocation_method="Static",
        sku="Standard")
    example_bastion_host = azure.compute.BastionHost("exampleBastionHost",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        ip_configuration=azure.compute.BastionHostIpConfigurationArgs(
            name="configuration",
            subnet_id=example_subnet.id,
            public_ip_address_id=example_public_ip.id,
        ))
    

    Example coming soon!

    Create BastionHost Resource

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

    Constructor syntax

    new BastionHost(name: string, args: BastionHostArgs, opts?: CustomResourceOptions);
    @overload
    def BastionHost(resource_name: str,
                    args: BastionHostArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def BastionHost(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    resource_group_name: Optional[str] = None,
                    copy_paste_enabled: Optional[bool] = None,
                    file_copy_enabled: Optional[bool] = None,
                    ip_configuration: Optional[BastionHostIpConfigurationArgs] = None,
                    ip_connect_enabled: Optional[bool] = None,
                    location: Optional[str] = None,
                    name: Optional[str] = None,
                    scale_units: Optional[int] = None,
                    shareable_link_enabled: Optional[bool] = None,
                    sku: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    tunneling_enabled: Optional[bool] = None)
    func NewBastionHost(ctx *Context, name string, args BastionHostArgs, opts ...ResourceOption) (*BastionHost, error)
    public BastionHost(string name, BastionHostArgs args, CustomResourceOptions? opts = null)
    public BastionHost(String name, BastionHostArgs args)
    public BastionHost(String name, BastionHostArgs args, CustomResourceOptions options)
    
    type: azure:compute:BastionHost
    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 BastionHostArgs
    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 BastionHostArgs
    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 BastionHostArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BastionHostArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BastionHostArgs
    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 bastionHostResource = new Azure.Compute.BastionHost("bastionHostResource", new()
    {
        ResourceGroupName = "string",
        CopyPasteEnabled = false,
        FileCopyEnabled = false,
        IpConfiguration = new Azure.Compute.Inputs.BastionHostIpConfigurationArgs
        {
            Name = "string",
            PublicIpAddressId = "string",
            SubnetId = "string",
        },
        IpConnectEnabled = false,
        Location = "string",
        Name = "string",
        ScaleUnits = 0,
        ShareableLinkEnabled = false,
        Sku = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TunnelingEnabled = false,
    });
    
    example, err := compute.NewBastionHost(ctx, "bastionHostResource", &compute.BastionHostArgs{
    	ResourceGroupName: pulumi.String("string"),
    	CopyPasteEnabled:  pulumi.Bool(false),
    	FileCopyEnabled:   pulumi.Bool(false),
    	IpConfiguration: &compute.BastionHostIpConfigurationArgs{
    		Name:              pulumi.String("string"),
    		PublicIpAddressId: pulumi.String("string"),
    		SubnetId:          pulumi.String("string"),
    	},
    	IpConnectEnabled:     pulumi.Bool(false),
    	Location:             pulumi.String("string"),
    	Name:                 pulumi.String("string"),
    	ScaleUnits:           pulumi.Int(0),
    	ShareableLinkEnabled: pulumi.Bool(false),
    	Sku:                  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TunnelingEnabled: pulumi.Bool(false),
    })
    
    var bastionHostResource = new BastionHost("bastionHostResource", BastionHostArgs.builder()
        .resourceGroupName("string")
        .copyPasteEnabled(false)
        .fileCopyEnabled(false)
        .ipConfiguration(BastionHostIpConfigurationArgs.builder()
            .name("string")
            .publicIpAddressId("string")
            .subnetId("string")
            .build())
        .ipConnectEnabled(false)
        .location("string")
        .name("string")
        .scaleUnits(0)
        .shareableLinkEnabled(false)
        .sku("string")
        .tags(Map.of("string", "string"))
        .tunnelingEnabled(false)
        .build());
    
    bastion_host_resource = azure.compute.BastionHost("bastionHostResource",
        resource_group_name="string",
        copy_paste_enabled=False,
        file_copy_enabled=False,
        ip_configuration={
            "name": "string",
            "public_ip_address_id": "string",
            "subnet_id": "string",
        },
        ip_connect_enabled=False,
        location="string",
        name="string",
        scale_units=0,
        shareable_link_enabled=False,
        sku="string",
        tags={
            "string": "string",
        },
        tunneling_enabled=False)
    
    const bastionHostResource = new azure.compute.BastionHost("bastionHostResource", {
        resourceGroupName: "string",
        copyPasteEnabled: false,
        fileCopyEnabled: false,
        ipConfiguration: {
            name: "string",
            publicIpAddressId: "string",
            subnetId: "string",
        },
        ipConnectEnabled: false,
        location: "string",
        name: "string",
        scaleUnits: 0,
        shareableLinkEnabled: false,
        sku: "string",
        tags: {
            string: "string",
        },
        tunnelingEnabled: false,
    });
    
    type: azure:compute:BastionHost
    properties:
        copyPasteEnabled: false
        fileCopyEnabled: false
        ipConfiguration:
            name: string
            publicIpAddressId: string
            subnetId: string
        ipConnectEnabled: false
        location: string
        name: string
        resourceGroupName: string
        scaleUnits: 0
        shareableLinkEnabled: false
        sku: string
        tags:
            string: string
        tunnelingEnabled: false
    

    BastionHost 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 BastionHost resource accepts the following input properties:

    ResourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    CopyPasteEnabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    FileCopyEnabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    IpConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    IpConnectEnabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    Name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    ScaleUnits int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    ShareableLinkEnabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    Sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TunnelingEnabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    ResourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    CopyPasteEnabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    FileCopyEnabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    IpConfiguration BastionHostIpConfigurationArgs
    A ip_configuration block as defined below.
    IpConnectEnabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    Name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    ScaleUnits int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    ShareableLinkEnabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    Sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TunnelingEnabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Bastion Host.
    copyPasteEnabled Boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    fileCopyEnabled Boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    ipConnectEnabled Boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name String
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    scaleUnits Integer
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled Boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku String
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tunnelingEnabled Boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    resourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    copyPasteEnabled boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    fileCopyEnabled boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    ipConnectEnabled boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    scaleUnits number
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tunnelingEnabled boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    resource_group_name str
    The name of the resource group in which to create the Bastion Host.
    copy_paste_enabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    file_copy_enabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ip_configuration BastionHostIpConfigurationArgs
    A ip_configuration block as defined below.
    ip_connect_enabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name str
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    scale_units int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareable_link_enabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku str
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tunneling_enabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    resourceGroupName String
    The name of the resource group in which to create the Bastion Host.
    copyPasteEnabled Boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    fileCopyEnabled Boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration Property Map
    A ip_configuration block as defined below.
    ipConnectEnabled Boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name String
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    scaleUnits Number
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled Boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku String
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tunnelingEnabled Boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.

    Outputs

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

    DnsName string
    The FQDN for the Bastion Host.
    Id string
    The provider-assigned unique ID for this managed resource.
    DnsName string
    The FQDN for the Bastion Host.
    Id string
    The provider-assigned unique ID for this managed resource.
    dnsName String
    The FQDN for the Bastion Host.
    id String
    The provider-assigned unique ID for this managed resource.
    dnsName string
    The FQDN for the Bastion Host.
    id string
    The provider-assigned unique ID for this managed resource.
    dns_name str
    The FQDN for the Bastion Host.
    id str
    The provider-assigned unique ID for this managed resource.
    dnsName String
    The FQDN for the Bastion Host.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BastionHost Resource

    Get an existing BastionHost 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?: BastionHostState, opts?: CustomResourceOptions): BastionHost
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            copy_paste_enabled: Optional[bool] = None,
            dns_name: Optional[str] = None,
            file_copy_enabled: Optional[bool] = None,
            ip_configuration: Optional[BastionHostIpConfigurationArgs] = None,
            ip_connect_enabled: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            scale_units: Optional[int] = None,
            shareable_link_enabled: Optional[bool] = None,
            sku: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tunneling_enabled: Optional[bool] = None) -> BastionHost
    func GetBastionHost(ctx *Context, name string, id IDInput, state *BastionHostState, opts ...ResourceOption) (*BastionHost, error)
    public static BastionHost Get(string name, Input<string> id, BastionHostState? state, CustomResourceOptions? opts = null)
    public static BastionHost get(String name, Output<String> id, BastionHostState state, CustomResourceOptions options)
    resources:  _:    type: azure:compute:BastionHost    get:      id: ${id}
    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:
    CopyPasteEnabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    DnsName string
    The FQDN for the Bastion Host.
    FileCopyEnabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    IpConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    IpConnectEnabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    Name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    ScaleUnits int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    ShareableLinkEnabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    Sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    TunnelingEnabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    CopyPasteEnabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    DnsName string
    The FQDN for the Bastion Host.
    FileCopyEnabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    IpConfiguration BastionHostIpConfigurationArgs
    A ip_configuration block as defined below.
    IpConnectEnabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    Location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    Name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    ScaleUnits int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    ShareableLinkEnabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    Sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    TunnelingEnabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    copyPasteEnabled Boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    dnsName String
    The FQDN for the Bastion Host.
    fileCopyEnabled Boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    ipConnectEnabled Boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name String
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Bastion Host.
    scaleUnits Integer
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled Boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku String
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    tunnelingEnabled Boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    copyPasteEnabled boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    dnsName string
    The FQDN for the Bastion Host.
    fileCopyEnabled boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration BastionHostIpConfiguration
    A ip_configuration block as defined below.
    ipConnectEnabled boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location string
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name string
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the resource group in which to create the Bastion Host.
    scaleUnits number
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku string
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    tunnelingEnabled boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    copy_paste_enabled bool
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    dns_name str
    The FQDN for the Bastion Host.
    file_copy_enabled bool
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ip_configuration BastionHostIpConfigurationArgs
    A ip_configuration block as defined below.
    ip_connect_enabled bool
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location str
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name str
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the resource group in which to create the Bastion Host.
    scale_units int
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareable_link_enabled bool
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku str
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    tunneling_enabled bool
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.
    copyPasteEnabled Boolean
    Is Copy/Paste feature enabled for the Bastion Host. Defaults to true.
    dnsName String
    The FQDN for the Bastion Host.
    fileCopyEnabled Boolean
    Is File Copy feature enabled for the Bastion Host. Defaults to false.
    ipConfiguration Property Map
    A ip_configuration block as defined below.
    ipConnectEnabled Boolean
    Is IP Connect feature enabled for the Bastion Host. Defaults to false.
    location String
    Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Review Azure Bastion Host FAQ for supported locations.
    name String
    Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the resource group in which to create the Bastion Host.
    scaleUnits Number
    The number of scale units with which to provision the Bastion Host. Possible values are between 2 and 50. Defaults to 2.
    shareableLinkEnabled Boolean
    Is Shareable Link feature enabled for the Bastion Host. Defaults to false.
    sku String
    The SKU of the Bastion Host. Accepted values are Basic and Standard. Defaults to Basic.
    tags Map<String>
    A mapping of tags to assign to the resource.
    tunnelingEnabled Boolean
    Is Tunneling feature enabled for the Bastion Host. Defaults to false.

    Supporting Types

    BastionHostIpConfiguration, BastionHostIpConfigurationArgs

    Name string
    The name of the IP configuration.
    PublicIpAddressId string
    Reference to a Public IP Address to associate with this Bastion Host.
    SubnetId string
    Reference to a subnet in which this Bastion Host has been created.
    Name string
    The name of the IP configuration.
    PublicIpAddressId string
    Reference to a Public IP Address to associate with this Bastion Host.
    SubnetId string
    Reference to a subnet in which this Bastion Host has been created.
    name String
    The name of the IP configuration.
    publicIpAddressId String
    Reference to a Public IP Address to associate with this Bastion Host.
    subnetId String
    Reference to a subnet in which this Bastion Host has been created.
    name string
    The name of the IP configuration.
    publicIpAddressId string
    Reference to a Public IP Address to associate with this Bastion Host.
    subnetId string
    Reference to a subnet in which this Bastion Host has been created.
    name str
    The name of the IP configuration.
    public_ip_address_id str
    Reference to a Public IP Address to associate with this Bastion Host.
    subnet_id str
    Reference to a subnet in which this Bastion Host has been created.
    name String
    The name of the IP configuration.
    publicIpAddressId String
    Reference to a Public IP Address to associate with this Bastion Host.
    subnetId String
    Reference to a subnet in which this Bastion Host has been created.

    Import

    Bastion Hosts can be imported using the resource id, e.g.

     $ pulumi import azure:compute/bastionHost:BastionHost example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.Network/bastionHosts/instance1
    

    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.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial