BastionHost

Manages a Bastion Host.

Note: Bastion Hosts are a preview feature in Azure, and therefore are only supported in a select number of regions. Read more.

Create a BastionHost Resource

new BastionHost(name: string, args: BastionHostArgs, opts?: CustomResourceOptions);

def BastionHost(resource_name, opts=None, ip_configuration=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

func NewBastionHost(ctx *Context, name string, args BastionHostArgs, opts ...ResourceOption) (*BastionHost, error)

public BastionHost(string name, BastionHostArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

BastionHost Resource Properties

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

Inputs

The BastionHost resource accepts the following input properties:

ResourceGroupName string: The name of the resource group in which to create the Bastion Host.
IpConfiguration BastionHostIpConfigurationArgs: A ip_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

ResourceGroupName string: The name of the resource group in which to create the Bastion Host.
IpConfiguration BastionHostIpConfiguration: A ip_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

resourceGroupName string: The name of the resource group in which to create the Bastion Host.
ipConfiguration BastionHostIpConfiguration: A ip_configuration block as defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

resource_group_name str: The name of the resource group in which to create the Bastion Host.
ip_configuration Dict[BastionHostIpConfiguration]: A ip_configuration block as defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Bastion Host. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.

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.

dns_name str: The FQDN for the Bastion Host.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, dns_name=None, ip_configuration=None, location=None, name=None, resource_group_name=None, tags=None, __props__=None);

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)

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.

The following state arguments are supported:

DnsName string: The FQDN for the Bastion Host.
IpConfiguration BastionHostIpConfigurationArgs: A ip_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
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.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

DnsName string: The FQDN for the Bastion Host.
IpConfiguration BastionHostIpConfiguration: A ip_configuration block as defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
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.
Tags map[string]string: A mapping of tags to assign to the resource.

dnsName string: The FQDN for the Bastion Host.
ipConfiguration BastionHostIpConfiguration: A ip_configuration block as defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
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.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

dns_name str: The FQDN for the Bastion Host.
ip_configuration Dict[BastionHostIpConfiguration]: A ip_configuration block as defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
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.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Supporting Types

BastionHostIpConfiguration

See the input and output API doc for this type.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud