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

Request successful. The operation returns the resulting VirtualNetworkTap resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Virtual Network Tap Properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Request successful. The operation returns a list of Virtual Network Tap resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Virtual Network Tap Properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_all

Request successful. The operation returns a list of Virtual Network Tap resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Virtual Network Tap Properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, tapName, subscriptionId		Gets information about the specified virtual network tap.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the VirtualNetworkTaps in a subscription.
list_all	select	subscriptionId		Gets all the VirtualNetworkTaps in a subscription.
create_or_update	insert	resourceGroupName, tapName, subscriptionId		Creates or updates a Virtual Network Tap.
delete	delete	resourceGroupName, tapName, subscriptionId		Deletes the specified virtual network tap.
update_tags	exec	resourceGroupName, tapName, subscriptionId		Updates an VirtualNetworkTap tags.

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

SELECT examples

get

Gets information about the specified virtual network tap.

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

list_by_resource_group

Gets all the VirtualNetworkTaps in a subscription.

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

list_all

Gets all the VirtualNetworkTaps in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.virtual_network_taps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Virtual Network Tap.

INSERT INTO azure.network.virtual_network_taps (
data__properties,
resourceGroupName,
tapName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ tapName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_network_taps
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the virtual_network_taps resource.
    - name: tapName
      value: string
      description: Required parameter for the virtual_network_taps resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the virtual_network_taps resource.
    - name: properties
      value: object
      description: |
        Virtual Network Tap Properties.

DELETE examples

delete

Deletes the specified virtual network tap.

DELETE FROM azure.network.virtual_network_taps
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND tapName = '{{ tapName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates an VirtualNetworkTap tags.

EXEC azure.network.virtual_network_taps.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@tapName='{{ tapName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;