bastion_hosts

Creates, updates, deletes, gets or lists a bastion_hosts resource.

Overview

Name	bastion_hosts
Type	Resource
Id	azure.network.bastion_hosts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
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.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	IP configuration of the Bastion Host resource.
location	string	Resource location.
networkAcls	object	:vartype network_acls: ~azure.mgmt.network.models.BastionHostPropertiesFormatNetworkAcls
provisioningState	string	The provisioning state of the bastion host resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
scaleUnits	integer	The scale units for the Bastion Host resource.
sku	object	The sku of this Bastion Host.
tags	object	Resource tags.
type	string	Resource type.
virtualNetwork	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
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.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	IP configuration of the Bastion Host resource.
location	string	Resource location.
networkAcls	object	:vartype network_acls: ~azure.mgmt.network.models.BastionHostPropertiesFormatNetworkAcls
provisioningState	string	The provisioning state of the bastion host resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
scaleUnits	integer	The scale units for the Bastion Host resource.
sku	object	The sku of this Bastion Host.
tags	object	Resource tags.
type	string	Resource type.
virtualNetwork	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
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.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipConfigurations	array	IP configuration of the Bastion Host resource.
location	string	Resource location.
networkAcls	object	:vartype network_acls: ~azure.mgmt.network.models.BastionHostPropertiesFormatNetworkAcls
provisioningState	string	The provisioning state of the bastion host resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
scaleUnits	integer	The scale units for the Bastion Host resource.
sku	object	The sku of this Bastion Host.
tags	object	Resource tags.
type	string	Resource type.
virtualNetwork	object	Reference to another subresource.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, bastion_host_name, subscription_id		Gets the specified Bastion Host.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all Bastion Hosts in a resource group.
list	select	subscription_id		Lists all Bastion Hosts in a subscription.
create_or_update	insert	resource_group_name, bastion_host_name, subscription_id		Creates or updates the specified Bastion Host.
update_tags	update	resource_group_name, bastion_host_name, subscription_id		Updates Tags for BastionHost resource.
create_or_update	replace	resource_group_name, bastion_host_name, subscription_id		Creates or updates the specified Bastion Host.
delete	delete	resource_group_name, bastion_host_name, subscription_id		Deletes the specified Bastion Host.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bastion_host_name	string	The name of the Bastion Host. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified Bastion Host.

SELECT
id,
name,
disableCopyPaste,
dnsName,
enableFileCopy,
enableIpConnect,
enableKerberos,
enablePrivateOnlyBastion,
enableSessionRecording,
enableShareableLink,
enableTunneling,
etag,
ipConfigurations,
location,
networkAcls,
provisioningState,
scaleUnits,
sku,
tags,
type,
virtualNetwork,
zones
FROM azure.network.bastion_hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND bastion_host_name = '{{ bastion_host_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all Bastion Hosts in a resource group.

SELECT
id,
name,
disableCopyPaste,
dnsName,
enableFileCopy,
enableIpConnect,
enableKerberos,
enablePrivateOnlyBastion,
enableSessionRecording,
enableShareableLink,
enableTunneling,
etag,
ipConfigurations,
location,
networkAcls,
provisioningState,
scaleUnits,
sku,
tags,
type,
virtualNetwork,
zones
FROM azure.network.bastion_hosts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Bastion Hosts in a subscription.

SELECT
id,
name,
disableCopyPaste,
dnsName,
enableFileCopy,
enableIpConnect,
enableKerberos,
enablePrivateOnlyBastion,
enableSessionRecording,
enableShareableLink,
enableTunneling,
etag,
ipConfigurations,
location,
networkAcls,
provisioningState,
scaleUnits,
sku,
tags,
type,
virtualNetwork,
zones
FROM azure.network.bastion_hosts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Bastion Host.

INSERT INTO azure.network.bastion_hosts (
id,
location,
tags,
properties,
zones,
sku,
resource_group_name,
bastion_host_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ zones }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ bastion_host_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: bastion_hosts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bastion_hosts resource.
  - name: bastion_host_name
    value: "{{ bastion_host_name }}"
    description: Required parameter for the bastion_hosts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bastion_hosts resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Represents the bastion host resource.
    value:
      ipConfigurations:
        - id: "{{ id }}"
          properties:
            subnet:
              id: "{{ id }}"
            publicIPAddress:
              id: "{{ id }}"
            provisioningState: "{{ provisioningState }}"
            privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
          name: "{{ name }}"
          etag: "{{ etag }}"
          type: "{{ type }}"
      dnsName: "{{ dnsName }}"
      virtualNetwork:
        id: "{{ id }}"
      networkAcls:
        ipRules:
          - addressPrefix: "{{ addressPrefix }}"
      provisioningState: "{{ provisioningState }}"
      scaleUnits: {{ scaleUnits }}
      disableCopyPaste: {{ disableCopyPaste }}
      enableFileCopy: {{ enableFileCopy }}
      enableIpConnect: {{ enableIpConnect }}
      enableShareableLink: {{ enableShareableLink }}
      enableTunneling: {{ enableTunneling }}
      enableKerberos: {{ enableKerberos }}
      enableSessionRecording: {{ enableSessionRecording }}
      enablePrivateOnlyBastion: {{ enablePrivateOnlyBastion }}
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      A list of availability zones denoting where the resource needs to come from.
  - name: sku
    description: |
      The sku of this Bastion Host.
    value:
      name: "{{ name }}"

UPDATE examples

update_tags

Updates Tags for BastionHost resource.

UPDATE azure.network.bastion_hosts
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND bastion_host_name = '{{ bastion_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones;

REPLACE examples

create_or_update

Creates or updates the specified Bastion Host.

REPLACE azure.network.bastion_hosts
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
zones = '{{ zones }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND bastion_host_name = '{{ bastion_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones;

DELETE examples

delete

Deletes the specified Bastion Host.

DELETE FROM azure.network.bastion_hosts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND bastion_host_name = '{{ bastion_host_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;