interface_tap_configurations

Creates, updates, deletes, gets or lists an interface_tap_configurations resource.

Overview

Name	interface_tap_configurations
Type	Resource
Id	azure.network.interface_tap_configurations

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns a tap configuration.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Network Tap configuration.
type	string	Sub Resource type.

list

Request successful. The operation returns a list of NetworkInterface TapConfiguration resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Virtual Network Tap configuration.
type	string	Sub Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, networkInterfaceName, tapConfigurationName, subscriptionId		Get the specified tap configuration on a network interface.
list	select	resourceGroupName, networkInterfaceName, subscriptionId		Get all Tap configurations in a network interface.
create_or_update	insert	resourceGroupName, networkInterfaceName, tapConfigurationName, subscriptionId		Creates or updates a Tap configuration in the specified NetworkInterface.
delete	delete	resourceGroupName, networkInterfaceName, tapConfigurationName, subscriptionId		Deletes the specified tap configuration from the NetworkInterface.

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
networkInterfaceName	string	The name of the network interface.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
tapConfigurationName	string	The name of the tap configuration.

SELECT examples

get

Get the specified tap configuration on a network interface.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.interface_tap_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND tapConfigurationName = '{{ tapConfigurationName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Get all Tap configurations in a network interface.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.interface_tap_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkInterfaceName = '{{ networkInterfaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Tap configuration in the specified NetworkInterface.

INSERT INTO azure.network.interface_tap_configurations (
data__properties,
data__name,
data__id,
resourceGroupName,
networkInterfaceName,
tapConfigurationName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ networkInterfaceName }}',
'{{ tapConfigurationName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: interface_tap_configurations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the interface_tap_configurations resource.
    - name: networkInterfaceName
      value: string
      description: Required parameter for the interface_tap_configurations resource.
    - name: tapConfigurationName
      value: string
      description: Required parameter for the interface_tap_configurations resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the interface_tap_configurations resource.
    - name: properties
      value: object
      description: |
        Properties of the Virtual Network Tap configuration.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified tap configuration from the NetworkInterface.

DELETE FROM azure.network.interface_tap_configurations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkInterfaceName = '{{ networkInterfaceName }}' --required
AND tapConfigurationName = '{{ tapConfigurationName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;