virtual_network_taps

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

Overview

Name	virtual_network_taps
Type	Resource
Id	azure.network.virtual_network_taps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
destinationLoadBalancerFrontEndIPConfiguration	object	Frontend IP address of the load balancer.
destinationNetworkInterfaceIPConfiguration	object	IPConfiguration in a network interface.
destinationPort	integer	The VXLAN destination port that will receive the tapped traffic.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
networkInterfaceTapConfigurations	array	Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.
provisioningState	string	The provisioning state of the virtual network tap resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network tap resource.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
destinationLoadBalancerFrontEndIPConfiguration	object	Frontend IP address of the load balancer.
destinationNetworkInterfaceIPConfiguration	object	IPConfiguration in a network interface.
destinationPort	integer	The VXLAN destination port that will receive the tapped traffic.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
networkInterfaceTapConfigurations	array	Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.
provisioningState	string	The provisioning state of the virtual network tap resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network tap resource.
tags	object	Resource tags.
type	string	Resource type.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
destinationLoadBalancerFrontEndIPConfiguration	object	Frontend IP address of the load balancer.
destinationNetworkInterfaceIPConfiguration	object	IPConfiguration in a network interface.
destinationPort	integer	The VXLAN destination port that will receive the tapped traffic.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
networkInterfaceTapConfigurations	array	Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped.
provisioningState	string	The provisioning state of the virtual network tap resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the virtual network tap resource.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, tap_name, subscription_id		Get a VirtualNetworkTap.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the VirtualNetworkTaps in a subscription.
list_all	select	subscription_id		Gets all the VirtualNetworkTaps in a subscription.
create_or_update	insert	resource_group_name, tap_name, subscription_id		Create a VirtualNetworkTap.
update_tags	update	resource_group_name, tap_name, subscription_id		Update a VirtualNetworkTap.
create_or_update	replace	resource_group_name, tap_name, subscription_id		Create a VirtualNetworkTap.
delete	delete	resource_group_name, tap_name, subscription_id		Delete a VirtualNetworkTap.

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
tap_name	string	The name of virtual network tap. Required.

SELECT examples

get

Get a VirtualNetworkTap.

SELECT
id,
name,
destinationLoadBalancerFrontEndIPConfiguration,
destinationNetworkInterfaceIPConfiguration,
destinationPort,
etag,
location,
networkInterfaceTapConfigurations,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.virtual_network_taps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND tap_name = '{{ tap_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the VirtualNetworkTaps in a subscription.

SELECT
id,
name,
destinationLoadBalancerFrontEndIPConfiguration,
destinationNetworkInterfaceIPConfiguration,
destinationPort,
etag,
location,
networkInterfaceTapConfigurations,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.virtual_network_taps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all the VirtualNetworkTaps in a subscription.

SELECT
id,
name,
destinationLoadBalancerFrontEndIPConfiguration,
destinationNetworkInterfaceIPConfiguration,
destinationPort,
etag,
location,
networkInterfaceTapConfigurations,
provisioningState,
resourceGuid,
tags,
type
FROM azure.network.virtual_network_taps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a VirtualNetworkTap.

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

Manifest

