vpn_sites

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

Overview

Name	vpn_sites
Type	Resource
Id	azure.network.vpn_sites

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges.
bgpProperties	object	The set of bgp properties.
deviceProperties	object	The device properties.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipAddress	string	The ip-address for the vpn-site.
isSecuritySite	boolean	IsSecuritySite flag.
location	string	Resource location.
o365Policy	object	Office365 Policy.
provisioningState	string	The provisioning state of the VPN site resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
siteKey	string	The key for vpn-site that can be used for connections.
tags	object	Resource tags.
type	string	Resource type.
virtualWan	object	Reference to another subresource.
vpnSiteLinks	array	List of all vpn site links.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges.
bgpProperties	object	The set of bgp properties.
deviceProperties	object	The device properties.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipAddress	string	The ip-address for the vpn-site.
isSecuritySite	boolean	IsSecuritySite flag.
location	string	Resource location.
o365Policy	object	Office365 Policy.
provisioningState	string	The provisioning state of the VPN site resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
siteKey	string	The key for vpn-site that can be used for connections.
tags	object	Resource tags.
type	string	Resource type.
virtualWan	object	Reference to another subresource.
vpnSiteLinks	array	List of all vpn site links.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges.
bgpProperties	object	The set of bgp properties.
deviceProperties	object	The device properties.
etag	string	A unique read-only string that changes whenever the resource is updated.
ipAddress	string	The ip-address for the vpn-site.
isSecuritySite	boolean	IsSecuritySite flag.
location	string	Resource location.
o365Policy	object	Office365 Policy.
provisioningState	string	The provisioning state of the VPN site resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
siteKey	string	The key for vpn-site that can be used for connections.
tags	object	Resource tags.
type	string	Resource type.
virtualWan	object	Reference to another subresource.
vpnSiteLinks	array	List of all vpn site links.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, vpn_site_name, subscription_id		Retrieves the details of a VPN site.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the vpnSites in a resource group.
list	select	subscription_id		Lists all the VpnSites in a subscription.
create_or_update	insert	resource_group_name, vpn_site_name, subscription_id		Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
update_tags	update	resource_group_name, vpn_site_name, subscription_id		Updates VpnSite tags.
create_or_update	replace	resource_group_name, vpn_site_name, subscription_id		Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.
delete	delete	resource_group_name, vpn_site_name, subscription_id		Deletes a VpnSite.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vpn_site_name	string	The name of the VpnSite being retrieved. Required.

SELECT examples

get

Retrieves the details of a VPN site.

SELECT
id,
name,
addressSpace,
bgpProperties,
deviceProperties,
etag,
ipAddress,
isSecuritySite,
location,
o365Policy,
provisioningState,
siteKey,
tags,
type,
virtualWan,
vpnSiteLinks
FROM azure.network.vpn_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vpn_site_name = '{{ vpn_site_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the vpnSites in a resource group.

SELECT
id,
name,
addressSpace,
bgpProperties,
deviceProperties,
etag,
ipAddress,
isSecuritySite,
location,
o365Policy,
provisioningState,
siteKey,
tags,
type,
virtualWan,
vpnSiteLinks
FROM azure.network.vpn_sites
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all the VpnSites in a subscription.

SELECT
id,
name,
addressSpace,
bgpProperties,
deviceProperties,
etag,
ipAddress,
isSecuritySite,
location,
o365Policy,
provisioningState,
siteKey,
tags,
type,
virtualWan,
vpnSiteLinks
FROM azure.network.vpn_sites
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

INSERT INTO azure.network.vpn_sites (
id,
location,
tags,
properties,
resource_group_name,
vpn_site_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ vpn_site_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: vpn_sites
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vpn_sites resource.
  - name: vpn_site_name
    value: "{{ vpn_site_name }}"
    description: Required parameter for the vpn_sites resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vpn_sites 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: |
      Properties of the VPN site.
    value:
      virtualWan:
        id: "{{ id }}"
      deviceProperties:
        deviceVendor: "{{ deviceVendor }}"
        deviceModel: "{{ deviceModel }}"
        linkSpeedInMbps: {{ linkSpeedInMbps }}
      ipAddress: "{{ ipAddress }}"
      siteKey: "{{ siteKey }}"
      addressSpace:
        addressPrefixes:
          - "{{ addressPrefixes }}"
        ipamPoolPrefixAllocations:
          - pool:
              id: "{{ id }}"
            numberOfIpAddresses: "{{ numberOfIpAddresses }}"
            allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
      bgpProperties:
        asn: {{ asn }}
        bgpPeeringAddress: "{{ bgpPeeringAddress }}"
        peerWeight: {{ peerWeight }}
        bgpPeeringAddresses:
          - ipconfigurationId: "{{ ipconfigurationId }}"
            defaultBgpIpAddresses: "{{ defaultBgpIpAddresses }}"
            customBgpIpAddresses: "{{ customBgpIpAddresses }}"
            tunnelIpAddresses: "{{ tunnelIpAddresses }}"
      provisioningState: "{{ provisioningState }}"
      isSecuritySite: {{ isSecuritySite }}
      vpnSiteLinks:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            linkProperties:
              linkProviderName: "{{ linkProviderName }}"
              linkSpeedInMbps: {{ linkSpeedInMbps }}
            ipAddress: "{{ ipAddress }}"
            fqdn: "{{ fqdn }}"
            bgpProperties:
              asn: {{ asn }}
              bgpPeeringAddress: "{{ bgpPeeringAddress }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      o365Policy:
        breakOutCategories:
          allow: {{ allow }}
          optimize: {{ optimize }}
          default: {{ default }}

UPDATE examples

update_tags

Updates VpnSite tags.

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

REPLACE examples

create_or_update

Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.

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

DELETE examples

delete

Deletes a VpnSite.

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