bastion_hosts

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

Overview

Name	bastion_hosts
Type	Resource
Id	azure.network.bastion_hosts

Fields

vw_bastion_hosts

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
bastionHostName	text	field from the properties object
disable_copy_paste	text	field from the properties object
dns_name	text	field from the properties object
enable_file_copy	text	field from the properties object
enable_ip_connect	text	field from the properties object
enable_kerberos	text	field from the properties object
enable_session_recording	text	field from the properties object
enable_shareable_link	text	field from the properties object
enable_tunneling	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
ip_configurations	text	field from the properties object
location	text	Resource location.
network_acls	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
scale_units	text	field from the properties object
sku	text	The sku of this Bastion Host.
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_network	text	field from the properties object
zones	text	A list of availability zones denoting where the resource needs to come from.

bastion_hosts

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the Bastion Host.
sku	object	The sku of this Bastion Host.
tags	object	Resource tags.
type	string	Resource type.
zones	array	A list of availability zones denoting where the resource needs to come from.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	bastionHostName, resourceGroupName, subscriptionId	Gets the specified Bastion Host.
list	SELECT	subscriptionId	Lists all Bastion Hosts in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all Bastion Hosts in a resource group.
create_or_update	INSERT	bastionHostName, resourceGroupName, subscriptionId	Creates or updates the specified Bastion Host.
delete	DELETE	bastionHostName, resourceGroupName, subscriptionId	Deletes the specified Bastion Host.
update_tags	EXEC	bastionHostName, resourceGroupName, subscriptionId	Updates Tags for BastionHost resource

SELECT examples

Lists all Bastion Hosts in a subscription.

vw_bastion_hosts

SELECT
id,
name,
bastionHostName,
disable_copy_paste,
dns_name,
enable_file_copy,
enable_ip_connect,
enable_kerberos,
enable_session_recording,
enable_shareable_link,
enable_tunneling,
etag,
ip_configurations,
location,
network_acls,
provisioning_state,
resourceGroupName,
scale_units,
sku,
subscriptionId,
tags,
type,
virtual_network,
zones
FROM azure.network.vw_bastion_hosts
WHERE subscriptionId = '{{ subscriptionId }}';

bastion_hosts

SELECT
id,
name,
etag,
location,
properties,
sku,
tags,
type,
zones
FROM azure.network.bastion_hosts
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new bastion_hosts resource.

All Properties

/*+ create */
INSERT INTO azure.network.bastion_hosts (
bastionHostName,
resourceGroupName,
subscriptionId,
properties,
zones,
sku,
id,
location,
tags
)
SELECT 
'{{ bastionHostName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ zones }}',
'{{ sku }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: ipConfigurations
          value:
            - - name: properties
                value:
                  - name: subnet
                    value:
                      - name: id
                        value: string
                  - name: provisioningState
                    value: []
                  - name: privateIPAllocationMethod
                    value: []
              - name: name
                value: string
              - name: etag
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: dnsName
          value: string
        - name: networkAcls
          value: string
        - name: scaleUnits
          value: integer
        - name: disableCopyPaste
          value: boolean
        - name: enableFileCopy
          value: boolean
        - name: enableIpConnect
          value: boolean
        - name: enableShareableLink
          value: boolean
        - name: enableTunneling
          value: boolean
        - name: enableKerberos
          value: boolean
        - name: enableSessionRecording
          value: boolean
    - name: zones
      value:
        - string
    - name: etag
      value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object

DELETE example

Deletes the specified bastion_hosts resource.

/*+ delete */
DELETE FROM azure.network.bastion_hosts
WHERE bastionHostName = '{{ bastionHostName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';