# Description fields are for documentation purposes
- name: virtual_network_taps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_network_taps resource.
  - name: tap_name
    value: "{{ tap_name }}"
    description: Required parameter for the virtual_network_taps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_network_taps 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: |
      Virtual Network Tap Properties.
    value:
      networkInterfaceTapConfigurations:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            virtualNetworkTap:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                networkInterfaceTapConfigurations: "{{ networkInterfaceTapConfigurations }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                destinationNetworkInterfaceIPConfiguration: "{{ destinationNetworkInterfaceIPConfiguration }}"
                destinationLoadBalancerFrontEndIPConfiguration: "{{ destinationLoadBalancerFrontEndIPConfiguration }}"
                destinationPort: {{ destinationPort }}
              etag: "{{ etag }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      destinationNetworkInterfaceIPConfiguration:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        properties:
          gatewayLoadBalancer:
            id: "{{ id }}"
          virtualNetworkTaps:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                networkInterfaceTapConfigurations: "{{ networkInterfaceTapConfigurations }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
                destinationNetworkInterfaceIPConfiguration: "{{ destinationNetworkInterfaceIPConfiguration }}"
                destinationLoadBalancerFrontEndIPConfiguration: "{{ destinationLoadBalancerFrontEndIPConfiguration }}"
                destinationPort: {{ destinationPort }}
              etag: "{{ etag }}"
          applicationGatewayBackendAddressPools:
            - id: "{{ id }}"
              properties:
                backendIPConfigurations: "{{ backendIPConfigurations }}"
                backendAddresses: "{{ backendAddresses }}"
                provisioningState: "{{ provisioningState }}"
              name: "{{ name }}"
              etag: "{{ etag }}"
              type: "{{ type }}"
          loadBalancerBackendAddressPools:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                location: "{{ location }}"
                tunnelInterfaces: "{{ tunnelInterfaces }}"
                loadBalancerBackendAddresses: "{{ loadBalancerBackendAddresses }}"
                backendIPConfigurations: "{{ backendIPConfigurations }}"
                loadBalancingRules: "{{ loadBalancingRules }}"
                outboundRule: "{{ outboundRule }}"
                outboundRules: "{{ outboundRules }}"
                inboundNatRules: "{{ inboundNatRules }}"
                provisioningState: "{{ provisioningState }}"
                drainPeriodInSeconds: {{ drainPeriodInSeconds }}
                virtualNetwork: "{{ virtualNetwork }}"
                syncMode: "{{ syncMode }}"
              etag: "{{ etag }}"
          loadBalancerInboundNatRules:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                frontendIPConfiguration: "{{ frontendIPConfiguration }}"
                backendIPConfiguration: "{{ backendIPConfiguration }}"
                protocol: "{{ protocol }}"
                frontendPort: {{ frontendPort }}
                backendPort: {{ backendPort }}
                idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
                enableFloatingIP: {{ enableFloatingIP }}
                enableTcpReset: {{ enableTcpReset }}
                frontendPortRangeStart: {{ frontendPortRangeStart }}
                frontendPortRangeEnd: {{ frontendPortRangeEnd }}
                backendAddressPool: "{{ backendAddressPool }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          privateIPAddress: "{{ privateIPAddress }}"
          privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
          privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
          privateIPAddressVersion: "{{ privateIPAddressVersion }}"
          subnet:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            properties:
              addressPrefix: "{{ addressPrefix }}"
              addressPrefixes: "{{ addressPrefixes }}"
              networkSecurityGroup: "{{ networkSecurityGroup }}"
              routeTable: "{{ routeTable }}"
              natGateway: "{{ natGateway }}"
              serviceEndpoints: "{{ serviceEndpoints }}"
              serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
              privateEndpoints: "{{ privateEndpoints }}"
              ipConfigurations: "{{ ipConfigurations }}"
              ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
              ipAllocations: "{{ ipAllocations }}"
              resourceNavigationLinks: "{{ resourceNavigationLinks }}"
              serviceAssociationLinks: "{{ serviceAssociationLinks }}"
              delegations: "{{ delegations }}"
              purpose: "{{ purpose }}"
              provisioningState: "{{ provisioningState }}"
              privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
              privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
              applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
              sharingScope: "{{ sharingScope }}"
              defaultOutboundAccess: {{ defaultOutboundAccess }}
              ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
              serviceGateway: "{{ serviceGateway }}"
            etag: "{{ etag }}"
          primary: {{ primary }}
          publicIPAddress:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
              publicIPAddressVersion: "{{ publicIPAddressVersion }}"
              ipConfiguration: "{{ ipConfiguration }}"
              dnsSettings: "{{ dnsSettings }}"
              ddosSettings: "{{ ddosSettings }}"
              ipTags: "{{ ipTags }}"
              ipAddress: "{{ ipAddress }}"
              publicIPPrefix: "{{ publicIPPrefix }}"
              idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
              servicePublicIPAddress: "{{ servicePublicIPAddress }}"
              natGateway: "{{ natGateway }}"
              migrationPhase: "{{ migrationPhase }}"
              linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
              deleteOption: "{{ deleteOption }}"
            extendedLocation:
              name: "{{ name }}"
              type: "{{ type }}"
            sku:
              name: "{{ name }}"
              tier: "{{ tier }}"
            etag: "{{ etag }}"
            zones:
              - "{{ zones }}"
          applicationSecurityGroups:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          provisioningState: "{{ provisioningState }}"
          privateLinkConnectionProperties:
            groupId: "{{ groupId }}"
            requiredMemberName: "{{ requiredMemberName }}"
            fqdns:
              - "{{ fqdns }}"
        etag: "{{ etag }}"
      destinationLoadBalancerFrontEndIPConfiguration:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        properties:
          inboundNatRules:
            - id: "{{ id }}"
          inboundNatPools:
            - id: "{{ id }}"
          outboundRules:
            - id: "{{ id }}"
          loadBalancingRules:
            - id: "{{ id }}"
          privateIPAddress: "{{ privateIPAddress }}"
          privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
          privateIPAddressVersion: "{{ privateIPAddressVersion }}"
          subnet:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            properties:
              addressPrefix: "{{ addressPrefix }}"
              addressPrefixes: "{{ addressPrefixes }}"
              networkSecurityGroup: "{{ networkSecurityGroup }}"
              routeTable: "{{ routeTable }}"
              natGateway: "{{ natGateway }}"
              serviceEndpoints: "{{ serviceEndpoints }}"
              serviceEndpointPolicies: "{{ serviceEndpointPolicies }}"
              privateEndpoints: "{{ privateEndpoints }}"
              ipConfigurations: "{{ ipConfigurations }}"
              ipConfigurationProfiles: "{{ ipConfigurationProfiles }}"
              ipAllocations: "{{ ipAllocations }}"
              resourceNavigationLinks: "{{ resourceNavigationLinks }}"
              serviceAssociationLinks: "{{ serviceAssociationLinks }}"
              delegations: "{{ delegations }}"
              purpose: "{{ purpose }}"
              provisioningState: "{{ provisioningState }}"
              privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
              privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
              applicationGatewayIPConfigurations: "{{ applicationGatewayIPConfigurations }}"
              sharingScope: "{{ sharingScope }}"
              defaultOutboundAccess: {{ defaultOutboundAccess }}
              ipamPoolPrefixAllocations: "{{ ipamPoolPrefixAllocations }}"
              serviceGateway: "{{ serviceGateway }}"
            etag: "{{ etag }}"
          publicIPAddress:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            location: "{{ location }}"
            tags: "{{ tags }}"
            properties:
              publicIPAllocationMethod: "{{ publicIPAllocationMethod }}"
              publicIPAddressVersion: "{{ publicIPAddressVersion }}"
              ipConfiguration: "{{ ipConfiguration }}"
              dnsSettings: "{{ dnsSettings }}"
              ddosSettings: "{{ ddosSettings }}"
              ipTags: "{{ ipTags }}"
              ipAddress: "{{ ipAddress }}"
              publicIPPrefix: "{{ publicIPPrefix }}"
              idleTimeoutInMinutes: {{ idleTimeoutInMinutes }}
              resourceGuid: "{{ resourceGuid }}"
              provisioningState: "{{ provisioningState }}"
              servicePublicIPAddress: "{{ servicePublicIPAddress }}"
              natGateway: "{{ natGateway }}"
              migrationPhase: "{{ migrationPhase }}"
              linkedPublicIPAddress: "{{ linkedPublicIPAddress }}"
              deleteOption: "{{ deleteOption }}"
            extendedLocation:
              name: "{{ name }}"
              type: "{{ type }}"
            sku:
              name: "{{ name }}"
              tier: "{{ tier }}"
            etag: "{{ etag }}"
            zones:
              - "{{ zones }}"
          publicIPPrefix:
            id: "{{ id }}"
          gatewayLoadBalancer:
            id: "{{ id }}"
          provisioningState: "{{ provisioningState }}"
          ddosSettings:
            ddosCustomPolicy:
              id: "{{ id }}"
        etag: "{{ etag }}"
        zones:
          - "{{ zones }}"
      destinationPort: {{ destinationPort }}

UPDATE examples

update_tags

Update a VirtualNetworkTap.

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

REPLACE examples

create_or_update

Create a VirtualNetworkTap.

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

DELETE examples

delete

Delete a VirtualNetworkTap.

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