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

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

azure.compute.BastionHost

Explore with Pulumi AI

Manages a Bastion Host.

Example Usage

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

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 exampleVirtualNetwork = new azure.network.VirtualNetwork("example", {
    name: "examplevnet",
    addressSpaces: ["192.168.1.0/24"],
    location: example.location,
    resourceGroupName: example.name,
});
const exampleSubnet = new azure.network.Subnet("example", {
    name: "AzureBastionSubnet",
    resourceGroupName: example.name,
    virtualNetworkName: exampleVirtualNetwork.name,
    addressPrefixes: ["192.168.1.224/27"],
});
const examplePublicIp = new azure.network.PublicIp("example", {
    name: "examplepip",
    location: example.location,
    resourceGroupName: example.name,
    allocationMethod: "Static",
    sku: "Standard",
});
const exampleBastionHost = new azure.compute.BastionHost("example", {
    name: "examplebastion",
    location: example.location,
    resourceGroupName: example.name,
    ipConfiguration: {
        name: "configuration",
        subnetId: exampleSubnet.id,
        publicIpAddressId: examplePublicIp.id,
    },
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_virtual_network = azure.network.VirtualNetwork("example",
    name="examplevnet",
    address_spaces=["192.168.1.0/24"],
    location=example.location,
    resource_group_name=example.name)
example_subnet = azure.network.Subnet("example",
    name="AzureBastionSubnet",
    resource_group_name=example.name,
    virtual_network_name=example_virtual_network.name,
    address_prefixes=["192.168.1.224/27"])
example_public_ip = azure.network.PublicIp("example",
    name="examplepip",
    location=example.location,
    resource_group_name=example.name,
    allocation_method="Static",
    sku="Standard")
example_bastion_host = azure.compute.BastionHost("example",
    name="examplebastion",
    location=example.location,
    resource_group_name=example.name,
    ip_configuration={
        "name": "configuration",
        "subnet_id": example_subnet.id,
        "public_ip_address_id": example_public_ip.id,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/network"
	"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
		}
		exampleVirtualNetwork, err := network.NewVirtualNetwork(ctx, "example", &network.VirtualNetworkArgs{
			Name: pulumi.String("examplevnet"),
			AddressSpaces: pulumi.StringArray{
				pulumi.String("192.168.1.0/24"),
			},
			Location:          example.Location,
			ResourceGroupName: example.Name,
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := network.NewSubnet(ctx, "example", &network.SubnetArgs{
			Name:               pulumi.String("AzureBastionSubnet"),
			ResourceGroupName:  example.Name,
			VirtualNetworkName: exampleVirtualNetwork.Name,
			AddressPrefixes: pulumi.StringArray{
				pulumi.String("192.168.1.224/27"),
			},
		})
		if err != nil {
			return err
		}
		examplePublicIp, err := network.NewPublicIp(ctx, "example", &network.PublicIpArgs{
			Name:              pulumi.String("examplepip"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			AllocationMethod:  pulumi.String("Static"),
			Sku:               pulumi.String("Standard"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewBastionHost(ctx, "example", &compute.BastionHostArgs{
			Name:              pulumi.String("examplebastion"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			IpConfiguration: &compute.BastionHostIpConfigurationArgs{
				Name:              pulumi.String("configuration"),
				SubnetId:          exampleSubnet.ID(),
				PublicIpAddressId: examplePublicIp.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 exampleVirtualNetwork = new Azure.Network.VirtualNetwork("example", new()
    {
        Name = "examplevnet",
        AddressSpaces = new[]
        {
            "192.168.1.0/24",
        },
        Location = example.Location,
        ResourceGroupName = example.Name,
    });

    var exampleSubnet = new Azure.Network.Subnet("example", new()
    {
        Name = "AzureBastionSubnet",
        ResourceGroupName = example.Name,
        VirtualNetworkName = exampleVirtualNetwork.Name,
        AddressPrefixes = new[]
        {
            "192.168.1.224/27",
        },
    });

    var examplePublicIp = new Azure.Network.PublicIp("example", new()
    {
        Name = "examplepip",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AllocationMethod = "Static",
        Sku = "Standard",
    });

    var exampleBastionHost = new Azure.Compute.BastionHost("example", new()
    {
        Name = "examplebastion",
        Location = example.Location,
        ResourceGroupName = example.Name,
        IpConfiguration = new Azure.Compute.Inputs.BastionHostIpConfigurationArgs
        {
            Name = "configuration",
            SubnetId = exampleSubnet.Id,
            PublicIpAddressId = examplePublicIp.Id,
        },
    });

});
Copy
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.network.VirtualNetwork;
import com.pulumi.azure.network.VirtualNetworkArgs;
import com.pulumi.azure.network.Subnet;
import com.pulumi.azure.network.SubnetArgs;
import com.pulumi.azure.network.PublicIp;
import com.pulumi.azure.network.PublicIpArgs;
import com.pulumi.azure.compute.BastionHost;
import com.pulumi.azure.compute.BastionHostArgs;
import com.pulumi.azure.compute.inputs.BastionHostIpConfigurationArgs;
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 exampleVirtualNetwork = new VirtualNetwork("exampleVirtualNetwork", VirtualNetworkArgs.builder()
            .name("examplevnet")
            .addressSpaces("192.168.1.0/24")
            .location(example.location())
            .resourceGroupName(example.name())
            .build());

        var exampleSubnet = new Subnet("exampleSubnet", SubnetArgs.builder()
            .name("AzureBastionSubnet")
            .resourceGroupName(example.name())
            .virtualNetworkName(exampleVirtualNetwork.name())
            .addressPrefixes("192.168.1.224/27")
            .build());

        var examplePublicIp = new PublicIp("examplePublicIp", PublicIpArgs.builder()
            .name("examplepip")
            .location(example.location())
            .resourceGroupName(example.name())
            .allocationMethod("Static")
            .sku("Standard")
            .build());

        var exampleBastionHost = new BastionHost("exampleBastionHost", BastionHostArgs.builder()
            .name("examplebastion")
            .location(example.location())
            .resourceGroupName(example.name())
            .ipConfiguration(BastionHostIpConfigurationArgs.builder()
                .name("configuration")
                .subnetId(exampleSubnet.id())
                .publicIpAddressId(examplePublicIp.id())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleVirtualNetwork:
    type: azure:network:VirtualNetwork
    name: example
    properties:
      name: examplevnet
      addressSpaces:
        - 192.168.1.0/24
      location: ${example.location}
      resourceGroupName: ${example.name}
  exampleSubnet:
    type: azure:network:Subnet
    name: example
    properties:
      name: AzureBastionSubnet
      resourceGroupName: ${example.name}
      virtualNetworkName: ${exampleVirtualNetwork.name}
      addressPrefixes:
        - 192.168.1.224/27
  examplePublicIp:
    type: azure:network:PublicIp
    name: example
    properties:
      name: examplepip
      location: ${example.location}
      resourceGroupName: ${example.name}
      allocationMethod: Static
      sku: Standard
  exampleBastionHost:
    type: azure:compute:BastionHost
    name: example
    properties:
      name: examplebastion
      location: ${example.location}
      resourceGroupName: ${example.name}
      ipConfiguration:
        name: configuration
        subnetId: ${exampleSubnet.id}
        publicIpAddressId: ${examplePublicIp.id}
Copy

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,
                scale_units: Optional[int] = None,
                session_recording_enabled: Optional[bool] = None,
                ip_connect_enabled: Optional[bool] = None,
                kerberos_enabled: Optional[bool] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                ip_configuration: Optional[BastionHostIpConfigurationArgs] = None,
                copy_paste_enabled: Optional[bool] = None,
                file_copy_enabled: Optional[bool] = None,
                shareable_link_enabled: Optional[bool] = None,
                sku: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                tunneling_enabled: Optional[bool] = None,
                virtual_network_id: Optional[str] = None,
                zones: Optional[Sequence[str]] = 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 This property is required. string
The unique name of the resource.
args This property is required. BastionHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. BastionHostArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BastionHostArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    ScaleUnits = 0,
    SessionRecordingEnabled = false,
    IpConnectEnabled = false,
    KerberosEnabled = false,
    Location = "string",
    Name = "string",
    IpConfiguration = new Azure.Compute.Inputs.BastionHostIpConfigurationArgs
    {
        Name = "string",
        PublicIpAddressId = "string",
        SubnetId = "string",
    },
    CopyPasteEnabled = false,
    FileCopyEnabled = false,
    ShareableLinkEnabled = false,
    Sku = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TunnelingEnabled = false,
    VirtualNetworkId = "string",
    Zones = new[]
    {
        "string",
    },
});
Copy
example, err := compute.NewBastionHost(ctx, "bastionHostResource", &compute.BastionHostArgs{
	ResourceGroupName:       pulumi.String("string"),
	ScaleUnits:              pulumi.Int(0),
	SessionRecordingEnabled: pulumi.Bool(false),
	IpConnectEnabled:        pulumi.Bool(false),
	KerberosEnabled:         pulumi.Bool(false),
	Location:                pulumi.String("string"),
	Name:                    pulumi.String("string"),
	IpConfiguration: &compute.BastionHostIpConfigurationArgs{
		Name:              pulumi.String("string"),
		PublicIpAddressId: pulumi.String("string"),
		SubnetId:          pulumi.String("string"),
	},
	CopyPasteEnabled:     pulumi.Bool(false),
	FileCopyEnabled:      pulumi.Bool(false),
	ShareableLinkEnabled: pulumi.Bool(false),
	Sku:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TunnelingEnabled: pulumi.Bool(false),
	VirtualNetworkId: pulumi.String("string"),
	Zones: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var bastionHostResource = new BastionHost("bastionHostResource", BastionHostArgs.builder()
    .resourceGroupName("string")
    .scaleUnits(0)
    .sessionRecordingEnabled(false)
    .ipConnectEnabled(false)
    .kerberosEnabled(false)
    .location("string")
    .name("string")
    .ipConfiguration(BastionHostIpConfigurationArgs.builder()
        .name("string")
        .publicIpAddressId("string")
        .subnetId("string")
        .build())
    .copyPasteEnabled(false)
    .fileCopyEnabled(false)
    .shareableLinkEnabled(false)
    .sku("string")
    .tags(Map.of("string", "string"))
    .tunnelingEnabled(false)
    .virtualNetworkId("string")
    .zones("string")
    .build());
Copy
bastion_host_resource = azure.compute.BastionHost("bastionHostResource",
    resource_group_name="string",
    scale_units=0,
    session_recording_enabled=False,
    ip_connect_enabled=False,
    kerberos_enabled=False,
    location="string",
    name="string",
    ip_configuration={
        "name": "string",
        "public_ip_address_id": "string",
        "subnet_id": "string",
    },
    copy_paste_enabled=False,
    file_copy_enabled=False,
    shareable_link_enabled=False,
    sku="string",
    tags={
        "string": "string",
    },
    tunneling_enabled=False,
    virtual_network_id="string",
    zones=["string"])
Copy
const bastionHostResource = new azure.compute.BastionHost("bastionHostResource", {
    resourceGroupName: "string",
    scaleUnits: 0,
    sessionRecordingEnabled: false,
    ipConnectEnabled: false,
    kerberosEnabled: false,
    location: "string",
    name: "string",
    ipConfiguration: {
        name: "string",
        publicIpAddressId: "string",
        subnetId: "string",
    },
    copyPasteEnabled: false,
    fileCopyEnabled: false,
    shareableLinkEnabled: false,
    sku: "string",
    tags: {
        string: "string",
    },
    tunnelingEnabled: false,
    virtualNetworkId: "string",
    zones: ["string"],
});
Copy
type: azure:compute:BastionHost
properties:
    copyPasteEnabled: false
    fileCopyEnabled: false
    ipConfiguration:
        name: string
        publicIpAddressId: string
        subnetId: string
    ipConnectEnabled: false
    kerberosEnabled: false
    location: string
    name: string
    resourceGroupName: string
    scaleUnits: 0
    sessionRecordingEnabled: false
    shareableLinkEnabled: false
    sku: string
    tags:
        string: string
    tunnelingEnabled: false
    virtualNetworkId: string
    zones:
        - string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

IpConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
IpConnectEnabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

KerberosEnabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

SessionRecordingEnabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

ShareableLinkEnabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

Sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

VirtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
Zones Changes to this property will trigger replacement. List<string>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

IpConfiguration Changes to this property will trigger replacement. BastionHostIpConfigurationArgs
A ip_configuration block as defined below. Changing this forces a new resource to be created.
IpConnectEnabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

KerberosEnabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

SessionRecordingEnabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

ShareableLinkEnabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

Sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

VirtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
Zones Changes to this property will trigger replacement. []string
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled Boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled Boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled Boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled Boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku String

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. String
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. List<String>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. string[]
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ip_configuration Changes to this property will trigger replacement. BastionHostIpConfigurationArgs
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ip_connect_enabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberos_enabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

session_recording_enabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareable_link_enabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku str

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtual_network_id Changes to this property will trigger replacement. str
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. Sequence[str]
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the Bastion Host. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. Property Map
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled Boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled Boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled Boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled Boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku String

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. String
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. List<String>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.

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,
        kerberos_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        scale_units: Optional[int] = None,
        session_recording_enabled: Optional[bool] = None,
        shareable_link_enabled: Optional[bool] = None,
        sku: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tunneling_enabled: Optional[bool] = None,
        virtual_network_id: Optional[str] = None,
        zones: Optional[Sequence[str]] = 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

IpConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
IpConnectEnabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

KerberosEnabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

SessionRecordingEnabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

ShareableLinkEnabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

Sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

VirtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
Zones Changes to this property will trigger replacement. List<string>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

IpConfiguration Changes to this property will trigger replacement. BastionHostIpConfigurationArgs
A ip_configuration block as defined below. Changing this forces a new resource to be created.
IpConnectEnabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

KerberosEnabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

Location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

SessionRecordingEnabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

ShareableLinkEnabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

Sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

VirtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
Zones Changes to this property will trigger replacement. []string
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled Boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled Boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled Boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled Boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku String

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. String
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. List<String>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. BastionHostIpConfiguration
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. string
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku string

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. string
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. string[]
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ip_configuration Changes to this property will trigger replacement. BastionHostIpConfigurationArgs
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ip_connect_enabled bool

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberos_enabled bool

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. str
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

session_recording_enabled bool

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareable_link_enabled bool

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku str

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtual_network_id Changes to this property will trigger replacement. str
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. Sequence[str]
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.
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.

Note: file_copy_enabled is only supported when sku is Standard or Premium.

ipConfiguration Changes to this property will trigger replacement. Property Map
A ip_configuration block as defined below. Changing this forces a new resource to be created.
ipConnectEnabled Boolean

Is IP Connect feature enabled for the Bastion Host. Defaults to false.

Note: ip_connect_enabled is only supported when sku is Standard or Premium.

kerberosEnabled Boolean

Is Kerberos authentication feature enabled for the Bastion Host. Defaults to false.

Note: kerberos_enabled is only supported when sku is Standard or Premium.

location Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. String
Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create 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.

Note: scale_units only can be changed when sku is Standard or Premium. scale_units is always 2 when sku is Basic.

sessionRecordingEnabled Boolean

Is Session Recording feature enabled for the Bastion Host. Defaults to false.

Note: session_recording_enabled is only supported when sku is Premium.

shareableLinkEnabled Boolean

Is Shareable Link feature enabled for the Bastion Host. Defaults to false.

Note: shareable_link_enabled is only supported when sku is Standard or Premium.

sku String

The SKU of the Bastion Host. Accepted values are Developer, Basic, Standard and Premium. Defaults to Basic.

Note Downgrading the SKU will force a new resource to be created.

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.

Note: tunneling_enabled is only supported when sku is Standard or Premium.

virtualNetworkId Changes to this property will trigger replacement. String
The ID of the Virtual Network for the Developer Bastion Host. Changing this forces a new resource to be created.
zones Changes to this property will trigger replacement. List<String>
Specifies a list of Availability Zones in which this Public Bastion Host should be located. Changing this forces a new resource to be created.

Supporting Types

BastionHostIpConfiguration
, BastionHostIpConfigurationArgs

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the IP configuration. Changing this forces a new resource to be created.
PublicIpAddressId
This property is required.
Changes to this property will trigger replacement.
string
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the IP configuration. Changing this forces a new resource to be created.
PublicIpAddressId
This property is required.
Changes to this property will trigger replacement.
string
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
SubnetId
This property is required.
Changes to this property will trigger replacement.
string

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

name
This property is required.
Changes to this property will trigger replacement.
String
The name of the IP configuration. Changing this forces a new resource to be created.
publicIpAddressId
This property is required.
Changes to this property will trigger replacement.
String
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
String

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

name
This property is required.
Changes to this property will trigger replacement.
string
The name of the IP configuration. Changing this forces a new resource to be created.
publicIpAddressId
This property is required.
Changes to this property will trigger replacement.
string
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
string

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

name
This property is required.
Changes to this property will trigger replacement.
str
The name of the IP configuration. Changing this forces a new resource to be created.
public_ip_address_id
This property is required.
Changes to this property will trigger replacement.
str
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
subnet_id
This property is required.
Changes to this property will trigger replacement.
str

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

name
This property is required.
Changes to this property will trigger replacement.
String
The name of the IP configuration. Changing this forces a new resource to be created.
publicIpAddressId
This property is required.
Changes to this property will trigger replacement.
String
Reference to a Public IP Address to associate with this Bastion Host. Changing this forces a new resource to be created.
subnetId
This property is required.
Changes to this property will trigger replacement.
String

Reference to a subnet in which this Bastion Host has been created. Changing this forces a new resource to be created.

Note: The Subnet used for the Bastion Host must have the name AzureBastionSubnet and the subnet mask must be at least a /26.

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
Copy

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.