Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. network
  5. getBastionHost
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.getBastionHost

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the specified Bastion Host.

Uses Azure REST API version 2024-05-01.

Other available API versions: 2019-04-01, 2019-06-01, 2019-07-01, 2019-08-01, 2019-09-01, 2019-11-01, 2019-12-01, 2020-03-01, 2020-04-01, 2020-05-01, 2020-06-01, 2020-07-01, 2020-08-01, 2020-11-01, 2021-02-01, 2021-03-01, 2021-05-01, 2021-08-01, 2022-01-01, 2022-05-01, 2022-07-01, 2022-09-01, 2022-11-01, 2023-02-01, 2023-04-01, 2023-05-01, 2023-06-01, 2023-09-01, 2023-11-01, 2024-01-01, 2024-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native network [ApiVersion]. See the version guide for details.

Using getBastionHost

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBastionHost(args: GetBastionHostArgs, opts?: InvokeOptions): Promise<GetBastionHostResult>
function getBastionHostOutput(args: GetBastionHostOutputArgs, opts?: InvokeOptions): Output<GetBastionHostResult>
Copy
def get_bastion_host(bastion_host_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetBastionHostResult
def get_bastion_host_output(bastion_host_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetBastionHostResult]
Copy
func LookupBastionHost(ctx *Context, args *LookupBastionHostArgs, opts ...InvokeOption) (*LookupBastionHostResult, error)
func LookupBastionHostOutput(ctx *Context, args *LookupBastionHostOutputArgs, opts ...InvokeOption) LookupBastionHostResultOutput
Copy

> Note: This function is named LookupBastionHost in the Go SDK.

public static class GetBastionHost 
{
    public static Task<GetBastionHostResult> InvokeAsync(GetBastionHostArgs args, InvokeOptions? opts = null)
    public static Output<GetBastionHostResult> Invoke(GetBastionHostInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetBastionHostResult> getBastionHost(GetBastionHostArgs args, InvokeOptions options)
public static Output<GetBastionHostResult> getBastionHost(GetBastionHostArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:network:getBastionHost
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
BastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
bastion_host_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Bastion Host.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
bastionHostName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Bastion Host.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.

getBastionHost Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the bastion host resource.
Type string
Resource type.
DisableCopyPaste bool
Enable/Disable Copy/Paste feature of the Bastion Host resource.
DnsName string
FQDN for the endpoint on which bastion host is accessible.
EnableFileCopy bool
Enable/Disable File Copy feature of the Bastion Host resource.
EnableIpConnect bool
Enable/Disable IP Connect feature of the Bastion Host resource.
EnableKerberos bool
Enable/Disable Kerberos feature of the Bastion Host resource.
EnablePrivateOnlyBastion bool
Enable/Disable Private Only feature of the Bastion Host resource.
EnableSessionRecording bool
Enable/Disable Session Recording feature of the Bastion Host resource.
EnableShareableLink bool
Enable/Disable Shareable Link of the Bastion Host resource.
EnableTunneling bool
Enable/Disable Tunneling feature of the Bastion Host resource.
Id string
Resource ID.
IpConfigurations List<Pulumi.AzureNative.Network.Outputs.BastionHostIPConfigurationResponse>
IP configuration of the Bastion Host resource.
Location string
Resource location.
NetworkAcls Pulumi.AzureNative.Network.Outputs.BastionHostPropertiesFormatResponseNetworkAcls
ScaleUnits int
The scale units for the Bastion Host resource.
Sku Pulumi.AzureNative.Network.Outputs.SkuResponse
The sku of this Bastion Host.
Tags Dictionary<string, string>
Resource tags.
VirtualNetwork Pulumi.AzureNative.Network.Outputs.SubResourceResponse
Reference to an existing virtual network required for Developer Bastion Host only.
Zones List<string>
A list of availability zones denoting where the resource needs to come from.
AzureApiVersion string
The Azure API version of the resource.
Etag string
A unique read-only string that changes whenever the resource is updated.
Name string
Resource name.
ProvisioningState string
The provisioning state of the bastion host resource.
Type string
Resource type.
DisableCopyPaste bool
Enable/Disable Copy/Paste feature of the Bastion Host resource.
DnsName string
FQDN for the endpoint on which bastion host is accessible.
EnableFileCopy bool
Enable/Disable File Copy feature of the Bastion Host resource.
EnableIpConnect bool
Enable/Disable IP Connect feature of the Bastion Host resource.
EnableKerberos bool
Enable/Disable Kerberos feature of the Bastion Host resource.
EnablePrivateOnlyBastion bool
Enable/Disable Private Only feature of the Bastion Host resource.
EnableSessionRecording bool
Enable/Disable Session Recording feature of the Bastion Host resource.
EnableShareableLink bool
Enable/Disable Shareable Link of the Bastion Host resource.
EnableTunneling bool
Enable/Disable Tunneling feature of the Bastion Host resource.
Id string
Resource ID.
IpConfigurations []BastionHostIPConfigurationResponse
IP configuration of the Bastion Host resource.
Location string
Resource location.
NetworkAcls BastionHostPropertiesFormatResponseNetworkAcls
ScaleUnits int
The scale units for the Bastion Host resource.
Sku SkuResponse
The sku of this Bastion Host.
Tags map[string]string
Resource tags.
VirtualNetwork SubResourceResponse
Reference to an existing virtual network required for Developer Bastion Host only.
Zones []string
A list of availability zones denoting where the resource needs to come from.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the bastion host resource.
type String
Resource type.
disableCopyPaste Boolean
Enable/Disable Copy/Paste feature of the Bastion Host resource.
dnsName String
FQDN for the endpoint on which bastion host is accessible.
enableFileCopy Boolean
Enable/Disable File Copy feature of the Bastion Host resource.
enableIpConnect Boolean
Enable/Disable IP Connect feature of the Bastion Host resource.
enableKerberos Boolean
Enable/Disable Kerberos feature of the Bastion Host resource.
enablePrivateOnlyBastion Boolean
Enable/Disable Private Only feature of the Bastion Host resource.
enableSessionRecording Boolean
Enable/Disable Session Recording feature of the Bastion Host resource.
enableShareableLink Boolean
Enable/Disable Shareable Link of the Bastion Host resource.
enableTunneling Boolean
Enable/Disable Tunneling feature of the Bastion Host resource.
id String
Resource ID.
ipConfigurations List<BastionHostIPConfigurationResponse>
IP configuration of the Bastion Host resource.
location String
Resource location.
networkAcls BastionHostPropertiesFormatResponseNetworkAcls
scaleUnits Integer
The scale units for the Bastion Host resource.
sku SkuResponse
The sku of this Bastion Host.
tags Map<String,String>
Resource tags.
virtualNetwork SubResourceResponse
Reference to an existing virtual network required for Developer Bastion Host only.
zones List<String>
A list of availability zones denoting where the resource needs to come from.
azureApiVersion string
The Azure API version of the resource.
etag string
A unique read-only string that changes whenever the resource is updated.
name string
Resource name.
provisioningState string
The provisioning state of the bastion host resource.
type string
Resource type.
disableCopyPaste boolean
Enable/Disable Copy/Paste feature of the Bastion Host resource.
dnsName string
FQDN for the endpoint on which bastion host is accessible.
enableFileCopy boolean
Enable/Disable File Copy feature of the Bastion Host resource.
enableIpConnect boolean
Enable/Disable IP Connect feature of the Bastion Host resource.
enableKerberos boolean
Enable/Disable Kerberos feature of the Bastion Host resource.
enablePrivateOnlyBastion boolean
Enable/Disable Private Only feature of the Bastion Host resource.
enableSessionRecording boolean
Enable/Disable Session Recording feature of the Bastion Host resource.
enableShareableLink boolean
Enable/Disable Shareable Link of the Bastion Host resource.
enableTunneling boolean
Enable/Disable Tunneling feature of the Bastion Host resource.
id string
Resource ID.
ipConfigurations BastionHostIPConfigurationResponse[]
IP configuration of the Bastion Host resource.
location string
Resource location.
networkAcls BastionHostPropertiesFormatResponseNetworkAcls
scaleUnits number
The scale units for the Bastion Host resource.
sku SkuResponse
The sku of this Bastion Host.
tags {[key: string]: string}
Resource tags.
virtualNetwork SubResourceResponse
Reference to an existing virtual network required for Developer Bastion Host only.
zones string[]
A list of availability zones denoting where the resource needs to come from.
azure_api_version str
The Azure API version of the resource.
etag str
A unique read-only string that changes whenever the resource is updated.
name str
Resource name.
provisioning_state str
The provisioning state of the bastion host resource.
type str
Resource type.
disable_copy_paste bool
Enable/Disable Copy/Paste feature of the Bastion Host resource.
dns_name str
FQDN for the endpoint on which bastion host is accessible.
enable_file_copy bool
Enable/Disable File Copy feature of the Bastion Host resource.
enable_ip_connect bool
Enable/Disable IP Connect feature of the Bastion Host resource.
enable_kerberos bool
Enable/Disable Kerberos feature of the Bastion Host resource.
enable_private_only_bastion bool
Enable/Disable Private Only feature of the Bastion Host resource.
enable_session_recording bool
Enable/Disable Session Recording feature of the Bastion Host resource.
enable_shareable_link bool
Enable/Disable Shareable Link of the Bastion Host resource.
enable_tunneling bool
Enable/Disable Tunneling feature of the Bastion Host resource.
id str
Resource ID.
ip_configurations Sequence[BastionHostIPConfigurationResponse]
IP configuration of the Bastion Host resource.
location str
Resource location.
network_acls BastionHostPropertiesFormatResponseNetworkAcls
scale_units int
The scale units for the Bastion Host resource.
sku SkuResponse
The sku of this Bastion Host.
tags Mapping[str, str]
Resource tags.
virtual_network SubResourceResponse
Reference to an existing virtual network required for Developer Bastion Host only.
zones Sequence[str]
A list of availability zones denoting where the resource needs to come from.
azureApiVersion String
The Azure API version of the resource.
etag String
A unique read-only string that changes whenever the resource is updated.
name String
Resource name.
provisioningState String
The provisioning state of the bastion host resource.
type String
Resource type.
disableCopyPaste Boolean
Enable/Disable Copy/Paste feature of the Bastion Host resource.
dnsName String
FQDN for the endpoint on which bastion host is accessible.
enableFileCopy Boolean
Enable/Disable File Copy feature of the Bastion Host resource.
enableIpConnect Boolean
Enable/Disable IP Connect feature of the Bastion Host resource.
enableKerberos Boolean
Enable/Disable Kerberos feature of the Bastion Host resource.
enablePrivateOnlyBastion Boolean
Enable/Disable Private Only feature of the Bastion Host resource.
enableSessionRecording Boolean
Enable/Disable Session Recording feature of the Bastion Host resource.
enableShareableLink Boolean
Enable/Disable Shareable Link of the Bastion Host resource.
enableTunneling Boolean
Enable/Disable Tunneling feature of the Bastion Host resource.
id String
Resource ID.
ipConfigurations List<Property Map>
IP configuration of the Bastion Host resource.
location String
Resource location.
networkAcls Property Map
scaleUnits Number
The scale units for the Bastion Host resource.
sku Property Map
The sku of this Bastion Host.
tags Map<String>
Resource tags.
virtualNetwork Property Map
Reference to an existing virtual network required for Developer Bastion Host only.
zones List<String>
A list of availability zones denoting where the resource needs to come from.

Supporting Types

BastionHostIPConfigurationResponse

Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the bastion host IP configuration resource.
Subnet This property is required. Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference of the subnet resource.
Type This property is required. string
Ip configuration type.
Id string
Resource ID.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateIPAllocationMethod string
Private IP allocation method.
PublicIPAddress Pulumi.AzureNative.Network.Inputs.SubResourceResponse
Reference of the PublicIP resource. Null for private only bastion
Etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
ProvisioningState This property is required. string
The provisioning state of the bastion host IP configuration resource.
Subnet This property is required. SubResourceResponse
Reference of the subnet resource.
Type This property is required. string
Ip configuration type.
Id string
Resource ID.
Name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
PrivateIPAllocationMethod string
Private IP allocation method.
PublicIPAddress SubResourceResponse
Reference of the PublicIP resource. Null for private only bastion
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the bastion host IP configuration resource.
subnet This property is required. SubResourceResponse
Reference of the subnet resource.
type This property is required. String
Ip configuration type.
id String
Resource ID.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateIPAllocationMethod String
Private IP allocation method.
publicIPAddress SubResourceResponse
Reference of the PublicIP resource. Null for private only bastion
etag This property is required. string
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. string
The provisioning state of the bastion host IP configuration resource.
subnet This property is required. SubResourceResponse
Reference of the subnet resource.
type This property is required. string
Ip configuration type.
id string
Resource ID.
name string
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateIPAllocationMethod string
Private IP allocation method.
publicIPAddress SubResourceResponse
Reference of the PublicIP resource. Null for private only bastion
etag This property is required. str
A unique read-only string that changes whenever the resource is updated.
provisioning_state This property is required. str
The provisioning state of the bastion host IP configuration resource.
subnet This property is required. SubResourceResponse
Reference of the subnet resource.
type This property is required. str
Ip configuration type.
id str
Resource ID.
name str
Name of the resource that is unique within a resource group. This name can be used to access the resource.
private_ip_allocation_method str
Private IP allocation method.
public_ip_address SubResourceResponse
Reference of the PublicIP resource. Null for private only bastion
etag This property is required. String
A unique read-only string that changes whenever the resource is updated.
provisioningState This property is required. String
The provisioning state of the bastion host IP configuration resource.
subnet This property is required. Property Map
Reference of the subnet resource.
type This property is required. String
Ip configuration type.
id String
Resource ID.
name String
Name of the resource that is unique within a resource group. This name can be used to access the resource.
privateIPAllocationMethod String
Private IP allocation method.
publicIPAddress Property Map
Reference of the PublicIP resource. Null for private only bastion

BastionHostPropertiesFormatResponseNetworkAcls

IpRules List<Pulumi.AzureNative.Network.Inputs.IPRuleResponse>
Sets the IP ACL rules for Developer Bastion Host.
IpRules []IPRuleResponse
Sets the IP ACL rules for Developer Bastion Host.
ipRules List<IPRuleResponse>
Sets the IP ACL rules for Developer Bastion Host.
ipRules IPRuleResponse[]
Sets the IP ACL rules for Developer Bastion Host.
ip_rules Sequence[IPRuleResponse]
Sets the IP ACL rules for Developer Bastion Host.
ipRules List<Property Map>
Sets the IP ACL rules for Developer Bastion Host.

IPRuleResponse

AddressPrefix string
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
AddressPrefix string
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
addressPrefix String
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
addressPrefix string
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
address_prefix str
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.
addressPrefix String
Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.

SkuResponse

Name string
The name of the sku of this Bastion Host.
Name string
The name of the sku of this Bastion Host.
name String
The name of the sku of this Bastion Host.
name string
The name of the sku of this Bastion Host.
name str
The name of the sku of this Bastion Host.
name String
The name of the sku of this Bastion Host.

SubResourceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native