network_interface_tap_configurations

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

Overview

Name	network_interface_tap_configurations
Type	Resource
Id	azure.network.network_interface_tap_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the network interface tap configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.
virtualNetworkTap	object	Virtual Network Tap resource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the network interface tap configuration resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
type	string	Resource type.
virtualNetworkTap	object	Virtual Network Tap resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_interface_name, tap_configuration_name, subscription_id		Get the specified tap configuration on a network interface.
list	select	resource_group_name, network_interface_name, subscription_id		Get all Tap configurations in a network interface.
create_or_update	insert	resource_group_name, network_interface_name, tap_configuration_name, subscription_id		Creates or updates a Tap configuration in the specified NetworkInterface.
create_or_update	replace	resource_group_name, network_interface_name, tap_configuration_name, subscription_id		Creates or updates a Tap configuration in the specified NetworkInterface.
delete	delete	resource_group_name, network_interface_name, tap_configuration_name, subscription_id		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
network_interface_name	string	The name of the network interface. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
tap_configuration_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.

SELECT examples

get

Get the specified tap configuration on a network interface.

SELECT
id,
name,
etag,
provisioningState,
type,
virtualNetworkTap
FROM azure.network.network_interface_tap_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND tap_configuration_name = '{{ tap_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get all Tap configurations in a network interface.

SELECT
id,
name,
etag,
provisioningState,
type,
virtualNetworkTap
FROM azure.network.network_interface_tap_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_interface_name = '{{ network_interface_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Tap configuration in the specified NetworkInterface.

INSERT INTO azure.network.network_interface_tap_configurations (
id,
name,
properties,
resource_group_name,
network_interface_name,
tap_configuration_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ network_interface_name }}',
'{{ tap_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_interface_tap_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_interface_tap_configurations resource.
  - name: network_interface_name
    value: "{{ network_interface_name }}"
    description: Required parameter for the network_interface_tap_configurations resource.
  - name: tap_configuration_name
    value: "{{ tap_configuration_name }}"
    description: Required parameter for the network_interface_tap_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_interface_tap_configurations resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the Virtual Network Tap configuration.
    value:
      virtualNetworkTap:
        id: "{{ id }}"
        name: "{{ name }}"
        type: "{{ type }}"
        location: "{{ location }}"
        tags: "{{ tags }}"
        properties:
          networkInterfaceTapConfigurations:
            - id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                virtualNetworkTap: "{{ virtualNetworkTap }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
          resourceGuid: "{{ resourceGuid }}"
          provisioningState: "{{ provisioningState }}"
          destinationNetworkInterfaceIPConfiguration:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            properties:
              gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
              virtualNetworkTaps: "{{ virtualNetworkTaps }}"
              applicationGatewayBackendAddressPools: "{{ applicationGatewayBackendAddressPools }}"
              loadBalancerBackendAddressPools: "{{ loadBalancerBackendAddressPools }}"
              loadBalancerInboundNatRules: "{{ loadBalancerInboundNatRules }}"
              privateIPAddress: "{{ privateIPAddress }}"
              privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
              privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
              privateIPAddressVersion: "{{ privateIPAddressVersion }}"
              subnet: "{{ subnet }}"
              primary: {{ primary }}
              publicIPAddress: "{{ publicIPAddress }}"
              applicationSecurityGroups: "{{ applicationSecurityGroups }}"
              provisioningState: "{{ provisioningState }}"
              privateLinkConnectionProperties: "{{ privateLinkConnectionProperties }}"
            etag: "{{ etag }}"
          destinationLoadBalancerFrontEndIPConfiguration:
            id: "{{ id }}"
            name: "{{ name }}"
            type: "{{ type }}"
            properties:
              inboundNatRules: "{{ inboundNatRules }}"
              inboundNatPools: "{{ inboundNatPools }}"
              outboundRules: "{{ outboundRules }}"
              loadBalancingRules: "{{ loadBalancingRules }}"
              privateIPAddress: "{{ privateIPAddress }}"
              privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
              privateIPAddressVersion: "{{ privateIPAddressVersion }}"
              subnet: "{{ subnet }}"
              publicIPAddress: "{{ publicIPAddress }}"
              publicIPPrefix: "{{ publicIPPrefix }}"
              gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
              provisioningState: "{{ provisioningState }}"
              ddosSettings: "{{ ddosSettings }}"
            etag: "{{ etag }}"
            zones:
              - "{{ zones }}"
          destinationPort: {{ destinationPort }}
        etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a Tap configuration in the specified NetworkInterface.

REPLACE azure.network.network_interface_tap_configurations
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND tap_configuration_name = '{{ tap_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified tap configuration from the NetworkInterface.

DELETE FROM azure.network.network_interface_tap_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_interface_name = '{{ network_interface_name }}' --required
AND tap_configuration_name = '{{ tap_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;