vpn_sites

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

Overview

Name	vpn_sites
Type	Resource
Id	azure.network.vpn_sites

Fields

vw_vpn_sites

Name	Datatype	Description
id	text	Resource ID.
name	text	Resource name.
address_space	text	field from the properties object
bgp_properties	text	field from the properties object
device_properties	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
ip_address	text	field from the properties object
is_security_site	text	field from the properties object
location	text	Resource location.
o365_policy	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
site_key	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
type	text	Resource type.
virtual_wan	text	field from the properties object
vpnSiteName	text	field from the properties object
vpn_site_links	text	field from the properties object

vpn_sites

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	Parameters for VpnSite.
tags	object	Resource tags.
type	string	Resource type.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, vpnSiteName	Retrieves the details of a VPN site.
list	SELECT	subscriptionId	Lists all the VpnSites in a subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Lists all the vpnSites in a resource group.
create_or_update	INSERT	resourceGroupName, subscriptionId, vpnSiteName, data__location	Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
delete	DELETE	resourceGroupName, subscriptionId, vpnSiteName	Deletes a VpnSite.
update_tags	EXEC	resourceGroupName, subscriptionId, vpnSiteName	Updates VpnSite tags.

SELECT examples

Lists all the VpnSites in a subscription.

vw_vpn_sites

SELECT
id,
name,
address_space,
bgp_properties,
device_properties,
etag,
ip_address,
is_security_site,
location,
o365_policy,
provisioning_state,
resourceGroupName,
site_key,
subscriptionId,
tags,
type,
virtual_wan,
vpnSiteName,
vpn_site_links
FROM azure.network.vw_vpn_sites
WHERE subscriptionId = '{{ subscriptionId }}';

vpn_sites

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.network.vpn_sites (
resourceGroupName,
subscriptionId,
vpnSiteName,
data__location,
properties,
id,
location,
tags
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vpnSiteName }}',
'{{ data__location }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: virtualWan
          value:
            - name: id
              value: string
        - name: deviceProperties
          value:
            - name: deviceVendor
              value: string
            - name: deviceModel
              value: string
            - name: linkSpeedInMbps
              value: integer
        - name: ipAddress
          value: string
        - name: siteKey
          value: string
        - name: addressSpace
          value:
            - name: addressPrefixes
              value:
                - string
        - name: bgpProperties
          value:
            - name: asn
              value: integer
            - name: bgpPeeringAddress
              value: string
            - name: peerWeight
              value: integer
            - name: bgpPeeringAddresses
              value:
                - - name: ipconfigurationId
                    value: string
                  - name: defaultBgpIpAddresses
                    value:
                      - string
                  - name: customBgpIpAddresses
                    value:
                      - string
                  - name: tunnelIpAddresses
                    value:
                      - string
        - name: provisioningState
          value: []
        - name: isSecuritySite
          value: boolean
        - name: vpnSiteLinks
          value:
            - - name: properties
                value:
                  - name: linkProperties
                    value:
                      - name: linkProviderName
                        value: string
                      - name: linkSpeedInMbps
                        value: integer
                  - name: ipAddress
                    value: string
                  - name: fqdn
                    value: string
                  - name: bgpProperties
                    value:
                      - name: asn
                        value: integer
                      - name: bgpPeeringAddress
                        value: string
              - name: etag
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: id
                value: string
        - name: o365Policy
          value:
            - name: breakOutCategories
              value:
                - name: allow
                  value: boolean
                - name: optimize
                  value: boolean
                - name: default
                  value: boolean
    - name: etag
      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 vpn_sites resource.

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